org.metafacture.io

Class FileOpener

java.lang.Object

org.metafacture.framework.helpers.DefaultSender<R>

org.metafacture.framework.helpers.DefaultObjectPipe<java.lang.String,org.metafacture.framework.ObjectReceiver<java.io.Reader>>

org.metafacture.io.FileOpener

All Implemented Interfaces:

org.metafacture.framework.LifeCycle, org.metafacture.framework.ObjectPipe<java.lang.String,org.metafacture.framework.ObjectReceiver<java.io.Reader>>, org.metafacture.framework.ObjectReceiver<java.lang.String>, org.metafacture.framework.Receiver, org.metafacture.framework.Sender<org.metafacture.framework.ObjectReceiver<java.io.Reader>>

@Description(value="Opens a file.")
 @In(value=java.lang.String.class)
 @Out(value=java.io.Reader.class)
 @FluxCommand(value="open-file")
public final class FileOpener
extends org.metafacture.framework.helpers.DefaultObjectPipe<java.lang.String,org.metafacture.framework.ObjectReceiver<java.io.Reader>>

Opens a file and passes a reader for it to the receiver.

Constructor Summary

Constructors

Constructor and Description
FileOpener() Creates an instance of FileOpener.

Method Summary

Modifier and Type	Method and Description
FileCompression	getCompression() Gets the file compression.
boolean	getDecompressConcatenated() Checks whether the file compression is set to decompress concatenated.
java.lang.String	getEncoding() Returns the encoding used to open the resource.
java.io.Reader	open(java.io.InputStream stream) Opens a file stream.
java.io.Reader	open(java.lang.String file) Opens a file.
void	process(java.lang.String file)
void	setCompression(FileCompression compression) Sets the compression of the file.
void	setCompression(java.lang.String compression) Sets the compression of the file.
void	setDecompressConcatenated(boolean decompressConcatenated) Flags whether to use decompress concatenated file compression.
void	setEncoding(java.lang.String encoding) Sets the encoding used to open the resource.

Methods inherited from class org.metafacture.framework.helpers.DefaultSender

closeStream, getReceiver, isClosed, onCloseStream, onResetStream, onSetReceiver, resetStream, setReceiver

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.metafacture.framework.LifeCycle

closeStream, resetStream

Methods inherited from interface org.metafacture.framework.Sender

setReceiver

Constructor Detail

FileOpener

public FileOpener()

Creates an instance of FileOpener.

Method Detail

getEncoding

public java.lang.String getEncoding()

Returns the encoding used to open the resource.

Returns:

current default setting

setEncoding

public void setEncoding(java.lang.String encoding)

Sets the encoding used to open the resource.

Parameters:

encoding - new encoding

getCompression

public FileCompression getCompression()

Gets the file compression.

Returns:

the FileCompression

setCompression

public void setCompression(FileCompression compression)

Sets the compression of the file.

Parameters:

compression - the FileCompression

setCompression

public void setCompression(java.lang.String compression)

Sets the compression of the file.

Parameters:

compression - the name of the compression

getDecompressConcatenated

public boolean getDecompressConcatenated()

Checks whether the file compression is set to decompress concatenated.

Returns:

true if file compression should be decompresses concatenated

setDecompressConcatenated

public void setDecompressConcatenated(boolean decompressConcatenated)

Flags whether to use decompress concatenated file compression.

Parameters:

decompressConcatenated - true if file compression should decompress concatenated

open

public java.io.Reader open(java.lang.String file)
                    throws java.io.IOException

Opens a file.

Parameters:

file - the file

Returns:

a Reader

Throws:

java.io.IOException - if an I/O error occurs

open

public java.io.Reader open(java.io.InputStream stream)
                    throws java.io.IOException

Opens a file stream.

Parameters:

stream - the stream

Returns:

a Reader

Throws:

java.io.IOException - if an I/O error occurs

process

public void process(java.lang.String file)

Specified by:

process in interface org.metafacture.framework.ObjectReceiver<java.lang.String>

Overrides:

process in class org.metafacture.framework.helpers.DefaultObjectPipe<java.lang.String,org.metafacture.framework.ObjectReceiver<java.io.Reader>>