prajna.structure.writer

Class SimileFormatWriter

java.lang.Object

prajna.io.WebFormatWriter<DataRecord>

prajna.structure.writer.StructureWriter

prajna.structure.writer.SimileFormatWriter

All Implemented Interfaces:

FormatWriter<DataRecord>

public class SimileFormatWriter
extends StructureWriter

Format Writer which outputs temporal data into the Simile Timeline format. This class extracts the date and timespan objects from the data structures, writing the data into the XML-based format.

Author:

Edward Swing

Constructor Summary

Constructors

Constructor and Description
SimileFormatWriter() Instantiates a new Simile format writer.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addSimileElement(DataRecord rec) Adds a Simile element for the associated DataRecord.
void	clear() Clear any stored settings and data.
void	close() Close this writer.
void	writeData(java.util.Collection<DataRecord> data) Write the collection of data.
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

SimileFormatWriter

public SimileFormatWriter()

Instantiates a new Simile format writer.

Method Detail

addSimileElement

protected void addSimileElement(DataRecord rec)

Adds a Simile element for the associated DataRecord. This method creates a Simile Event element for each TimeSpan in the data record.

Parameters:

rec - the SataRecord

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> data)

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

Parameters:

data - the data collection

writeGraph

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

Write graph data. This method simply calls writeData() with the nodeSet and edgeSet. The Simile Timeline format does not support graph objects.

Specified by:

writeGraph in class StructureWriter

Parameters:

graph - the graph

writeGrid

public void writeGrid(Grid<DataRecord> grid)

Write Grid data. This method simply extracts all non-null cells and adds any timeline data to the Simile document.

Specified by:

writeGrid in class StructureWriter

Parameters:

grid - the grid

writeTree

public void writeTree(Tree<DataRecord> tree)

Write tree data. This method simply extracts all child nodes and adds any timeline data to the Simile document.

Specified by:

writeTree in class StructureWriter

Parameters:

tree - the tree data