org.metafacture.io

Interface ConfigurableObjectWriter<T>

Type Parameters:

T - object type

All Superinterfaces:

org.metafacture.framework.LifeCycle, org.metafacture.framework.ObjectReceiver<T>, org.metafacture.framework.Receiver

All Known Implementing Classes:

AbstractObjectWriter, ObjectFileWriter, ObjectStdoutWriter, ObjectWriter

public interface ConfigurableObjectWriter<T>
extends org.metafacture.framework.ObjectReceiver<T>

Back end implementations for ObjectWriter should offer a default set of configuration options. These are defined by this interface.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_FOOTER
static java.lang.String	DEFAULT_HEADER
static java.lang.String	DEFAULT_SEPARATOR

Method Summary

Modifier and Type	Method and Description
FileCompression	getCompression() Returns the compression mode.
java.lang.String	getEncoding() Returns the encoding used by the underlying writer.
java.lang.String	getFooter() Returns the footer which is output after the last object.
java.lang.String	getHeader() Returns the header which is output before the first object.
java.lang.String	getSeparator() Returns the separator which is output between objects.
void	setCompression(FileCompression compression) Sets the compression mode.
void	setCompression(java.lang.String compression) Sets the compression mode.
void	setEncoding(java.lang.String encoding) Sets the encoding used by the underlying writer.
void	setFooter(java.lang.String footer) Sets the footer which is output after the last object.
void	setHeader(java.lang.String header) Sets the header which is output before the first object.
void	setSeparator(java.lang.String separator) Sets the separator which is output between objects.

Methods inherited from interface org.metafacture.framework.ObjectReceiver

process

Methods inherited from interface org.metafacture.framework.LifeCycle

closeStream, resetStream

Field Detail

DEFAULT_HEADER

static final java.lang.String DEFAULT_HEADER

See Also:

Constant Field Values

DEFAULT_FOOTER

static final java.lang.String DEFAULT_FOOTER

See Also:

Constant Field Values

DEFAULT_SEPARATOR

static final java.lang.String DEFAULT_SEPARATOR

See Also:

Constant Field Values

Method Detail

getEncoding

java.lang.String getEncoding()

Returns the encoding used by the underlying writer.

Returns:

current encoding

setEncoding

void setEncoding(java.lang.String encoding)

Sets the encoding used by the underlying writer.

Parameters:

encoding - name of the encoding

getCompression

FileCompression getCompression()

Returns the compression mode.

Returns:

current compression mode

setCompression

void setCompression(FileCompression compression)

Sets the compression mode.

Parameters:

compression - type of compression

setCompression

void setCompression(java.lang.String compression)

Sets the compression mode.

Parameters:

compression - type of compression

getHeader

java.lang.String getHeader()

Returns the header which is output before the first object.

Returns:

header string

setHeader

void setHeader(java.lang.String header)

Sets the header which is output before the first object.

Parameters:

header - new header string

getFooter

java.lang.String getFooter()

Returns the footer which is output after the last object.

Returns:

footer string

setFooter

void setFooter(java.lang.String footer)

Sets the footer which is output after the last object.

Parameters:

footer - new footer string

getSeparator

java.lang.String getSeparator()

Returns the separator which is output between objects.

Returns:

separator string

setSeparator

void setSeparator(java.lang.String separator)

Sets the separator which is output between objects.

Parameters:

separator - new separator string