org.corpus_tools.salt.common

Interface SDocument

All Superinterfaces:

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

All Known Implementing Classes:

SDocumentImpl

public interface SDocument
extends SNode

In Salt a document is represented by this class. An object of this class can contain an object of type SDocumentGraph which contains the 'real' linguistic data. An object of type SDocumentGraph can be set and get by calling setDocumentGraph(SDocumentGraph) and getDocumentGraph(). A closer documentation of a document graph, you can find in SDocumentGraph. A document must always be contained in a corpus (object of type SCorpus). Such a containment relation in Salt is represented by an object of type SCorpusRelation. How to add a SDocument object to a SCorpusGraph object please see the documentation of SCorpusGraph.

A document passes it's id to a document graph, when one is set.

Author:

florian

Method Summary

Modifier and Type	Method and Description
SDocumentGraph	createDocumentGraph() Returns the document structure which belongs to this document.
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.

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

getDocumentGraph

SDocumentGraph getDocumentGraph()

Returns the document structure which belongs to this document.

Returns:

document structure

createDocumentGraph

SDocumentGraph createDocumentGraph()

Returns the document structure which belongs to this document. If no document structure was created so far, a new one is created and returned .

Returns:

document structure

setDocumentGraph

void setDocumentGraph(SDocumentGraph documentGraph)

Sets the document structure which belongs to this document.

Parameters:

documentGraph - document structure which belongs to this document

getDocumentGraphLocation

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 .

Returns:

location of persisted SDocumentGraph object as URI

setDocumentGraphLocation

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 .

Parameters:

newSDocumentGraphLocation - location as URI

saveDocumentGraph

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.

Parameters:

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

loadDocumentGraph

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.

loadDocumentGraph

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.

Parameters:

documentGraphLocation - location of SaltXML to load SDocumentGraph object.

getGraph

SCorpusGraph getGraph()

Returns the container graph of this node.

Specified by:

getGraph in interface Node

Specified by:

getGraph in interface SNode

Returns:

graph object which contains this node.