org.corpus_tools.salt.common

Interface SDocumentGraph

All Superinterfaces:

Graph<SNode,SRelation<SNode,SNode>,SLayer>, IdentifiableElement, LabelableElement, SAnnotationContainer, SGraph, SNamedElement, SPathElement

All Known Implementing Classes:

SDocumentGraphImpl

public interface SDocumentGraph
extends SGraph

The document-structure covers the "real" linguistic data, which means primary data, linguistic structures and annotations on them. The linguistic structure contains the nodes: SSequentialDS, STextualDS, SMedialDS, SToken, SSpan and SStructure and the relations: STextualRelation, SMedialRelation, SSpanningRelation, SDominanceRelation, SPointingRelation and SOrderRelation which we will discuss in the following. All these nodes and relations are contained in a graph, the SDocumentGraph, which is the model element representing the document-structure.

Author:

florian

Nested Class Summary

Nested classes/interfaces inherited from interface org.corpus_tools.salt.core.SGraph

SGraph.GRAPH_TRAVERSE_TYPE

Method Summary

Methods

Modifier and Type	Method and Description
SRelation	addNode(SNode source, SNode target, SALT_TYPE relationType) Creates and returns a 'SRelation' of the type given by sRelationType between source and target.
SRelation	createRelation(SNode source, SNode target, SALT_TYPE relationType, String annotations) Creates a SRelation object, and sets its sSource and sTarget to the passed ones.
SSpan	createSpan(List<SToken> sourceTokens) Creates a SSpan object, adds it to the graph and returns the new object.
SSpan	createSpan(SToken... sourceToken) Creates a new SSpan object, adds it to the graph and returns the new object.
SStructure	createStructure(List<SStructuredNode> structures) Creates a new SStructure object, adds it to the graph and returns the new object.
SStructure	createStructure(SStructuredNode... structure) Creates a new SStructure object, adds it to the graph and returns the new object.
STextualDS	createTextualDS(String text) Creates and adds a new STextualDS node object and sets its text to the passed one and adds it to the graph.
STimeline	createTimeline() Creates an STimeline object being contained in this SDocumentGraph object.
SToken	createToken(DataSourceSequence sequence) Creates a new SToken object and adds it to the graph.
SToken	createToken(List<DataSourceSequence> sequences) Creates a new SToken object and adds it to the graph.
SToken	createToken(SSequentialDS sequentialDS, Integer start, Integer end) Creates a new SToken object and adds it to the graph.
Tokenizer	createTokenizer() Creates a new Tokenizer object to tokenize the set STextualDS objects being contained in this SDocumentGraph object.
Set<Difference>	findDiffs(SDocumentGraph other) Compares the passed graph with the current one and returns if they are isomorph or not.
Set<Difference>	findDiffs(SDocumentGraph other, DiffOptions options) Compares the passed graph with the current one and returns if they are isomorph or not.
List<SNode>	getChildren(SNode parent, SALT_TYPE relationType) Returns a list of nodes in base document.
SDocument	getDocument() Returns the SDocument object containing this graph object.
List<SDominanceRelation>	getDominanceRelations()
List<SMedialDS>	getMedialDSs()
List<SMedialRelation>	getMedialRelations()
List<SNode>	getNodes(Class<?> clazz) Returns all nodes of the passed class.
List<SNode>	getNodes(SALT_TYPE type) Returns all nodes of the passed type.
List<SNode>	getNodesBySequence(DataSourceSequence sequence) Returns all SNode objects which refer to the passed DataSourceSequence object.
List<SOrderRelation>	getOrderRelations()
List<DataSourceSequence>	getOverlappedDataSourceSequence(List<SNode> nodes, SALT_TYPE... relationTypes) Returns the sequences as DataSourceSequence which are overlapped by the given SNode node.
List<DataSourceSequence>	getOverlappedDataSourceSequence(SNode node, SALT_TYPE... relationTypes) Returns the sequences as DataSourceSequence which are overlapped by the given SNode node.
List<SToken>	getOverlappedTokens(SNode overlappingNode) Returns all tokens in the graph, which are overlapped by the passed node and are reachable via SALT_TYPE.STEXT_OVERLAPPING_RELATION having at least one of the passed types.
List<SToken>	getOverlappedTokens(SNode overlappingNode, SALT_TYPE... overlappingRelationTypes) Returns all tokens in the graph, which are overlapped by the passed node and are reachable via relations having at least one of the passed types.
List<SPointingRelation>	getPointingRelations()
List<SRelation>	getRelations(Class<?> clazz) Returns all relations of the passed class.
List<SRelation>	getRelations(SALT_TYPE type) Returns all relations of the passed type.
List<SNode>	getRootsByRelation(SALT_TYPE... type) Returns all SNode objects which are roots for the given types of SRelation.
com.google.common.collect.Multimap<String,SNode>	getRootsByRelationType(SALT_TYPE type) Returns all nodes, which are roots for the given relation-class respects to the given SType of the traversed relation.
List<SNode>	getSharedParent(List<SNode> children, SALT_TYPE nodeType) Returns a list of nodes that are the parents of every node in the given base list.
List<SToken>	getSortedTokenByText() Returns all SToken objects being contained in the list getTokens() and sorts them by the SSequentialRelation.getStart() value of SToken object.
List<SToken>	getSortedTokenByText(List<SToken> tokens2sort) Returns all SToken objects being contained in the given list and sorts them by the SSequentialRelation.getStart() value of SToken object.
List<SSpanningRelation>	getSpanningRelations()
List<SSpan>	getSpans()
List<SSpan>	getSpansBySequence(DataSourceSequence sequence) Returns all SSpan objects which refer to the passed DataSourceSequence object.
List<SStructure>	getStructures()
List<SStructure>	getStructuresBySequence(DataSourceSequence sequence) Returns all SStructure objects which refer to the passed DataSourceSequence object.
String	getText(SNode sNode) This method returns the exact text overlapped in the STextualDS by the given SNode.
List<STextualDS>	getTextualDSs() Returns all primary texts contained in this document structure.
List<STextualRelation>	getTextualRelations() Returns all relations which connects a token with a primary text contained in this document structure.
STimeline	getTimeline() Returns the timeline of this document graph.
List<STimelineRelation>	getTimelineRelations()
List<SToken>	getTokens() Returns all tokens contained contained in this document structure.
List<SToken>	getTokensBySequence(DataSourceSequence sequence) Returns all SToken objects which refer to the passed DataSourceSequence object.
SToken	insertTokenAt(STextualDS textualDS, Integer posInText, String text, Boolean insertSpace) Inserts a token to the graph starting at position posInText and relates them to the given STextualDS object.
List<SToken>	insertTokensAt(STextualDS textualDS, Integer posInText, List<String> texts, Boolean insertSpace) Inserts n tokens (where n is the size of the given list texts) to the graph starting at position posInText and relates them to the given STextualDS object.
boolean	isContinuousByText(List<SNode> subNodeList) Returns true, if the given list of nodes subNodeList is continuous respecting the overlapped text.
boolean	isContinuousByText(List<SNode> subNodeList, List<SNode> fullNodeList) Returns true, if the given list of nodes subNodeList is continuous respecting the overlapped text.
boolean	isIsomorph(SDocumentGraph other) Compares the passed graph with the current one and returns if they are isomorph or not.
boolean	isIsomorph(SDocumentGraph other, DiffOptions options) Compares the passed graph with the current one and returns if they are isomorph or not.
void	setDocument(SDocument document) Sets the SDocument object as a container for this graph.
void	setTimeline(STimeline value) Sets the value of the ' STimeline' reference.
void	sortTokenByText() Sorts all SToken and STextualRelation objects being contained in the list getTokens() and SDocumentGraph#getSTextualRelations() by the SSequentialRelation.getStart() value of SToken and STextualRelation object.
List<SToken>	tokenize() Tokenizes all STextualDS object being contained in this SDocumentGraph object.

