org.corpus_tools.salt.util.internal

Class DataSourceAccessor

java.lang.Object

org.corpus_tools.salt.util.internal.DataSourceAccessor

public class DataSourceAccessor
extends Object

Provides some methods for an easier access to objects being contained by a given SDocumentGraph object.

Author:

Florian Zipser

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DataSourceAccessor.TRAVERSION_TYPE types of traversions, used by the several methods, used as id for traversion

Constructor Summary

Constructors

Constructor and Description
DataSourceAccessor()

Method Summary

Methods

Modifier and Type	Method and Description
static List<SNode>	getNodeBySequence(SDocumentGraph documentGraph, DataSourceSequence DataSourceSequence) Returns all SNode objects which refer to the passed DataSourceSequence object.
static List<DataSourceSequence>	getOverlappedDataSourceSequence(SDocumentGraph documentGraph, List<SNode> nodes, SALT_TYPE... relationTypes)
static List<DataSourceSequence>	getOverlappedDataSourceSequence(SDocumentGraph documentGraph, SNode sNode, SALT_TYPE... relationTypes)
static List<SToken>	getOverlappedSTokens(SDocumentGraph documentGraph, SNode overlappingNode, SALT_TYPE... relationTypes) This method searches for every SToken which is (transitively) overlapped by the given SNode by SRelation types which have one of the types given in the overlappingRelationTypes list.
static List<SNode>	getRootsByRelation(SDocumentGraph documentGraph, SALT_TYPE... saltTypes) Returns all SNode objects which are roots for the given types of SRelation.
static com.google.common.collect.Multimap<String,SNode>	getRootsByRelationType(SDocumentGraph documentGraph, Class<? extends SRelation> clazz) for each relation R of type class for each foregoing relation P (incoming relation of R'source) check whether P is a parent of R (true, if they have the same class and the same type) if R has no parents store R corresponding to it's type in returned table
static com.google.common.collect.Multimap<String,SNode>	getRootsByRelationType(SDocumentGraph documentGraph, SALT_TYPE sType) Returns all nodes, which are roots for the given relation-class respects to the given SType of the traversed relation.
static List<SToken>	getSortedSTokenByText(SDocumentGraph documentGraph)
static List<SToken>	getSortedSTokenByText(SDocumentGraph documentGraph, List<SToken> sTokens2sort)
static List<SSpan>	getSpanBySequence(SDocumentGraph documentGraph, DataSourceSequence DataSourceSequence) Returns all SSpan objects which refer to the passed DataSourceSequence object.
static List<SStructure>	getStructureBySequence(SDocumentGraph documentGraph, DataSourceSequence DataSourceSequence) Returns all SStructure objects which refer to the passed DataSourceSequence object.
static List<SToken>	getTokensBySequence(SDocumentGraph documentGraph, DataSourceSequence DataSourceSequence) Returns all SToken objects which refer to the passed DataSourceSequence object.
static boolean	isContinuousByText(SDocumentGraph documentGraph, List<? extends SNode> subSNodList, List<? extends SNode> fullSNodList) First sorts the given lists, than searches first occurance of first node in subSNodList in fullSNodList.
static boolean	isContinuousByText(SDocumentGraph documentGraph, List<SNode> subSNodList)
static void	sortSTokenByText(SDocumentGraph documentGraph)

Methods inherited from class java.lang.Object

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

Constructor Detail

DataSourceAccessor

public DataSourceAccessor()

Method Detail

getTokensBySequence

public static List<SToken> getTokensBySequence(SDocumentGraph documentGraph,
                               DataSourceSequence DataSourceSequence)

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 datasource by the instance sSequentialDS.

Parameters:

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

Returns:

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

getSpanBySequence

public static List<SSpan> getSpanBySequence(SDocumentGraph documentGraph,
                            DataSourceSequence DataSourceSequence)

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 datasource by the instance sSequentialDS.

Parameters:

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

Returns:

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

getStructureBySequence

public static List<SStructure> getStructureBySequence(SDocumentGraph documentGraph,
                                      DataSourceSequence DataSourceSequence)

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:

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

Returns:

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

getNodeBySequence

public static List<SNode> getNodeBySequence(SDocumentGraph documentGraph,
                            DataSourceSequence DataSourceSequence)

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 datasource by the instance sSequentialDS.

Parameters:

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

Returns:

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

isContinuousByText

public static boolean isContinuousByText(SDocumentGraph documentGraph,
                         List<? extends SNode> subSNodList,
                         List<? extends SNode> fullSNodList)

First sorts the given lists, than searches first occurance of first node in subSNodList in fullSNodList. Starting from this index, the method compares each element in subSNodList to element i in fullSNodList. If one is not equal the method returns false.

isContinuousByText

public static boolean isContinuousByText(SDocumentGraph documentGraph,
                         List<SNode> subSNodList)

sortSTokenByText

public static void sortSTokenByText(SDocumentGraph documentGraph)

getSortedSTokenByText

public static List<SToken> getSortedSTokenByText(SDocumentGraph documentGraph,
                                 List<SToken> sTokens2sort)

getSortedSTokenByText

public static List<SToken> getSortedSTokenByText(SDocumentGraph documentGraph)

getOverlappedDataSourceSequence

public static List<DataSourceSequence> getOverlappedDataSourceSequence(SDocumentGraph documentGraph,
                                                       SNode sNode,
                                                       SALT_TYPE... relationTypes)

getOverlappedDataSourceSequence

public static List<DataSourceSequence> getOverlappedDataSourceSequence(SDocumentGraph documentGraph,
                                                       List<SNode> nodes,
                                                       SALT_TYPE... relationTypes)

getOverlappedSTokens

public static List<SToken> getOverlappedSTokens(SDocumentGraph documentGraph,
                                SNode overlappingNode,
                                SALT_TYPE... relationTypes)

This method searches for every SToken which is (transitively) overlapped by the given SNode by SRelation types which have one of the types given in the overlappingRelationTypes list.

Parameters:

overlappingNode - the node for which the overlapped SToken objects are searched

overlappingRelationTypes - the list of SALT_TYPEs which are used for traversion. If, for example, all SToken are searched which are overlapped by a SStructure, the SALT_TYPE.SDOMINANCE_RELATION and SALT_TYPE.SPANNING_RELATION should be contained in this parameter.

Returns:

a list of SToken which are overlapped by the overlappingNode.

getRootsByRelation

public static List<SNode> getRootsByRelation(SDocumentGraph documentGraph,
                             SALT_TYPE... saltTypes)

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

public static com.google.common.collect.Multimap<String,SNode> getRootsByRelationType(SDocumentGraph documentGraph,
                                                                      SALT_TYPE sType)

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 getRootsBySRelation() is only node1.

Parameters:

clazz - class of Relation to be traversed for searching roots

Returns:

a map of types, with corresponding lists of root nodes

getRootsByRelationType

public static com.google.common.collect.Multimap<String,SNode> getRootsByRelationType(SDocumentGraph documentGraph,
                                                                      Class<? extends SRelation> clazz)

 for each relation R of type class
     for each foregoing relation P (incoming relation of R'source)
         check whether P is a parent of R (true, if they have the same class and the same type)   
     if R has no parents store R corresponding to it's type in returned table