org.corpus_tools.salt.util.internal

Class Diff

java.lang.Object

org.corpus_tools.salt.util.internal.Diff

public class Diff
extends Object

This class compares two SDocumentGraph objects for isomorphie. It uses characteristics of document graphs to use a more specific algorithm for checking whether a graph is isomorphic. At first tokens are compared. Both graphs are compared starting with offset "0". Two tokens are the same, when their textual offset and the overlapped text is the same. As with all following SNodes, SAnnotations and SFeatures are checked. The next step is to look for SNodes that are the source of a incoming relations of a SToken. Of these only those are picked, that have SNodes on their outgoing relations, that already have been checked (at this point: only STokens). These SNodes are then compared with each other. Whenever a relation is used in the way described above, the SRelation is checked for SFeatures and SRelations. To adapt the isomorphie check and the computation of differences you can pass an option map via Diff(SDocumentGraph, SDocumentGraph, Map). Possible options are:

• #OPTION_CHECK_ANNOTATION - When true, even all annotations of nodes and relations are used for isomorphie check and difference computation.
• #OPTION_CHECK_ANNOTATION_DIFF - ???
• #OPTION_CHECK_ID - When true identifiers needs to be the same in isomorphie check and difference computation.

Author:

florian, André Röhrig

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Diff.Builder<S> A fluent builder for comparing two SDocumentGraph or SCorpusGraph objects.

Constructor Summary

Constructors

Constructor and Description
Diff(SaltProject template, SaltProject other, DiffOptions optionMap)
Diff(SCorpusGraph template, SCorpusGraph other) Initializes Diff object with the two graphs template and other.
Diff(SCorpusGraph template, SCorpusGraph other, DiffOptions optionMap)
Diff(SCorpusGraph template, SCorpusGraph other, Map<String,Boolean> optionMap) Deprecated. use Diff(SCorpusGraph, SCorpusGraph, DiffOptions) instead
Diff(SDocumentGraph template, SDocumentGraph other) Initializes Diff object with the two graphs template and other.
Diff(SDocumentGraph template, SDocumentGraph other, DiffOptions optionMap)
Diff(SDocumentGraph template, SDocumentGraph other, Map<String,Boolean> optionMap) Deprecated. use {@link #Diff(SDocumentGraph, SDocumentGraph, DiffOptions) instead

Method Summary

Methods

Modifier and Type	Method and Description
Set<Difference>	findDiffs() Compares the set graphs and returns if they are isomorphic or not.
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

Constructor Detail

Diff

public Diff(SDocumentGraph template,
    SDocumentGraph other)

Initializes Diff object with the two graphs template and other.

Parameters:

template -

other -

Diff

public Diff(SDocumentGraph template,
    SDocumentGraph other,
    DiffOptions optionMap)

Diff

@Deprecated
public Diff(SDocumentGraph template,
               SDocumentGraph other,
               Map<String,Boolean> optionMap)

Deprecated. use {@link #Diff(SDocumentGraph, SDocumentGraph, DiffOptions) instead

Parameters:

template -

other -

optionMap -

Diff

public Diff(SCorpusGraph template,
    SCorpusGraph other)

Initializes Diff object with the two graphs template and other.

Parameters:

template -

other -

Diff

public Diff(SCorpusGraph template,
    SCorpusGraph other,
    DiffOptions optionMap)

Diff

public Diff(SaltProject template,
    SaltProject other,
    DiffOptions optionMap)

Diff

@Deprecated
public Diff(SCorpusGraph template,
               SCorpusGraph other,
               Map<String,Boolean> optionMap)

Deprecated. use Diff(SCorpusGraph, SCorpusGraph, DiffOptions) instead

Parameters:

template -

other -

optionMap -

Method Detail

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.