org.corpus_tools.salt.util.internal.persistence

Class SaltXML10Writer

java.lang.Object

org.corpus_tools.salt.util.internal.persistence.SaltXML10Writer

All Implemented Interfaces:

SaltXML10Dictionary

public class SaltXML10Writer
extends Object
implements SaltXML10Dictionary

Field Summary

Fields inherited from interface org.corpus_tools.salt.util.internal.persistence.SaltXML10Dictionary

ATT_EDGES, ATT_HREF, ATT_LAYERS, ATT_NAME, ATT_NAMESPACE, ATT_NODES, ATT_SNAME, ATT_SOURCE, ATT_TARGET, ATT_TYPE, ATT_VALUE, ATT_VALUE_STRING, ATT_XMI_VERSION, ATT_XSI_TYPE, NS_SALTCOMMON, NS_SALTCORE, NS_SCORPUSSTRUCTURE, NS_SDOCUMENTSTRUCTURE, NS_VALUE_SALTCOMMON, NS_VALUE_SALTCORE, NS_VALUE_SCORPUSSTRUCTURE, NS_VALUE_SDOCUMENTSTRUCTURE, NS_VALUE_XMI, NS_VALUE_XSI, NS_XMI, NS_XSI, TAG_EDGES, TAG_LABELS, TAG_LAYERS, TAG_NODES, TAG_SALT_PROJECT, TAG_SALT_PROJECT_FULL, TAG_SCORPUS_GRAPH, TAG_SCORPUSGRAPH, TAG_SDOCUMENT, TAG_SDOCUMENT_GRAPH, TAG_SDOCUMENTSTRUCTURE_SDOCUMENTGRAPH, TYPE_SANNOTATION, TYPE_SAUDIO_RELATION, TYPE_SAUDIODS, TYPE_SCAT, TYPE_SCORPUS, TYPE_SCORPUS_DOCUMENT_RELATION, TYPE_SCORPUS_RELATION, TYPE_SDOCUMENT, TYPE_SDOMINANCE_RELATION, TYPE_SELEMENTID, TYPE_SFEATURE, TYPE_SLEMMA, TYPE_SMETAANNOTATION, TYPE_SORDER_RELATION, TYPE_SPOINTING_RELATION, TYPE_SPOS, TYPE_SPROCESSINGANNOTATION, TYPE_SSENTENCE, TYPE_SSPAN, TYPE_SSPANNING_RELATION, TYPE_SSTRUCTURE, TYPE_STEXTUAL_RELATION, TYPE_STEXTUALDS, TYPE_STIMELINE, TYPE_STIMELINE_RELATION, TYPE_STOKEN, TYPE_STYPE, TYPE_SWORD

Constructor Summary

Constructors

Constructor and Description
SaltXML10Writer()
SaltXML10Writer(File path)
SaltXML10Writer(org.eclipse.emf.common.util.URI path)

Method Summary

Methods

Modifier and Type	Method and Description
File	getPath()
String	marshallValue(Object value) Serializes an object as String.
void	setPrettyPrint(boolean isPrettyPrint) Determines whether the outputted SaltXML should be pretty printed.
void	writeCorpusGraph(XMLStreamWriter xml, SCorpusGraph graph, boolean embedded) Writes a corpus graph to the xml stream
void	writeDocumentGraph(SDocumentGraph graph) Writes a document graph to the file given by getPath().
void	writeDocumentGraph(XMLStreamWriter xml, SDocumentGraph graph) Writes a document graph to the xml stream.
void	writeLabel(XMLStreamWriter xml, Label label) Writes the passed label object to the passed XMLStreamWriter.
void	writeLayer(XMLStreamWriter xml, Layer layer, Map<SNode,Integer> nodePositions, Map<SRelation<SNode,SNode>,Integer> relPositions) Writes the passed relation object to the passed XMLStreamWriter.
void	writeNode(XMLStreamWriter xml, Node node, Map<? extends Layer,Integer> layerPositions) Writes the passed node object to the passed XMLStreamWriter.
void	writeObjects(XMLStreamWriter xml, Object... objects) Write a number of root objects (objects without a container) to XML.
void	writeRelation(XMLStreamWriter xml, Relation relation, Map<? extends Node,Integer> nodePositions, Map<? extends Layer,Integer> layerPositions) Writes the passed relation object to the passed XMLStreamWriter.
void	writeSaltProject(SaltProject project) Writes a Salt project to the file given by getPath().
void	writeSaltProject(XMLStreamWriter xml, SaltProject project) Writes a salt project to the xml stream.
void	writeXMIRootElement(XMLStreamWriter xml) Writes an Salt XMI header to the XMLStreamWriter.

