org.corpus_tools.salt.common.impl

Class SCorpusGraphImpl

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

All Implemented Interfaces:

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

public class SCorpusGraphImpl
extends SGraphImpl
implements SCorpusGraph

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

Modifier and Type	Field and Description
protected SaltProject	saltProject Salt-project containing this corpus structure

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
SCorpusGraphImpl()

Method Summary

Methods

Modifier and Type	Method and Description
Identifier	addDocument(SCorpus corpus, SDocument document) Adds the given document to the SCorpusGraph object and creates an SCorpusDocumentRelation between the given corpus and the document, if and only if the corpus is already added to this object.
Identifier	addSubCorpus(SCorpus superCorpus, SCorpus subCorpus) Adds the given sSubCorpus to the SCorpusGraph object and creates an SCorpusRelation between the given super corpus and the sub corpus, if and only if the super corpus is already added to this object.
void	basic_setSaltProject(SaltProject saltProject) 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.
SCorpus	createCorpus(SCorpus superCorpus, String corpusName) Creates a new SCorpus object having the name corpusName.
List<SCorpus>	createCorpus(org.eclipse.emf.common.util.URI corpusPath) Creates all SCorpus objects contained in the passed corpusPath and returns a list of all SCorpus objects.
SDocument	createDocument(SCorpus parentCorpus, String documentName) Creates a SDocument object having the name documentName and is added to the given parentCorpus via a SCorpusDocumentRelation.
SDocument	createDocument(org.eclipse.emf.common.util.URI documentPath) Creates all SCorpus objects contained in the passed corpusPath and assumes, that the last segment is a SDocument object.
List<SCorpus>	getCorpora() Returns all corpora contained in this corpus structure.
SCorpus	getCorpus(Identifier corpusId) Returns a corpus matching the passed identifier if such a corpus is contained in this corpus structure.
SCorpus	getCorpus(SDocument document) Returns the SCorpus object, which contains the given SDocument object (means the SCorpus object and the given SDocument object must be connected via a SCorpusDocumentRelation object).
List<SCorpusDocumentRelation>	getCorpusDocumentRelations() Returns all corpus-document relations contained in this corpus structure.
List<SCorpusRelation>	getCorpusRelations() Returns all corpus-corpus relations contained in this corpus structure.
SDocument	getDocument(Identifier documentId) Returns a document matching the passed identifier if such a document is contained in this document structure.
List<SDocument>	getDocuments() Returns all documents objects contained in this corpus structure.
SaltProject	getSaltProject() Returns the salt project, to which this corpus structure belongs to.
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
void	load(org.eclipse.emf.common.util.URI corpusGraphUri) Loads the content of this object by reading the SaltXML file located by the given URI.
void	setSaltProject(SaltProject saltProject) Sets the salt project, to which this corpus structure belongs to.

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, toString

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

Field Detail

saltProject

protected transient SaltProject saltProject

Salt-project containing this corpus structure

Constructor Detail

SCorpusGraphImpl

public SCorpusGraphImpl()

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>

getSaltProject

public SaltProject getSaltProject()

Returns the salt project, to which this corpus structure belongs to.

Specified by:

getSaltProject in interface SCorpusGraph

Returns:

salt project containing this corpus structure

setSaltProject

public void setSaltProject(SaltProject saltProject)

Sets the salt project, to which this corpus structure belongs to.

Specified by:

setSaltProject in interface SCorpusGraph

Parameters:

saltProject - salt project containing this corpus structure

basic_setSaltProject

public void basic_setSaltProject(SaltProject saltProject)

This is an internally used method. To implement a double chaining of SCorpusGraph and SaltProject object when an node is inserted into this graph and to avoid an endless invocation the insertion of an node is splited into the two methods setSaltProject(SaltProject) and basic_setSaltProject(SaltProject).

Parameters:

saltProject - the Salt project containing the corpus structure

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

getCorpora

public List<SCorpus> getCorpora()

Returns all corpora contained in this corpus structure.

Specified by:

getCorpora in interface SCorpusGraph

Returns:

all contained corpora

getDocuments

public List<SDocument> getDocuments()

Returns all documents objects contained in this corpus structure.

Specified by:

getDocuments in interface SCorpusGraph

Returns:

all contained documents

getCorpusRelations

public List<SCorpusRelation> getCorpusRelations()

Returns all corpus-corpus relations contained in this corpus structure.

Specified by:

getCorpusRelations in interface SCorpusGraph

Returns:

all contained corpus-corpus relations

