prajna.io

Class WebFormatWriter<X>

java.lang.Object

prajna.io.WebFormatWriter<X>

Type Parameters:

X - The type of data written

All Implemented Interfaces:

FormatWriter<X>

Direct Known Subclasses:

KmlWriter, OwlWriter, StructureWriter

public abstract class WebFormatWriter<X>
extends java.lang.Object
implements FormatWriter<X>

Abstract class for FormatWriter with support for incorporating the writer into a web-based response, such as in a servlet

Author:

Edward Swing

Constructor Summary

Constructors

Constructor and Description
WebFormatWriter()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getContentType() Get the content type generated by this writer.
java.lang.String	getDestination() Get the destination for this writer, if set.
protected java.io.Writer	getWriter() Get the current writer for this FormatWriter
void	setDestination(java.lang.String destination) Set the destination for this writer.
void	setWriter(java.io.Writer writer) Sets the internal writer, specifying the output destination.

Methods inherited from class java.lang.Object

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

Methods inherited from interface prajna.io.FormatWriter

close, writeData

Constructor Detail

WebFormatWriter

public WebFormatWriter()

Method Detail

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. By default it returns text/xml.

Returns:

the content type

getDestination

public java.lang.String getDestination()

Get the destination for this writer, if set. This will return the output file if this FormatWriter is writing to a file.

Specified by:

getDestination in interface FormatWriter<X>

Returns:

the destination

getWriter

protected java.io.Writer getWriter()

Get the current writer for this FormatWriter

Returns:

the current writer

setDestination

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

Set the destination for this writer. This method sets the output file for the writer.

Specified by:

setDestination in interface FormatWriter<X>

Parameters:

destination - the destination for this writer.

Throws:

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

setWriter

public void setWriter(java.io.Writer writer)

Sets the internal writer, specifying the output destination. This may be used to route the format of a specific writer to an existing output stream, such as a servlet response - if appropriate to the writer.

Parameters:

writer - the new internal writer