Methods inherited from interface org.corpus_tools.salt.core.SGraph

getLayerByName, getLeafs, getNodesByName, getRelationsByName, getRoots, traverse, traverse

Methods inherited from interface org.corpus_tools.salt.graph.Graph

addLayer, addNode, addRelation, containsLayer, containsNode, containsRelation, getIndexMgr, getInRelations, getLayer, getLayers, getNode, getNodes, getOutRelations, getRelation, getRelations, getRelations, removeLayer, removeNode, removeRelation, removeRelations

Methods inherited from interface org.corpus_tools.salt.graph.IdentifiableElement

getId, getIdentifier, setId, setIdentifier

Methods inherited from interface org.corpus_tools.salt.graph.LabelableElement

addLabel, containsLabel, getLabel, getLabel, getLabels, getLabelsByNamespace, removeAll, removeLabel, removeLabel, sizeLabels

Methods inherited from interface org.corpus_tools.salt.core.SAnnotationContainer

addAnnotation, addFeature, addMetaAnnotation, addProcessingAnnotation, createAnnotation, createAnnotations, createFeature, createFeatures, createMetaAnnotation, createMetaAnnotations, createProcessingAnnotation, createProcessingAnnotations, getAnnotation, getAnnotation, getAnnotations, getFeature, getFeature, getFeatures, getMetaAnnotation, getMetaAnnotations, getProcessingAnnotation, getProcessingAnnotations, iterator_SAnnotation, iterator_SFeature, iterator_SMetaAnnotation, iterator_SProcessingAnnotation