getCorpusDocumentRelations

public List<SCorpusDocumentRelation> getCorpusDocumentRelations()

Returns all corpus-document relations contained in this corpus structure.

Specified by:

getCorpusDocumentRelations in interface SCorpusGraph

Returns:

all contained corpus-document relations

getCorpus

public SCorpus getCorpus(Identifier corpusId)

Returns a corpus matching the passed identifier if such a corpus is contained in this corpus structure. If no such corpus is contained, null is returned.

Specified by:

getCorpus in interface SCorpusGraph

Parameters:

corpusId - identifier corresponding to the corpus to be searched

Returns:

corpus matching the identifier, null if no such corpus exists

getDocument

public SDocument getDocument(Identifier documentId)

Returns a document matching the passed identifier if such a document is contained in this document structure. If no such document is contained, null is returned.

Specified by:

getDocument in interface SCorpusGraph

Parameters:

documentId - identifier corresponding to the document to be searched

Returns:

document matching the identifier, null if no such document exists

addSubCorpus

public Identifier addSubCorpus(SCorpus superCorpus,
                      SCorpus subCorpus)

Adds the given sSubCorpus to the SCorpusGraph object and creates an SCorpusRelation between the given super corpus and the sub corpus, if and only if the super corpus is already added to this object. Otherwise an exception will be thrown. The method returns the identifier for the generated SCorpusRelation object.

Specified by:

addSubCorpus in interface SCorpusGraph

Parameters:

superCorpus - corpus which already has to be added

subCorpus - corpus to add

Returns:

the identifier for the generated SCorpusRelation object.

addDocument

public Identifier addDocument(SCorpus corpus,
                     SDocument document)

Adds the given document to the SCorpusGraph object and creates an SCorpusDocumentRelation between the given corpus and the document, if and only if the corpus is already added to this object. Otherwise an exception will be thrown. The method returns the Identifier for the generated SCorpusDocumentRelation object.

Specified by:

addDocument in interface SCorpusGraph

Parameters:

corpus - corpus to which the document has to be added

document - document to add

Returns:

the identifier for the generated SCorpusDocumentRelation object

getCorpus

public SCorpus getCorpus(SDocument document)

Returns the SCorpus object, which contains the given SDocument object (means the SCorpus object and the given SDocument object must be connected via a SCorpusDocumentRelation object).

Specified by:

getCorpus in interface SCorpusGraph

Parameters:

document - the SDocument object beyond the SCorpus object to be returned

Returns:

the SCorpus object containing document

load

public void load(org.eclipse.emf.common.util.URI corpusGraphUri)

Loads the content of this object by reading the SaltXML file located by the given URI. The SaltXML file can either contain a SaltProject, than the first SCorpusGraph object is loaded or just a SCorpusGraph object.

Specified by:

load in interface SCorpusGraph

Parameters:

corpusGraphUri - loaction of the SaltXML file

createCorpus

public SCorpus createCorpus(SCorpus superCorpus,
                   String corpusName)

Creates a new SCorpus object having the name corpusName. The new created SCorpus object is added as a sub corpus to the passed superCorpus. An SCorpusRelation is created to connect them. The new created SCorpus is returned. If superSCorpus does not exist, a root corpus is created.

Specified by:

createCorpus in interface SCorpusGraph

Parameters:

superCorpus - the parent SCorpus object

corpusName - the name of the SCorpus object to be new created

Returns:

the new created SCorpus object

createDocument

public SDocument createDocument(SCorpus parentCorpus,
                       String documentName)

Creates a SDocument object having the name documentName and is added to the given parentCorpus via a SCorpusDocumentRelation.

Specified by:

createDocument in interface SCorpusGraph

Parameters:

parentCorpus - the parent SCorpus object

documentName - the name of the SDocument object to be new created

Returns:

the new created SDocument object

createCorpus

public List<SCorpus> createCorpus(org.eclipse.emf.common.util.URI corpusPath)

Creates all SCorpus objects contained in the passed corpusPath and returns a list of all SCorpus objects.

Specified by:

createCorpus in interface SCorpusGraph

Parameters:

corpusPath - the URI path of corpora

Returns:

all created SCorpus objects

createDocument

public SDocument createDocument(org.eclipse.emf.common.util.URI documentPath)

Creates all SCorpus objects contained in the passed corpusPath and assumes, that the last segment is a SDocument object. The created SDocument than is returned.

Specified by:

createDocument in interface SCorpusGraph

Parameters:

documentPath - the URI path of the document

Returns:

the created document