prajna.structure.writer

Class CommonMLWriter

java.lang.Object

prajna.io.WebFormatWriter<DataRecord>

prajna.structure.writer.StructureWriter

prajna.structure.writer.CommonMLWriter

All Implemented Interfaces:

FormatWriter<DataRecord>

public class CommonMLWriter
extends StructureWriter

The CommonMLWriter class outputs commonly used formats for the various data structure types, including GraphML and TreeML. For Graphs, this writer produces GraphML. For Trees, it produces TreeML. Currently, no formats are supported for grids or datasets.

Author:

Edward Swing

Constructor Summary

Constructors

Constructor and Description
CommonMLWriter() Create a new CommonMLWriter

Method Summary

Methods

Modifier and Type	Method and Description
void	clear() Clear any stored settings and data
void	close() Close this writer.
void	writeData(java.util.Collection<DataRecord> dataset) Write a dataset.
void	writeGraph(Graph<DataRecord,DataRecord> graph) Write graph data.
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

CommonMLWriter

public CommonMLWriter()

Create a new CommonMLWriter

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.

writeData

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

Write a dataset.

Parameters:

dataset - the dataset of records

writeGraph

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

Write graph data. This method appends a graphML element to the document. The graphML element includes representations of all nodes and edges in the graph, as well as the references for the data representations themselves.

Specified by:

writeGraph in class StructureWriter

Parameters:

graph - the graph

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. This method appends a treeML element to the document. It includes data for all nodes within the tree.

Specified by:

writeTree in class StructureWriter

Parameters:

tree - the tree data