Methods inherited from interface org.corpus_tools.salt.core.SNamedElement

getName, setName

Methods inherited from interface org.corpus_tools.salt.core.SPathElement

getPath

Method Detail

getDocument

SDocument getDocument()

Returns the SDocument object containing this graph object. The SDocument object is linked via a SFeature object having the namespace and the name .

Returns:

the value of the 'SDocument' reference.

setDocument

void setDocument(SDocument document)

Sets the SDocument object as a container for this graph. The given SDocument object is linked via a SFeature object having the namespace and the name .

Parameters:

document - the new value of the 'SDocument Graph' reference.

document - the new value of the 'SDocument' reference.

getTextualDSs

List<STextualDS> getTextualDSs()

Returns all primary texts contained in this document structure.

Returns:

a list of contained primary texts

getTextualRelations

List<STextualRelation> getTextualRelations()

Returns all relations which connects a token with a primary text contained in this document structure.

Returns:

all relations which connects a token with a primary text

getTokens

List<SToken> getTokens()

Returns all tokens contained contained in this document structure.

Returns:

all tokens

getTimeline

STimeline getTimeline()

Returns the timeline of this document graph. A timeline is a specific datasource and acts as an anchor for STimelineRelations. A timeline is necessary to set tokens in correspondance when they belong to different STextualDSs. For instance a timeline is necessary to model dialogue data.

Returns:

timeline

setTimeline

void setTimeline(STimeline value)

Sets the value of the ' STimeline' reference.

Parameters:

value - the new value of the 'STimeline' reference.

See Also:

getTimeline()

getRelations

List<SRelation> getRelations(SALT_TYPE type)

Returns all relations of the passed type.

Parameters:

type - type of relations

Returns:

a list of relations matching passed type

getRelations

List<SRelation> getRelations(Class<?> clazz)

Returns all relations of the passed class.

Parameters:

clazz - class of relations

Returns:

a list of relations matching passed class

getNodes

List<SNode> getNodes(SALT_TYPE type)

Returns all nodes of the passed type.

Parameters:

type - type of nodes

Returns:

a list of nodes matching passed type

getNodes

List<SNode> getNodes(Class<?> clazz)

Returns all nodes of the passed class.

Parameters:

clazz - class of nodes

Returns:

a list of nodes matching passed class

getTimelineRelations

List<STimelineRelation> getTimelineRelations()

getSpanningRelations

List<SSpanningRelation> getSpanningRelations()

getSpans

List<SSpan> getSpans()

getStructures

List<SStructure> getStructures()

getDominanceRelations

List<SDominanceRelation> getDominanceRelations()

getPointingRelations

List<SPointingRelation> getPointingRelations()

getMedialRelations

List<SMedialRelation> getMedialRelations()

getMedialDSs

List<SMedialDS> getMedialDSs()

getOrderRelations

List<SOrderRelation> getOrderRelations()

addNode

SRelation addNode(SNode source,
                SNode target,
                SALT_TYPE relationType)

Creates and returns a 'SRelation' of the type given by sRelationType between source and target. Note that the source is required to be in the SDocumentGraph already and that the elationType may only be one of SALT_TYPE.STEXTUAL_RELATION, SALT_TYPE.SSPANNING_RELATION, SALT_TYPE.SDOMINANCE_RELATION and SALT_TYPE.SPOINTING_RELATION.

