prajna.io

Interface FormatWriter<X>

Type Parameters:

X - The type of data written

All Known Implementing Classes:

BufferedFormatWriter, CommonMLWriter, KmlWriter, OwlWriter, SemanticSvgWriter, SimileFormatWriter, SolrUpdater, StructureKmlWriter, StructureWriter, StructureXmlWriter, WebFormatWriter

public interface FormatWriter<X>

General interface for writing objects of a particular type out via a specified writer.

Author:

Edward Swing

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Close this writer.
java.lang.String	getDestination() Gets the destination for this writer
void	setDestination(java.lang.String destination) Set the destination for this writer.
void	writeData(java.util.Collection<X> data) Write the collection of data.

Method Detail

close

void close()

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

getDestination

java.lang.String getDestination()

Gets the destination for this writer

Returns:

the destination

setDestination

void setDestination(java.lang.String destination)
                    throws java.io.IOException

Set the destination for this writer. This method should set the particular destination for a writer, whether the argument is a URL, file or directory.

Parameters:

destination - the destination for this writer.

Throws:

java.io.IOException - if there is a problem writing to the destination

writeData

void writeData(java.util.Collection<X> data)
               throws java.io.IOException

Write the collection of data. The data should be written in iteration order. Implementations may buffer the data internally until a close() is called in order to optimize writing in a particular format.

Parameters:

data - the data collection

Throws:

java.io.IOException - if there is a problem writing the data