org.corpus_tools.salt.common.impl

Class SDocumentGraphImpl

java.lang.Object

org.corpus_tools.salt.graph.impl.LabelableElementImpl

org.corpus_tools.salt.graph.impl.IdentifiableElementImpl

org.corpus_tools.salt.graph.impl.GraphImpl<SNode,SRelation<SNode,SNode>,SLayer>

org.corpus_tools.salt.core.impl.SGraphImpl

org.corpus_tools.salt.common.impl.SDocumentGraphImpl

All Implemented Interfaces:

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

public class SDocumentGraphImpl
extends SGraphImpl
implements SDocumentGraph

See Also:

Serialized Form

Nested Class Summary

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

SGraph.GRAPH_TRAVERSE_TYPE

Field Summary

Fields inherited from class org.corpus_tools.salt.core.impl.SGraphImpl

name

Fields inherited from class org.corpus_tools.salt.graph.impl.GraphImpl

approximatedNodeDegree, expectedNodes, expectedRelations, indexMgr

Fields inherited from class org.corpus_tools.salt.graph.impl.LabelableElementImpl

EXPECTED_NUMBER_OF_LABELS

Constructor Summary

Constructors

Constructor and Description
SDocumentGraphImpl()

Method Summary

Methods

Modifier and Type	Method and Description
SRelation	addNode(SNode source, SNode target, SALT_TYPE sRelationType) Creates and returns a 'SRelation' of the type given by sRelationType between source and target.
void	basic_setDocument(SDocument document) This is an internally used method.
protected void	basicAddNode(SNode node) Calls the super method an puts the given node into a node type index. an exception will be thrown.
protected void	basicAddRelation(Relation<? extends Node,? extends Node> relation) Calls the super method an puts the given relation into a relation type index. an exception will be thrown.
SRelation	createRelation(SNode sSource, SNode sTarget, SALT_TYPE sRelationType, String sAnnotations) Creates a SRelation object, and sets its sSource and sTarget to the passed ones.
SSpan	createSpan(List<SToken> tokens) Creates a SSpan object, adds it to the graph and returns the new object.
SSpan	createSpan(SToken... tokens) Creates a new SSpan object, adds it to the graph and returns the new object.
SStructure	createStructure(List<SStructuredNode> sourceNodes) Creates a new SStructure object, adds it to the graph and returns the new object.
SStructure	createStructure(SStructuredNode... structures) 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 sDSSequence) 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... relationTypes) 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 SDocumentGraph.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.
protected void	init() Calls the init of super class and expands its initialization for adding SaltUtil.IDX_NODETYPE of indexes: Initializes index SaltUtil.IDX_NODETYPE Initializes index SaltUtil.IDX_RELATIONTYPE
SToken	insertTokenAt(STextualDS sTextualDS, 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 sTextualDS, 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 SDocumentGraph.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.
String	toString()

Methods inherited from class org.corpus_tools.salt.core.impl.SGraphImpl

addAnnotation, addFeature, addLayer, addMetaAnnotation, addProcessingAnnotation, createAnnotation, createAnnotations, createFeature, createFeatures, createMetaAnnotation, createMetaAnnotations, createProcessingAnnotation, createProcessingAnnotations, getAnnotation, getAnnotation, getAnnotations, getFeature, getFeature, getFeatures, getLayerByName, getLeafs, getMetaAnnotation, getMetaAnnotations, getName, getNodesByName, getPath, getProcessingAnnotation, getProcessingAnnotations, getRelationsByName, getRoots, iterator_SAnnotation, iterator_SFeature, iterator_SMetaAnnotation, iterator_SProcessingAnnotation, removeLabel, setName, traverse, traverse

Methods inherited from class org.corpus_tools.salt.graph.impl.GraphImpl

addNode, addRelation, basicAddLayer, basicRemoveLayer, basicRemoveNode, basicRemoveRelation, containsLayer, containsNode, containsRelation, getIndexMgr, getInRelations, getLayer, getLayers, getNode, getNodes, getOutRelations, getRelation, getRelations, getRelations, removeLayer, removeNode, removeRelation, removeRelations, update

Methods inherited from class org.corpus_tools.salt.graph.impl.IdentifiableElementImpl

getId, getIdentifier, setId, setIdentifier

Methods inherited from class org.corpus_tools.salt.graph.impl.LabelableElementImpl

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

Methods inherited from class java.lang.Object

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

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

Constructor Detail

SDocumentGraphImpl

public SDocumentGraphImpl()

Method Detail

init

protected void init()

Calls the init of super class and expands its initialization for adding SaltUtil.IDX_NODETYPE of indexes:

• Initializes index SaltUtil.IDX_NODETYPE
• Initializes index SaltUtil.IDX_RELATIONTYPE

Overrides:

init in class GraphImpl<SNode,SRelation<SNode,SNode>,SLayer>

basicAddRelation

protected void basicAddRelation(Relation<? extends Node,? extends Node> relation)

Calls the super method an puts the given relation into a relation type index. an exception will be thrown.

Overrides:

basicAddRelation in class GraphImpl<SNode,SRelation<SNode,SNode>,SLayer>

Parameters:

relation - to add

basicAddNode

protected void basicAddNode(SNode node)

Calls the super method an puts the given node into a node type index. an exception will be thrown.

Overrides:

basicAddNode in class GraphImpl<SNode,SRelation<SNode,SNode>,SLayer>

Parameters:

node - to add

getDocument

public 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 .

Specified by:

getDocument in interface SDocumentGraph

Returns:

the value of the 'SDocument' reference.

setDocument

public 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 .

Specified by:

setDocument in interface SDocumentGraph

Parameters:

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

basic_setDocument

public void basic_setDocument(SDocument document)

This is an internally used method. To implement a double chaining of SDocument and SDocumentGraph object when a document is set to avoid an endless invocation. The invocation of methods is implement as follows:

 setDocument(SDocument)                      SDocument#setDocumentGraph(Graph)
         ||             \ /                   ||
         ||              X                    ||
         \/             / \                   \/
 #basicDocument(SDocument)            SDocument#basicSetDocumentGraph(Graph)
 

Parameters:

document - the container document of this document graph

getTextualDSs

public List<STextualDS> getTextualDSs()

Returns all primary texts contained in this document structure.

Specified by:

getTextualDSs in interface SDocumentGraph

Returns:

a list of contained primary texts

getRelations

public List<SRelation> getRelations(SALT_TYPE type)

Returns all relations of the passed type.

Specified by:

getRelations in interface SDocumentGraph

Parameters:

type - type of relations

Returns:

a list of relations matching passed type

getRelations

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

Returns all relations of the passed class.

Specified by:

getRelations in interface SDocumentGraph

Parameters:

clazz - class of relations

Returns:

a list of relations matching passed class

getNodes

public List<SNode> getNodes(SALT_TYPE type)

Returns all nodes of the passed type.

Specified by:

getNodes in interface SDocumentGraph

Parameters:

type - type of nodes

Returns:

a list of nodes matching passed type

getNodes

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

Returns all nodes of the passed class.

Specified by:

getNodes in interface SDocumentGraph

Parameters:

clazz - class of nodes

Returns:

a list of nodes matching passed class

getTextualRelations

public List<STextualRelation> getTextualRelations()

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

Specified by:

getTextualRelations in interface SDocumentGraph

Returns:

all relations which connects a token with a primary text

getTokens

public List<SToken> getTokens()

Returns all tokens contained contained in this document structure.

Specified by:

getTokens in interface SDocumentGraph

Returns:

all tokens

getTimeline

public 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.

Specified by:

getTimeline in interface SDocumentGraph

Returns:

timeline

setTimeline

public void setTimeline(STimeline value)

Sets the value of the ' STimeline' reference.

Specified by:

setTimeline in interface SDocumentGraph

Parameters:

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

See Also:

SDocumentGraph.getTimeline()

getTimelineRelations

public List<STimelineRelation> getTimelineRelations()

Specified by:

getTimelineRelations in interface SDocumentGraph

getSpanningRelations

public List<SSpanningRelation> getSpanningRelations()

Specified by:

getSpanningRelations in interface SDocumentGraph

getSpans

public List<SSpan> getSpans()

Specified by:

getSpans in interface SDocumentGraph

getStructures

public List<SStructure> getStructures()

Specified by:

getStructures in interface SDocumentGraph

getDominanceRelations

public List<SDominanceRelation> getDominanceRelations()

Specified by:

getDominanceRelations in interface SDocumentGraph

getPointingRelations

public List<SPointingRelation> getPointingRelations()

Specified by:

getPointingRelations in interface SDocumentGraph

getMedialRelations

public List<SMedialRelation> getMedialRelations()

Specified by:

getMedialRelations in interface SDocumentGraph

getMedialDSs

public List<SMedialDS> getMedialDSs()

Specified by:

getMedialDSs in interface SDocumentGraph

getOrderRelations

public List<SOrderRelation> getOrderRelations()

Specified by:

getOrderRelations in interface SDocumentGraph

addNode

public SRelation addNode(SNode source,
                SNode target,
                SALT_TYPE sRelationType)

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.

Specified by:

addNode in interface SDocumentGraph

Parameters:

source - source node

target - target node

Returns:

created relation

createTextualDS

public 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.

Specified by:

createTextualDS in interface SDocumentGraph

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

public 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.

Specified by:

createToken in interface SDocumentGraph

Parameters:

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

Returns:

returns the created token

createToken

public 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.

Specified by:

createToken in interface SDocumentGraph

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

createToken

public SToken createToken(DataSourceSequence sDSSequence)

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.

Specified by:

createToken in interface SDocumentGraph

Parameters:

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

Returns:

returns the created token

createSpan

public SSpan createSpan(List<SToken> tokens)

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.

Specified by:

createSpan in interface SDocumentGraph

Parameters:

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

Returns:

the created SSpan node

createSpan

public SSpan createSpan(SToken... tokens)

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.

Specified by:

createSpan in interface SDocumentGraph

Parameters:

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

Returns:

the created SSpan node

createStructure

public SStructure createStructure(List<SStructuredNode> sourceNodes)

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.

Specified by:

createStructure in interface SDocumentGraph

Parameters:

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

Returns:

SStructure node

createStructure

public SStructure createStructure(SStructuredNode... structures)

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.

Specified by:

createStructure in interface SDocumentGraph

Parameters:

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

Returns:

SStructure node

createTimeline

public 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.

Specified by:

createTimeline in interface SDocumentGraph

Returns:

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

getTokensBySequence

public 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.

Specified by:

getTokensBySequence in interface SDocumentGraph

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

public 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.

Specified by:

getSpansBySequence in interface SDocumentGraph

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

public 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.

Specified by:

getStructuresBySequence in interface SDocumentGraph

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

public 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.

Specified by:

getNodesBySequence in interface SDocumentGraph

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

public 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.

Specified by:

getOverlappedDataSourceSequence in interface SDocumentGraph

Parameters:

node - node to start from

relationTypes - a list of relation types, which are traversed

Returns:

the overlapped DataSourceSequence objects

getOverlappedDataSourceSequence

public 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.

Specified by:

getOverlappedDataSourceSequence in interface SDocumentGraph

Parameters:

nodes - a list of nodes to start from

relationTypes - a list of relation types, which are traversed

Returns:

the overlapped DataSourceSequence objects

isContinuousByText

public 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.

Specified by:

isContinuousByText in interface SDocumentGraph

Parameters:

subNodeList - list to check against fullSNodeList

fullNodeList - list which contains all nodes in correct order

Returns:

true, if list is continuous

isContinuousByText

public 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.

Specified by:

isContinuousByText in interface SDocumentGraph

Parameters:

subNodeList - list to check against fullSNodeList

Returns:

true, if list is continuous

getSortedTokenByText

public 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.

Specified by:

getSortedTokenByText in interface SDocumentGraph

Parameters:

tokens2sort - the list of SToken objects to sort

Returns:

list of tokens in order of left text position

getSortedTokenByText

public List<SToken> getSortedTokenByText()

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

Specified by:

getSortedTokenByText in interface SDocumentGraph

Returns:

list of tokens in order of left text position

sortTokenByText

public void sortTokenByText()

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

Specified by:

sortTokenByText in interface SDocumentGraph

getRootsByRelation

public 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.

Specified by:

getRootsByRelation in interface SDocumentGraph

Returns:

a list of SNodes which are roots

getRootsByRelationType

public 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.

Specified by:

getRootsByRelationType in interface SDocumentGraph

Parameters:

type - type, which shall be used for computing roots

Returns:

a map of types, with corresponding lists of root nodes

tokenize

public 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 SDocumentGraph.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 SDocumentGraph.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.

Specified by:

tokenize in interface SDocumentGraph

Returns:

a list of all created tokens

createTokenizer

public 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 SDocumentGraph.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.

Specified by:

createTokenizer in interface SDocumentGraph

Returns:

a tokenizer object

insertTokenAt

public SToken insertTokenAt(STextualDS sTextualDS,
                   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.
 

Specified by:

insertTokenAt in interface SDocumentGraph

Parameters:

sTextualDS - 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

public List<SToken> insertTokensAt(STextualDS sTextualDS,
                          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.
 

Specified by:

insertTokensAt in interface SDocumentGraph

Parameters:

sTextualDS - 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

public SRelation createRelation(SNode sSource,
                       SNode sTarget,
                       SALT_TYPE sRelationType,
                       String sAnnotations)

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.

Specified by:

createRelation in interface SDocumentGraph

Parameters:

sSource - source node

sTarget - target node

sRelationType - type of the relation

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

Returns:

the created relation

getOverlappedTokens

public 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.

Specified by:

getOverlappedTokens in interface SDocumentGraph

Parameters:

overlappingNode - anchor node, which overlaps the returned tokens

getOverlappedTokens

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

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.

Specified by:

getOverlappedTokens in interface SDocumentGraph

Parameters:

overlappingNode - anchor node, which overlaps the returned tokens

relationTypes - relation types

getText

public 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.

Specified by:

getText in interface SDocumentGraph

Parameters:

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

Returns:

the text which is overlapped by the passed node

isIsomorph

public 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().

Specified by:

isIsomorph in interface SDocumentGraph

Parameters:

other - the graph to be compared with this one

Returns:

true, if graphs are isomorph, false otherwise.

isIsomorph

public 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().

Specified by:

isIsomorph in interface SDocumentGraph

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

public 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().

Specified by:

findDiffs in interface SDocumentGraph

Parameters:

other - the graph to be compared with this one

Returns:

true, if graphs are isomorph, false otherwise.

findDiffs

public 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().

Specified by:

findDiffs in interface SDocumentGraph

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

public 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.

Specified by:

getChildren in interface SDocumentGraph

Parameters:

parent - node to who the children are retrieved

relationType - type of relations to be traversed

Returns:

a list of children nodes

getSharedParent

public 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.

 for all incoming relations of first child node
                add targets to sharedparents
 for each child in children
                for each incomming relation of child
                        add source node of incomming relation to parent
                sharedparents= sharedparents ⋂ parents
 

Specified by:

getSharedParent in interface SDocumentGraph

Parameters:

children - list of nodes whose parents are looked for

nodeType - regarded types of relations

Returns:

a list of parents

toString

public String toString()

Overrides:

toString in class IdentifiableElementImpl