Parameters:

source - source node

target - target node

SALT_TYPE - type of the relation to be created between source and target

Returns:

created relation

createTextualDS

STextualDS createTextualDS(String text)

Creates and adds a new STextualDS node object and sets its text to the passed one and adds it to the graph.

Parameters:

text - the text which shall be the primary text and be added to the created STextualDS node

Returns:

the created STextualDS node which has been created

createToken

SToken createToken(List<DataSourceSequence> sequences)

Creates a new SToken object and adds it to the graph. The SToken object will be connected with the SSequentialDS object given in the passed DataSourceSequence object. The created relations get the borders also given in the DataSourceSequence object.

Parameters:

sequences - list of sequences which shall be overlapped by the created token

Returns:

returns the created token

createToken

SToken createToken(DataSourceSequence sequence)

Creates a new SToken object and adds it to the graph. The SToken object will be connected with the SSequentialDS objects given in the passed DataSourceSequence object. The created relations get the borders also given in the DataSourceSequence object.

Parameters:

sequence - the sequence which shall be overlapped by the created token

Returns:

returns the created token

createSpan

SSpan createSpan(SToken... sourceToken)

Creates a new SSpan object, adds it to the graph and returns the new object. Further, this method creates a SSpanningRelation object and sets its source to the created SSpan object and the target to the given source node.

Parameters:

sourceToken - source SToken node to which the SSpanningRelation relation points to

Returns:

the created SSpan node

createSpan

SSpan createSpan(List<SToken> sourceTokens)

Creates a SSpan object, adds it to the graph and returns the new object. Further, this method creates SSpanningRelation relations and sets their source to the created SSpan object and the targets to the given source nodes.

Parameters:

sourceTokens - source SToken node to which the SSpanningRelation relation points to

Returns:

the created SSpan node

createStructure

SStructure createStructure(SStructuredNode... structure)

Creates a new SStructure object, adds it to the graph and returns the new object. Further, this method creates a SDominanceRelation object and sets its source to the created SStructure object and the target to the given source node.

Parameters:

structure - source SStructuredNode node to which the SDominanceRelation relation points to

Returns:

SStructure node

createStructure

SStructure createStructure(List<SStructuredNode> structures)

Creates a new SStructure object, adds it to the graph and returns the new object. Further, this method creates SDominanceRelation relations and sets their sources to the created SStructure object and the targets to the given source nodes.

Parameters:

structures - list of source SStructuredNode nodes to which the SDominanceRelation relation points to

Returns:

SStructure node

createTimeline

STimeline createTimeline()

Creates an STimeline object being contained in this SDocumentGraph object. The new STimeline object is filled with points of time computed out of the STextualRelation objects being contained by this SDocumentGraph object. For each STextualDS object, for each STextualRelation object one point of time would be created. If this object already contains a not empty STimeline object the already existing one would be returned.

Returns:

returns a new created and automatically filled STimeline object if no one exists yet

getTokensBySequence

List<SToken> getTokensBySequence(DataSourceSequence sequence)

Returns all SToken objects which refer to the passed DataSourceSequence object. The passed object determines the borders of the sequence by the values sStart and sEnd and the type of data source by the instance sSequentialDS.

Parameters:

sequence - an object determining the sequence to which the returned SToken objects refer to.

Returns:

a list of SToken objects which refer or overlap the passed sequence

getSpansBySequence

List<SSpan> getSpansBySequence(DataSourceSequence sequence)

Returns all SSpan objects which refer to the passed DataSourceSequence object. The passed object determines the borders of the sequence by the values sStart and sEnd and the type of data source by the instance sSequentialDS.

Parameters:

sequence - an object determining the sequence to which the returned SSpan objects refer to.

Returns:

a list of SSpan objects which refer or overlap the passed sequence

getStructuresBySequence

List<SStructure> getStructuresBySequence(DataSourceSequence sequence)

Returns all SStructure objects which refer to the passed DataSourceSequence object. The passed object determines the borders of the sequence by the values sStart and sEnd and the type of datasource by the instance sSequentialDS.

Parameters:

sequence - an object determining the sequence to which the returned SStructure objects refer to.

Returns:

