org.corpus_tools.salt.util.internal

Class AbstractDiff<S>

java.lang.Object

org.corpus_tools.salt.util.internal.AbstractDiff<S>

Direct Known Subclasses:

CorpusStructureDiff, DocumentStructureDiff, SaltProjectDiff

public abstract class AbstractDiff<S>
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
protected Set<Difference>	differences
protected boolean	diffsRequested if false, only isomorphie is computed, which makes the process faster but does not collect all differences
protected DiffOptions	options
protected S	otherObject
protected S	templateObject

Constructor Summary

Constructors

Constructor and Description
AbstractDiff(S template, S other) Initializes Diff object with the two graphs template and other.
AbstractDiff(S template, S other, DiffOptions optionMap)

Method Summary

Modifier and Type	Method and Description
protected void	addDifference(Object templateObject, Object otherObject, Object container, DIFF_TYPES diffType, Set<Difference> subDiffs) Adds a difference to the differences set
protected boolean	compareAnnotationContainers(SAnnotationContainer template, SAnnotationContainer other, Set<Difference> subDiffs) Checks whether two SAnnotationContainer objects are isomorph and returns true if this is the case, false otherwise.
protected boolean	compareIdentifiableElements(IdentifiableElement template, IdentifiableElement other, Set<Difference> subDiffs) Checks whether two IdentifiableElement objects are isomorph.
Set<Difference>	findDiffs() Compares the set graphs and returns if they are isomorphic or not.
protected abstract boolean	findDiffs(boolean diffsRequested)
protected Set<Difference>	getDifferences() Returns a list containing all computed differences.
protected com.google.common.collect.BiMap<SNode,SNode>	getIsoNodes() Return BiMap with isomorphic SNodes key= template, value= other
boolean	isIsomorph() Compares the set graphs and returns if they are isomorphic or not.

Methods inherited from class java.lang.Object

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

Field Detail

templateObject

protected final S templateObject

otherObject

protected final S otherObject

options

protected final DiffOptions options

differences

protected Set<Difference> differences

diffsRequested

protected boolean diffsRequested

if false, only isomorphie is computed, which makes the process faster but does not collect all differences

Constructor Detail

AbstractDiff

public AbstractDiff(S template,
                    S other)

Initializes Diff object with the two graphs template and other.

Parameters:

template -

other -

AbstractDiff

public AbstractDiff(S template,
                    S other,
                    DiffOptions optionMap)

Method Detail

getIsoNodes

protected com.google.common.collect.BiMap<SNode,SNode> getIsoNodes()

Return BiMap with isomorphic SNodes key= template, value= other

Returns:

BiMap with isomorphic SNodes

getDifferences

protected Set<Difference> getDifferences()

Returns a list containing all computed differences.

Returns:

returns differences Set

addDifference

protected void addDifference(Object templateObject,
                             Object otherObject,
                             Object container,
                             DIFF_TYPES diffType,
                             Set<Difference> subDiffs)

Adds a difference to the differences set

Parameters:

templateObject - first Salt object

otherObject - second Salt object

container - Object containing the given object, e.g. used for layers

diffType - type of the difference

isIsomorph

public boolean isIsomorph()

Compares the set graphs and returns if they are isomorphic or not. In case of the graphs are not isomorphic, this method does not record all differences. TO speed up the computation. it just detects the first difference and returns false. To get a full list of all differences, use method findDiffs().

Returns:

true, if graphs are isomorphic, false otherwise.

findDiffs

public Set<Difference> findDiffs()

Compares the set graphs and returns if they are isomorphic or not. If graphs are not isomporphic, this method finds and records all differences and lists them. This means the entire graphs have to be compared and could slow down the computation. If you are only interested in the result and not in the particular differences, use method isIsomorph().

Returns:

true, if graphs are isomorphic, false otherwise.

compareIdentifiableElements

protected boolean compareIdentifiableElements(IdentifiableElement template,
                                              IdentifiableElement other,
                                              Set<Difference> subDiffs)

Checks whether two IdentifiableElement objects are isomorph. If option #OPTION_IGNORE_ID is false, this method returns true, if the id values of both are equal, false otherwise.If subdiffs is not null, the differences will be added to that list, if that list is empty the method returns false when the first difference was found.

Parameters:

templateNode -

otherNode -

subDiffs -

Returns:

true if elements have the same id, false otherwise

compareAnnotationContainers

protected boolean compareAnnotationContainers(SAnnotationContainer template,
                                              SAnnotationContainer other,
                                              Set<Difference> subDiffs)

Checks whether two SAnnotationContainer objects are isomorph and returns true if this is the case, false otherwise. If subdiffs is not null, the differences will be added to that list, if that list is empty the method returns false when the first difference was found.
The behavior of this method depends on options: #OPTION_IGNORE_META_ANNOTATIONS, #OPTION_IGNORE_PROCESSING_ANNOTATIONS, #OPTION_IGNORE_ANNOTATIONS and #OPTION_IGNORE_FEATURES

Parameters:

templateNode -

otherNode -

subDiffs - if differences shall be computed, this list must not have to be empty

Returns:

findDiffs

protected abstract boolean findDiffs(boolean diffsRequested)