Methods inherited from class java.lang.Object

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

Constructor Detail

SaltXML10Writer

public SaltXML10Writer()

SaltXML10Writer

public SaltXML10Writer(File path)

SaltXML10Writer

public SaltXML10Writer(org.eclipse.emf.common.util.URI path)

Method Detail

setPrettyPrint

public void setPrettyPrint(boolean isPrettyPrint)

Determines whether the outputted SaltXML should be pretty printed.

Parameters:

isPrettyPrint - true when output needs to be pretty printed

getPath

public File getPath()

writeObjects

public void writeObjects(XMLStreamWriter xml,
                Object... objects)

Write a number of root objects (objects without a container) to XML.

Parameters:

xml -

objects - List of objects of type SaltProject, SDocumentGraph or SCorpusGraph

writeSaltProject

public void writeSaltProject(SaltProject project)

Writes a Salt project to the file given by getPath().

Parameters:

project - the Salt project to be written

writeSaltProject

public void writeSaltProject(XMLStreamWriter xml,
                    SaltProject project)

Writes a salt project to the xml stream.

Parameters:

xml - A pre-configured XMLStreamWriter

project -

writeCorpusGraph

public void writeCorpusGraph(XMLStreamWriter xml,
                    SCorpusGraph graph,
                    boolean embedded)

Writes a corpus graph to the xml stream

Parameters:

graph - the corpus graph to be written

embedded - determines whether this corpus graph is part of a saltProject

xml - xml stream to write corpus graph to, if the passed one is null, a new one will be created

writeDocumentGraph

public void writeDocumentGraph(SDocumentGraph graph)

Writes a document graph to the file given by getPath().

Parameters:

graph -

writeDocumentGraph

public void writeDocumentGraph(XMLStreamWriter xml,
                      SDocumentGraph graph)

Writes a document graph to the xml stream.

Parameters:

xml - A pre-configured XMLStreamWriter

graph -

writeLabel

public void writeLabel(XMLStreamWriter xml,
              Label label)
                throws XMLStreamException

Writes the passed label object to the passed XMLStreamWriter.

Parameters:

label - to be persist

xml - stream to write data to

Throws:

XMLStreamException

marshallValue

public String marshallValue(Object value)

Serializes an object as String. If the passed object is

• String - it is prefixed with "T::"
• Boolean - it is prefixed with "B::"
• Integer - it is prefixed with "N::"
• Integer - it is prefixed with "L::"
• Float - it is prefixed with "F::"
• URI - it is prefixed with "U::"

Parameters:

value -

Returns:

writeNode

public void writeNode(XMLStreamWriter xml,
             Node node,
             Map<? extends Layer,Integer> layerPositions)
               throws XMLStreamException

Writes the passed node object to the passed XMLStreamWriter.

Parameters:

node - to be persist

xml - stream to write data to

layerPositions -

Throws:

XMLStreamException

writeRelation

public void writeRelation(XMLStreamWriter xml,
                 Relation relation,
                 Map<? extends Node,Integer> nodePositions,
                 Map<? extends Layer,Integer> layerPositions)
                   throws XMLStreamException

Writes the passed relation object to the passed XMLStreamWriter.

Parameters:

relation - to be persist

xml - stream to write data to

nodePositions - a map containing all positions of nodes in the list of nodes

layerPositions -

Throws:

XMLStreamException

writeLayer

public void writeLayer(XMLStreamWriter xml,
              Layer layer,
              Map<SNode,Integer> nodePositions,
              Map<SRelation<SNode,SNode>,Integer> relPositions)
                throws XMLStreamException

Writes the passed relation object to the passed XMLStreamWriter.

Parameters:

layer -

xml - stream to write data to

nodePositions - a map containing all positions of a single node in the list of nodes

relPositions - a map containing all positions of a single relation in the list of relations

Throws:

XMLStreamException

writeXMIRootElement

public void writeXMIRootElement(XMLStreamWriter xml)
                         throws XMLStreamException

Writes an Salt XMI header to the XMLStreamWriter. Salt XMI has a certain header structure (including the namespaces). This helper function writes this header to an existing XMLStreamWriter.

Parameters:

xml -

Throws:

XMLStreamException