org.metafacture.io

Class ObjectWriter<T>

java.lang.Object

org.metafacture.io.ObjectWriter<T>

Type Parameters:

T - object type

All Implemented Interfaces:

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

@Description(value="Writes objects to stdout or a file")
 @In(value=java.lang.Object.class)
 @Out(value=java.lang.Void.class)
 @FluxCommand(value="write")
public final class ObjectWriter<T>
extends java.lang.Object
implements ConfigurableObjectWriter<T>

Writes objects to stdout or a file

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	STDOUT

Fields inherited from interface org.metafacture.io.ConfigurableObjectWriter

DEFAULT_FOOTER, DEFAULT_HEADER, DEFAULT_SEPARATOR

Constructor Summary

Constructors

Constructor and Description
ObjectWriter(java.lang.String destination) Sets the destination to write objects to.

Method Summary

Modifier and Type	Method and Description
void	closeStream()
static java.util.Collection<java.lang.String>	getArguments() Returns the available arguments.
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	process(T obj)
void	resetStream()
void	setAppendIfFileExists(boolean appendIfFileExists) Controls whether to open files in append mode if they exist.
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 class java.lang.Object

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

Field Detail

STDOUT

public static final java.lang.String STDOUT

See Also:

Constant Field Values

Constructor Detail

ObjectWriter

public ObjectWriter(java.lang.String destination)

Sets the destination to write objects to. If the destination is set to "stdout" the object is written to the standard output. Otherwise it's written to a file of that name.

Parameters:

destination - the path to be written to or standard out if it's "stdout"

Method Detail

getArguments

@ReturnsAvailableArguments
public static java.util.Collection<java.lang.String> getArguments()

Returns the available arguments.

Returns:

arguments

getEncoding

public java.lang.String getEncoding()

Description copied from interface: ConfigurableObjectWriter

Returns the encoding used by the underlying writer.

Specified by:

getEncoding in interface ConfigurableObjectWriter<T>

Returns:

current encoding

setEncoding

public void setEncoding(java.lang.String encoding)

Description copied from interface: ConfigurableObjectWriter

Sets the encoding used by the underlying writer.

Specified by:

setEncoding in interface ConfigurableObjectWriter<T>

Parameters:

encoding - name of the encoding

getCompression

public FileCompression getCompression()

Description copied from interface: ConfigurableObjectWriter

Returns the compression mode.

Specified by:

getCompression in interface ConfigurableObjectWriter<T>

Returns:

current compression mode

setCompression

public void setCompression(FileCompression compression)

Description copied from interface: ConfigurableObjectWriter

Sets the compression mode.

Specified by:

setCompression in interface ConfigurableObjectWriter<T>

Parameters:

compression - type of compression

setCompression

public void setCompression(java.lang.String compression)

Description copied from interface: ConfigurableObjectWriter

Sets the compression mode.

Specified by:

setCompression in interface ConfigurableObjectWriter<T>

Parameters:

compression - type of compression

getHeader

public java.lang.String getHeader()

Description copied from interface: ConfigurableObjectWriter

Returns the header which is output before the first object.

Specified by:

getHeader in interface ConfigurableObjectWriter<T>

Returns:

header string

setHeader

public void setHeader(java.lang.String header)

Description copied from interface: ConfigurableObjectWriter

Sets the header which is output before the first object.

Specified by:

setHeader in interface ConfigurableObjectWriter<T>

Parameters:

header - new header string

getFooter

public java.lang.String getFooter()

Description copied from interface: ConfigurableObjectWriter

Returns the footer which is output after the last object.

Specified by:

getFooter in interface ConfigurableObjectWriter<T>

Returns:

footer string

setFooter

public void setFooter(java.lang.String footer)

Description copied from interface: ConfigurableObjectWriter

Sets the footer which is output after the last object.

Specified by:

setFooter in interface ConfigurableObjectWriter<T>

Parameters:

footer - new footer string

getSeparator

public java.lang.String getSeparator()

Description copied from interface: ConfigurableObjectWriter

Returns the separator which is output between objects.

Specified by:

getSeparator in interface ConfigurableObjectWriter<T>

Returns:

separator string

setSeparator

public void setSeparator(java.lang.String separator)

Description copied from interface: ConfigurableObjectWriter

Sets the separator which is output between objects.

Specified by:

setSeparator in interface ConfigurableObjectWriter<T>

Parameters:

separator - new separator string

setAppendIfFileExists

public void setAppendIfFileExists(boolean appendIfFileExists)

Controls whether to open files in append mode if they exist.

Parameters:

appendIfFileExists - true if new data should be appended, false to overwrite the existing file

See Also:

ObjectFileWriter.setAppendIfFileExists(boolean)

process

public void process(T obj)

Specified by:

process in interface org.metafacture.framework.ObjectReceiver<T>

resetStream

public void resetStream()

Specified by:

resetStream in interface org.metafacture.framework.LifeCycle

closeStream

public void closeStream()

Specified by:

closeStream in interface org.metafacture.framework.LifeCycle