prajna.structure.writer

Class StructureXmlWriter

java.lang.Object

prajna.io.WebFormatWriter<DataRecord>

prajna.structure.writer.StructureWriter

prajna.structure.writer.StructureXmlWriter

All Implemented Interfaces:

FormatWriter<DataRecord>

public class StructureXmlWriter
extends StructureWriter

Semantic Writer which outputs the data structures into the XML format which the various semantic components read natively. This writer allows the data to be written so that it can be read by the semantic servlets or similar components. A flag can turn off the writing of the data itself, so only the structural information is written. The class also includes output methods for writing data structure information.

Author:

Edward Swing

See Also:

StructureReader

Constructor Summary

Constructors

Constructor and Description
StructureXmlWriter() Instantiates a new Structure format writer.

Method Summary

Methods

Modifier and Type	Method and Description
void	clear() Clear any stored settings and data
void	close() Close this writer.
boolean	isDataWritten() Return whether the data elements should be written.
boolean	isTemplateWritten() Return whether the templates should be written out by this StructureWriter
void	setDataWritten(boolean writtenFlag) Set the dataWritten flag.
void	setTemplateWritten(boolean templateWritten) Set the templateWritten flag.
void	writeData(java.util.Collection<DataRecord> dataset) Write the collection of data.
void	writeDataStructureSpec(DataStructureSpec spec) Write the data structure specification element to the XML file.
void	writeGraph(Graph<DataRecord,DataRecord> graph) Write graph data
void	writeGraphSpec(GraphSpec spec) Write the graph specification element to the XML file.
void	writeGrid(Grid<DataRecord> grid) Write Grid data
void	writeTree(Tree<DataRecord> tree) Write tree data

Methods inherited from class prajna.io.WebFormatWriter

getContentType, getDestination, getWriter, setDestination, setWriter

Methods inherited from class java.lang.Object

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

Constructor Detail

StructureXmlWriter

public StructureXmlWriter()

Instantiates a new Structure format writer.

Method Detail

clear

public void clear()

Clear any stored settings and data

Specified by:

clear in class StructureWriter

close

public void close()

Close this writer. This should ensure that all data is written by the internal writer, and close the current internal writer.

isDataWritten

public boolean isDataWritten()

Return whether the data elements should be written.

Returns:

the dataWritten

isTemplateWritten

public boolean isTemplateWritten()

Return whether the templates should be written out by this StructureWriter

Returns:

whether the templates should be included when the data is generated

setDataWritten

public void setDataWritten(boolean writtenFlag)

Set the dataWritten flag. If the dataWritten flag is set to true, the contents of the data structures - the graph nodes and edges, tree nodes, grid cells or dataset elements - will be included in the output. If the dataWritten flag is set to false, only the structural information will be exported. This output could be used to generate configuration files. The flag is set to true by default.

Parameters:

writtenFlag - the dataWritten flag

setTemplateWritten

public void setTemplateWritten(boolean templateWritten)

Set the templateWritten flag. If the templateWritten flag is set to true, the templates for the various data structures will be included. If the templates are not specifically defined, this class will make a best effort to create the templates. The flag is set to false by default.

Parameters:

templateWritten - the templateWritten flag

writeData

public void writeData(java.util.Collection<DataRecord> dataset)

Write the collection of data. The data should be written in iteration order.

Parameters:

dataset - the data collection

writeDataStructureSpec

public void writeDataStructureSpec(DataStructureSpec spec)

Write the data structure specification element to the XML file. This method adds each of the data templates for the data structure, and then writes the XML for the specification itself.

Parameters:

spec - the data structure specification element.

writeGraph

public void writeGraph(Graph<DataRecord,DataRecord> graph)

Write graph data

Specified by:

writeGraph in class StructureWriter

Parameters:

graph - the graph

writeGraphSpec

public void writeGraphSpec(GraphSpec spec)

Write the graph specification element to the XML file. This method adds each of the data templates for the data structure, and then writes the XML for the specification itself.

Parameters:

spec - the data structure specification element.

writeGrid

public void writeGrid(Grid<DataRecord> grid)

Write Grid data

Specified by:

writeGrid in class StructureWriter

Parameters:

grid - the grid

writeTree

public void writeTree(Tree<DataRecord> tree)

Write tree data

Specified by:

writeTree in class StructureWriter

Parameters:

tree - the tree data