a list of SStructure objects which refer or overlap the passed sequence

getNodesBySequence

List<SNode> getNodesBySequence(DataSourceSequence sequence)

Returns all SNode objects which refer to the passed DataSourceSequence object. The passed object determines the borders of the sequence by the values sStart and sEnd and the type of data source by the instance sSequentialDS.

Parameters:

sequence - an object determining the sequence to which the returned SNode objects refer to.

Returns:

a list of SNode objects which refer or overlap the passed sequence

getOverlappedDataSourceSequence

List<DataSourceSequence> getOverlappedDataSourceSequence(SNode node,
                                                       SALT_TYPE... relationTypes)

Returns the sequences as DataSourceSequence which are overlapped by the given SNode node. Overlapped means, that starting from the given SNode node the SSequentialDS can reached by traversing relations of one of the types contained in the given list of SALT_TYPE.

Parameters:

node - node to start from

relationTypes - a list of relation types, which are traversed

Returns:

the overlapped DataSourceSequence objects

getOverlappedDataSourceSequence

List<DataSourceSequence> getOverlappedDataSourceSequence(List<SNode> nodes,
                                                       SALT_TYPE... relationTypes)

Returns the sequences as DataSourceSequence which are overlapped by the given SNode node. Overlapped means, that starting from the given SNode node the SSequentialDS can reached by traversing relations of one of the types contained in the given list of SALT_TYPE.

Parameters:

nodes - a list of nodes to start from

relationTypes - a list of relation types, which are traversed

Returns:

the overlapped DataSourceSequence objects

isContinuousByText

boolean isContinuousByText(List<SNode> subNodeList,
                         List<SNode> fullNodeList)

Returns true, if the given list of nodes subNodeList is continuous respecting the overlapped text. A list of nodes is continuous, if there is no other node overlapping a text sequence, which is a subsequence of the sequence overlapped by the given list and is not part of the list.

Parameters:

subNodeList - list to check against fullSNodeList

fullNodeList - list which contains all nodes in correct order

Returns:

true, if list is continuous

isContinuousByText

boolean isContinuousByText(List<SNode> subNodeList)

Returns true, if the given list of nodes subNodeList is continuous respecting the overlapped text. A list of nodes is continuous, if there is no other node overlapping a text sequence, which is a subsequence of the sequence overlapped by the given list and is not part of the list. The fullSNodeList is given by the token list of this graph.

Parameters:

subNodeList - list to check against fullSNodeList

Returns:

true, if list is continuous

getSortedTokenByText

List<SToken> getSortedTokenByText(List<SToken> tokens2sort)

Returns all SToken objects being contained in the given list and sorts them by the SSequentialRelation.getStart() value of SToken object.

Parameters:

tokens2sort - the list of SToken objects to sort

Returns:

list of tokens in order of left text position

getSortedTokenByText

List<SToken> getSortedTokenByText()

Returns all SToken objects being contained in the list getTokens() and sorts them by the SSequentialRelation.getStart() value of SToken object.

Returns:

list of tokens in order of left text position

sortTokenByText

void sortTokenByText()

Sorts all SToken and STextualRelation objects being contained in the list getTokens() and SDocumentGraph#getSTextualRelations() by the SSequentialRelation.getStart() value of SToken and STextualRelation object.

getRootsByRelation

List<SNode> getRootsByRelation(SALT_TYPE... type)

Returns all SNode objects which are roots for the given types of SRelation. Means, that all SNodes will be returned as roots, which have no incoming relations of the given type.

For instance imagine the following structure and assume that the passed SALT_TYPEs are SALT_TYPE.SDOMINANCE_RELATION and SALT_TYPE.SSPANNING_RELATION:

       struct1
     //      ||
   span1     ||   span2
        /    \     ||    |
 tok1   tok2  tok3  tok4
 

the nodes: struct1 and span2 are returned, even if a pointing relation connects struct1 and span2.

Parameters:

saltTypes - a set of types for which nodes have to be computed.

Returns:

a list of SNodes which are roots

getRootsByRelationType

com.google.common.collect.Multimap<String,SNode> getRootsByRelationType(SALT_TYPE type)

Returns all nodes, which are roots for the given relation-class respects to the given SType of the traversed relation. The following example shows the different to the method getRootsBySRelation(): Imagine the following graphFor example:

 node1 ->t1 node2, node2 ->t2-> node3
 

