org.metafacture.io

Class ObjectFileWriter<T>

java.lang.Object

org.metafacture.io.AbstractObjectWriter<T>

org.metafacture.io.ObjectFileWriter<T>

Type Parameters:

T - object type

All Implemented Interfaces:

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

@In(value=java.lang.Object.class)
 @FluxCommand(value="write-files")
public final class ObjectFileWriter<T>
extends AbstractObjectWriter<T>

Field Summary

Fields inherited from interface org.metafacture.io.ConfigurableObjectWriter

DEFAULT_FOOTER, DEFAULT_HEADER, DEFAULT_SEPARATOR

Constructor Summary

Constructors

Constructor and Description
ObjectFileWriter(java.lang.String path) Sets the destination of a file to write objects to.

Method Summary

Modifier and Type	Method and Description
void	closeStream()
FileCompression	getCompression() Returns the compression mode.
java.lang.String	getEncoding() Returns the encoding used by the underlying writer.
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.

Methods inherited from class org.metafacture.io.AbstractObjectWriter

getFooter, getHeader, getSeparator, setFooter, setHeader, setSeparator

Methods inherited from class java.lang.Object

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

Constructor Detail

ObjectFileWriter

public ObjectFileWriter(java.lang.String path)

Sets the destination of a file to write objects to.

Parameters:

path - the path to be written to

Method Detail

getEncoding

public java.lang.String getEncoding()

Description copied from interface: ConfigurableObjectWriter

Returns the encoding used by the underlying writer.

Returns:

current encoding

setEncoding

public void setEncoding(java.lang.String encoding)

Description copied from interface: ConfigurableObjectWriter

Sets the encoding used by the underlying writer.

Parameters:

encoding - name of the encoding

getCompression

public FileCompression getCompression()

Description copied from interface: ConfigurableObjectWriter

Returns the compression mode.

Returns:

current compression mode

setCompression

public void setCompression(FileCompression compression)

Description copied from interface: ConfigurableObjectWriter

Sets the compression mode.

Parameters:

compression - type of compression

setCompression

public void setCompression(java.lang.String compression)

Description copied from interface: ConfigurableObjectWriter

Sets the compression mode.

Parameters:

compression - type of compression

process

public void process(T obj)

resetStream

public void resetStream()

closeStream

public void closeStream()

setAppendIfFileExists

public void setAppendIfFileExists(boolean appendIfFileExists)

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

The default value is false.

This property can be changed anytime during processing. It becomes effective the next time a new output file is opened.

Parameters:

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