org.treetank.service.xml.diff.out

Class EditScript

java.lang.Object

org.treetank.service.xml.diff.out.EditScript

All Implemented Interfaces:

Iterable<Diff>, Iterator<Diff>

public final class EditScript
extends Object
implements Iterator<Diff>, Iterable<Diff>

Builds an edit script.

Author:

Johannes Lichtenberger, University of Konstanz

Constructor Summary

Constructors

Constructor and Description
EditScript() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
Diff	add(Diff paramChange) Adds a change to the edit script.
void	clear() Clears the edit script.
boolean	containsNode(INode paramItem) Checks if an item has been added(changed).
Diff	get(INode paramItem) Look up a change for the given item.
boolean	hasNext()
boolean	isEmpty() Checks if the edit script is empty.
Iterator<Diff>	iterator()
Diff	next()
void	remove()
int	size() Calculates the size of the edit script.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EditScript

public EditScript()

Constructor.

Method Detail

size

public int size()

Calculates the size of the edit script. This can be used to estimate the amicability of an algorithm.

Returns:

number of changes

isEmpty

public boolean isEmpty()

Checks if the edit script is empty.

Returns:

true if empty

containsNode

public boolean containsNode(INode paramItem)

Checks if an item has been added(changed).

Parameters:

paramItem - IData implementation

Returns:

true if the changes List already contains the node, false otherwise

clear

public void clear()

Clears the edit script.

get

public Diff get(INode paramItem)

Look up a change for the given item.

Parameters:

paramItem - (not) changed node

Returns:

the change assigned to the node or null

add

public Diff add(Diff paramChange)

Adds a change to the edit script.

Parameters:

paramChange - Diff reference

Returns:

the change

iterator

public Iterator<Diff> iterator()

Specified by:

iterator in interface Iterable<Diff>

hasNext

public boolean hasNext()

Specified by:

hasNext in interface Iterator<Diff>

next

public Diff next()

Specified by:

next in interface Iterator<Diff>

remove

public void remove()

Specified by:

remove in interface Iterator<Diff>