Also imagine, that -> is a relation of same class with sType=t1 respectivly sType=t2 The returned roots will be node1 and node 2, because of node1 is the root of a subgraph for relation.sType=t1 and node2 is the root of the subgraph for relation.sType=t2. Whereas the returned nodes of #getRootsByRelation(SALT_TYPE) is only node1.
All relations having no type are stored in returned map corresponding to key SaltUtil.SALT_NULL_VALUE.

Parameters:

type - type, which shall be used for computing roots

Returns:

a map of types, with corresponding lists of root nodes

createToken

SToken createToken(SSequentialDS sequentialDS,
                 Integer start,
                 Integer end)

Creates a new SToken object and adds it to the graph. The SToken object will be connected with the given SSequentialDS object. The created relation get the passed positions.

Parameters:

sequentialDS - the data source to which the created token should be connected

start - the offset in the data source where the created token starts

end - the offset in the data source where the created token ends

Returns:

the created token

tokenize

List<SToken> tokenize()

Tokenizes all STextualDS object being contained in this SDocumentGraph object. The Tokenization is similar to the tokenization made by the TreeTagger tokenizer. This method calls the method createTokenizer() and initializes with automatic detected values. The language will be detected automatically for each STextualDS object by use of the TextCategorizer (see: http://textcat.sourceforge.net/doc/org/knallgrau/utils/textcat/ TextCategorizer.html). If the language is one of the given ones: English, French, Italian and German, abbreviations also taken from the Treetagger will be used. To customize these settings use the method createTokenizer(). The used Treetagger is a reimplementation in Java with permission from the original TreeTagger tokenizer in Perl by Helmut Schmid (see: http://www.ims.uni-stuttgart.de/projekte/corplex/TreeTagger/). For each token detected in the text given by sTextualDS.getSText() an SToken object is created and linked with the STextualDS object via a new STextualRelation object containing the textual offset.

Returns:

a list of all created tokens

createTokenizer

Tokenizer createTokenizer()

Creates a new Tokenizer object to tokenize the set STextualDS objects being contained in this SDocumentGraph object. To customize the tokenization, set take a look to the properties of the returned Tokenizer object. This method is used by the method tokenize(). The used Treetagger is a reimplementation in Java with permission from the original TreeTagger tokenizer in Perl by Helmut Schmid (see: http://www.ims.uni-stuttgart.de/projekte/corplex/TreeTagger/). For each token detected in the text given by sTextualDS.getSText() an SToken object is created and linked with the STextualDS object via a new STextualRelation object containing the textual offset. If the set STextualDS object is empty or if it does not belong to this SDocumentGraph object an exception is thrown.

Returns:

a tokenizer object

insertTokenAt

SToken insertTokenAt(STextualDS textualDS,
                   Integer posInText,
                   String text,
                   Boolean insertSpace)

Inserts a token to the graph starting at position posInText and relates them to the given STextualDS object.
An example:
Imagine the following sText and tokenization

 tok1  tok2  tok3  tok4
 This  is    a     text.
 

the call insertSTokensAt(sTextualDS, 5, "additional", true);
results in

 tok1  tok5        tok2  tok3  tok4
 This  additional  is    a     text.
 

Parameters:

textualDS - the STextualDS object to which the new tokens should be related to. Make sure, that stextualDS is already contained in the SDocumentGraph

posInText - textual position where to add the new tokens.

text - text value, the new token should cover

insertSpace - if true, a blank after each new text is inserted

Returns:

new created token

insertTokensAt

List<SToken> insertTokensAt(STextualDS textualDS,
                          Integer posInText,
                          List<String> texts,
                          Boolean insertSpace)

Inserts n tokens (where n is the size of the given list texts) to the graph starting at position posInText and relates them to the given STextualDS object.
An example:
Imagine the following sText and tokenization

 tok1  tok2  tok3  tok4
 This  is    a     text.
 

the call insertSTokensAt(sTextualDS, 5, {"additional" "text"}, true);
results in

 tok1  tok5        tok6  tok2  tok3  tok4
 This  additional  text  is    a     text.
 

Parameters:

textualDS - the STextualDS object to which the new tokens should be related to. Make sure, that stextualDS is already contained in the SDocumentGraph

posInText - textual position where to add the new tokens.

texts - text values, the new tokens should cover

insertSpace - if true, a blank after each new text is inserted

createRelation

SRelation createRelation(SNode source,
                       SNode target,
                       SALT_TYPE relationType,
                       String annotations)

Creates a SRelation object, and sets its sSource and sTarget to the passed ones. The created SRelation is of the passed type. If annotations are not empty, even SAnnotation objects will be created. The syntax to pass annotations is:
(SNS::)?SNAME(=SVALUE)?(;SNS::SNAME=SVALUE)+
where SNS is the namespace of the annotation, SNAME is its name and SVALUE is the value of the annotation.

Parameters:

source - source node

target - target node

relationType - type of the relation

annotations - annotations to be added to the created relation (SNS::)?SNAME(=SVALUE)?(;SNS::SNAME=SVALUE)+

Returns:

the created relation

getOverlappedTokens

List<SToken> getOverlappedTokens(SNode overlappingNode,
                               SALT_TYPE... overlappingRelationTypes)

Returns all tokens in the graph, which are overlapped by the passed node and are reachable via relations having at least one of the passed types.

Parameters:

overlappingNode - anchor node, which overlaps the returned tokens

overlappingRelationTypes - relation types

getOverlappedTokens

List<SToken> getOverlappedTokens(SNode overlappingNode)

Returns all tokens in the graph, which are overlapped by the passed node and are reachable via SALT_TYPE.STEXT_OVERLAPPING_RELATION having at least one of the passed types.

Parameters:

overlappingNode - anchor node, which overlaps the returned tokens

getText

String getText(SNode sNode)

This method returns the exact text overlapped in the STextualDS by the given SNode. Imagine the following graph:

       n1
      /  \
  t1 t2  t3 t4      t5
   |  |  |   |      |
 This is a sample text.
 

The method will return the text 'text' for token t5 and 'is a' for node n1.

Parameters:

sNode - the node for which the text should be retrieved.

Returns:

the text which is overlapped by the passed node

isIsomorph

boolean isIsomorph(SDocumentGraph other)

Compares the passed graph with the current one and returns if they are isomorph or not. In case of the graphs are not isomorph, 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().

Parameters:

other - the graph to be compared with this one

Returns:

true, if graphs are isomorph, false otherwise.

isIsomorph

boolean isIsomorph(SDocumentGraph other,
                 DiffOptions options)

Compares the passed graph with the current one and returns if they are isomorph or not. In case of the graphs are not isomorph, 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().

Parameters:

other - the graph to be compared with this one

options - an option map to customize the isomorphie comparison, for more information about how to customize the comparison, please check the javadoc to DiffOptions

Returns:

true, if graphs are isomorph, false otherwise.

findDiffs

Set<Difference> findDiffs(SDocumentGraph other)

Compares the passed graph with the current one and returns if they are isomorph or not. If graphs are not isomporph, this method finds and records all differences and lists them. That 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().

Parameters:

other - the graph to be compared with this one

Returns:

true, if graphs are isomorph, false otherwise.

findDiffs

Set<Difference> findDiffs(SDocumentGraph other,
                        DiffOptions options)

Compares the passed graph with the current one and returns if they are isomorph or not. If graphs are not isomporph, this method finds and records all differences and lists them. That 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().

Parameters:

other - the graph to be compared with this one

options - an option map to customize the isomorphie comparison, for more information about how to customize the comparison, please check the javadoc to DiffOptions

Returns:

true, if graphs are isomorph, false otherwise.

getChildren

List<SNode> getChildren(SNode parent,
                      SALT_TYPE relationType)

Returns a list of nodes in base document. The returned nodes are equivalents to the direct children of the passed parent node. The children are retrieved via traversing of relations of the passed SALT_TYPE.

Parameters:

parent - node to who the children are retrieved

relationType - type of relations to be traversed

Returns:

a list of children nodes

getSharedParent

List<SNode> getSharedParent(List<SNode> children,
                          SALT_TYPE nodeType)

Returns a list of nodes that are the parents of every node in the given base list. Only nodes with the given SALT_TYPE will be considered.

Parameters:

children - list of nodes whose parents are looked for

nodeType - regarded types of relations

Returns:

a list of parents