org.corpus_tools.salt.common.impl

Class SDocumentImpl

java.lang.Object

org.corpus_tools.salt.graph.impl.LabelableElementImpl

org.corpus_tools.salt.graph.impl.IdentifiableElementImpl

org.corpus_tools.salt.graph.impl.NodeImpl

org.corpus_tools.salt.core.impl.SNodeImpl

org.corpus_tools.salt.common.impl.SDocumentImpl

All Implemented Interfaces:

Serializable, SDocument, SAnnotationContainer, SNamedElement, SNode, SPathElement, IdentifiableElement, LabelableElement, Node

public class SDocumentImpl
extends SNodeImpl
implements SDocument

See Also:

Serialized Form

Field Summary

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

name

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

delegate, graph

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

EXPECTED_NUMBER_OF_LABELS

Constructor Summary

Constructors

Constructor and Description
SDocumentImpl()

Method Summary

Methods

Modifier and Type	Method and Description
void	basic_setDocumentGraph(SDocumentGraph documentGraph) This is an internally used method.
SDocumentGraph	getDocumentGraph() Returns the document structure which belongs to this document.
org.eclipse.emf.common.util.URI	getDocumentGraphLocation() Returns the location of the contained SDocumentGraph object, in case it is persisted.
SCorpusGraph	getGraph() Returns the container graph of this node.
void	loadDocumentGraph() Loads a SDocumentGraph object and sets it to the contained SDocumentGraph object.
void	loadDocumentGraph(org.eclipse.emf.common.util.URI documentGraphLocation) Loads a SDocumentGraph object and sets it to the contained SDocumentGraph object.
void	saveDocumentGraph(org.eclipse.emf.common.util.URI documentGraphLocation) Persists the SDocumentGraph object contained by this object as SaltXML file at the location given by the passed URI object.
void	setDocumentGraph(SDocumentGraph documentGraph) Sets the document structure which belongs to this document.
void	setDocumentGraphLocation(org.eclipse.emf.common.util.URI location) Sets the location as URI, of where the contained SDocumentGraph object is persisted.
void	setId(String id) Creates a new Identifier object and sets its value to the passed id.
void	setIdentifier(Identifier identifier) Sets the Identifier label for this object.
String	toString()

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

addAnnotation, addFeature, addMetaAnnotation, addProcessingAnnotation, createAnnotation, createAnnotations, createFeature, createFeatures, createMetaAnnotation, createMetaAnnotations, createProcessingAnnotation, createProcessingAnnotations, getAnnotation, getAnnotation, getAnnotations, getFeature, getFeature, getFeatures, getInRelations, getLayers, getMetaAnnotation, getMetaAnnotations, getName, getOutRelations, getPath, getProcessingAnnotation, getProcessingAnnotations, iterator_SAnnotation, iterator_SFeature, iterator_SMetaAnnotation, iterator_SProcessingAnnotation, removeLabel, setName

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

addLayer, basicSetGraph, getDelegate, removeLayer, setGraph

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

getId, getIdentifier

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

getInRelations, getLayers, getOutRelations

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

addLayer, removeLayer, setGraph

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

getId, getIdentifier

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

SDocumentImpl

public SDocumentImpl()

Method Detail

getDocumentGraph

public SDocumentGraph getDocumentGraph()

Returns the document structure which belongs to this document.

Specified by:

getDocumentGraph in interface SDocument

Returns:

document structure

setDocumentGraph

public void setDocumentGraph(SDocumentGraph documentGraph)

Sets the document structure which belongs to this document.

Specified by:

setDocumentGraph in interface SDocument

Parameters:

documentGraph - document structure which belongs to this document

basic_setDocumentGraph

public void basic_setDocumentGraph(SDocumentGraph documentGraph)

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:

 #setSDocument(SDocument)                      SDocument#setDocumentGraph(Graph)
         ||             \ /                   ||
         ||              X                    ||
         \/             / \                   \/
 #basicSDocument(SDocument)            SDocument#basicSetSDocumentGraph(Graph)
 

Parameters:

document - the container document of this document graph

setId

public void setId(String id)

Creates a new Identifier object and sets its value to the passed id. Creates a new Identifier and sets it to the document graph. The identifier has the same id value as this document.

Specified by:

setId in interface IdentifiableElement

Overrides:

setId in class IdentifiableElementImpl

setIdentifier

public void setIdentifier(Identifier identifier)

Sets the Identifier label for this object. If this object alredy had an identifier, the old one is removed and the new one is added. Creates a new Identifier and sets it to the document graph. The identifier has the same id value as this document.

Specified by:

setIdentifier in interface IdentifiableElement

Overrides:

setIdentifier in class IdentifiableElementImpl

getDocumentGraphLocation

public org.eclipse.emf.common.util.URI getDocumentGraphLocation()

Returns the location of the contained SDocumentGraph object, in case it is persisted. The location is stored via a SFeature object having the namespace and the name .

Specified by:

getDocumentGraphLocation in interface SDocument

Returns:

location of persisted SDocumentGraph object as URI

setDocumentGraphLocation

public void setDocumentGraphLocation(org.eclipse.emf.common.util.URI location)

Sets the location as URI, of where the contained SDocumentGraph object is persisted. The location is stored as SFeature having the namespace and the name .

Specified by:

setDocumentGraphLocation in interface SDocument

saveDocumentGraph

public void saveDocumentGraph(org.eclipse.emf.common.util.URI documentGraphLocation)

Persists the SDocumentGraph object contained by this object as SaltXML file at the location given by the passed URI object. The URI is stored as SFeature by calling #setSDocumentGraphLocation(URI). The relation between SDocument and given SDocumentGraph will be removed.

Specified by:

saveDocumentGraph in interface SDocument

Parameters:

documentGraphLocation - location of where to persist object as file (must have the ending ) in URI syntax

loadDocumentGraph

public void loadDocumentGraph()

Loads a SDocumentGraph object and sets it to the contained SDocumentGraph object. The location of where to find the SaltXML containing the SDocumentGraph object must be given as SFeature. It will be read via calling #getSDocumentGraphLocation(). After loading, the feature accessible via #getSDocumentGraphLocation() will be removed.

Specified by:

loadDocumentGraph in interface SDocument

loadDocumentGraph

public void loadDocumentGraph(org.eclipse.emf.common.util.URI documentGraphLocation)

Loads a SDocumentGraph object and sets it to the contained SDocumentGraph object. The location of where to find the SaltXML containing the SDocumentGraph object is given by the passed URI object. After loading, the feature accessible via #getSDocumentGraphLocation() if exist will be removed.

Specified by:

loadDocumentGraph in interface SDocument

Parameters:

documentGraphLocation - location of SaltXML to load SDocumentGraph object.

toString

public String toString()

Overrides:

toString in class IdentifiableElementImpl

getGraph

public SCorpusGraph getGraph()

Description copied from class: SNodeImpl

Returns the container graph of this node.

Specified by:

getGraph in interface SDocument

Specified by:

getGraph in interface SNode

Specified by:

getGraph in interface Node

Overrides:

getGraph in class SNodeImpl

Returns:

graph object which contains this node.