prajna.structure.writer

Class StructureKmlWriter

java.lang.Object

prajna.io.WebFormatWriter<DataRecord>

prajna.structure.writer.StructureWriter

prajna.structure.writer.StructureKmlWriter

All Implemented Interfaces:

FormatWriter<DataRecord>

public class StructureKmlWriter
extends StructureWriter

Format Writer which outputs temporal data into the Google KML format. This writer extracts the geographic data, and creates composite KML objects with the appropriate references to the underlying data where appropriate.

Author:

Edward Swing

Constructor Summary

Constructors

Constructor and Description
StructureKmlWriter()

Method Summary

Methods

Modifier and Type	Method and Description
void	clear() Clear any stored settings and data
void	close() Close this writer.
protected GeoShape	convertToGeometry(DataRecord rec) Convert a particular data record to geographic-based geometry objects.
java.util.Set<GeoLayer>	generateLayers(java.util.Collection<DataRecord> data) Generate the layers for the collection of data.
java.lang.String	getContentType() Get the content type generated by this writer.
java.lang.String	getTimeField() Get the field within the data records which is used to identify the active time.
void	setCategoryFields(java.util.List<java.lang.String> fields) Identify the fields which will be used to sort the features into folders.
void	setTimeField(java.lang.String fieldName) Set the field within the data records which is used to identify the active time.
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

getDestination, getWriter, setDestination, setWriter

Methods inherited from class java.lang.Object

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

Constructor Detail

StructureKmlWriter

public StructureKmlWriter()

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.

convertToGeometry

protected GeoShape convertToGeometry(DataRecord rec)

Convert a particular data record to geographic-based geometry objects. This method will extract any location fields. If there are multiple geographic references, this method returns a GeoMultiShape with all elements. Otherwise, it returns the single element, or null if there are no geographic references. If the value of a Location is a shape itself, that shape is included in the list; places with single locations are usually represented as GeoMarkers.

Parameters:

rec - the data record to translate

Returns:

a GeoShape containing all available geographic shapes that could be created from the data record

generateLayers

public java.util.Set<GeoLayer> generateLayers(java.util.Collection<DataRecord> data)

Generate the layers for the collection of data. This method checks each record to identify which layer it would fall into. The layers are created if needed. The layers are determined by the category fields. It is not necessary to call this method, but this method may be used to control the RenderStyle applied to each layer as it is written to KML.

Parameters:

data - the data collection

Returns:

the set of GeoLayers

getContentType

public java.lang.String getContentType()

Get the content type generated by this writer. This should return a mime type, suitable for web-based data

Overrides:

getContentType in class WebFormatWriter<DataRecord>

Returns:

the String application/vnd.google-earth.kml+xml

getTimeField

public java.lang.String getTimeField()

Get the field within the data records which is used to identify the active time.

Returns:

the timeField

setCategoryFields

public void setCategoryFields(java.util.List<java.lang.String> fields)

Identify the fields which will be used to sort the features into folders. The values from the fields of each DataRecord will be used to categorize the records into different folders. Only fields with limited value ranges, such as an enumerated field, should be used for a category field.

Parameters:

fields - the list of fields

setTimeField

public void setTimeField(java.lang.String fieldName)

Set the field within the data records which is used to identify the active time.

Parameters:

fieldName - the timeField to set

writeData

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

Write the collection of data. If there are no category fields set, the data should be written in iteration order. Otherwise the data will be grouped into folders by the category fields

Parameters:

data - the data collection

writeGraph

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

Write graph data. This method converts each node to its geographic representation. Any edge which connects two geographic shapes is represented by a polyline between the center of the two shapes

Specified by:

writeGraph in class StructureWriter

Parameters:

graph - the graph to write to KML

writeGrid

public void writeGrid(Grid<DataRecord> grid)

Write Grid data. Not yet implemented

Specified by:

writeGrid in class StructureWriter

Parameters:

grid - the grid

writeTree

public void writeTree(Tree<DataRecord> tree)

Write tree data. Not yet implemented

Specified by:

writeTree in class StructureWriter

Parameters:

tree - the tree data