org.metafacture.formatting

Class StreamLiteralFormatter

java.lang.Object

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

org.metafacture.framework.helpers.DefaultStreamPipe<org.metafacture.framework.ObjectReceiver<java.lang.String>>

org.metafacture.formatting.StreamLiteralFormatter

All Implemented Interfaces:

org.metafacture.framework.LifeCycle, org.metafacture.framework.Receiver, org.metafacture.framework.Sender<org.metafacture.framework.ObjectReceiver<java.lang.String>>, org.metafacture.framework.StreamPipe<org.metafacture.framework.ObjectReceiver<java.lang.String>>, org.metafacture.framework.StreamReceiver

@Description(value="Outputs the name and value of each literal which is received as a string. Name and value are separated by a separator string. The default separator string is a tab. If a literal name is empty, only the value will be output without a separator. The module ignores record and entity events. In particular, this means that literal names are not prefixed by the name of the entity which contains them.")
 @In(value=org.metafacture.framework.StreamReceiver.class)
 @Out(value=java.lang.String.class)
 @FluxCommand(value="encode-literals")
public final class StreamLiteralFormatter
extends org.metafacture.framework.helpers.DefaultStreamPipe<org.metafacture.framework.ObjectReceiver<java.lang.String>>

Emits the name and value of each literal which is received as a string. Name and value are separated by a separator string. The default separator string is a tab. If a literal name is empty, only the value will be output without a separator.

The module ignores record and entity events. This means that literal names are not prefixed by the name of the entity which contains them.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_SEPARATOR The default value for setSeparator(String).

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
java.lang.String	getSeparator() Gets the separator.
void	literal(java.lang.String name, java.lang.String value)
void	setSeparator(java.lang.String separator) Sets the separator between the literal name and value.

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

endEntity, endRecord, startEntity, startRecord

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

Field Detail

DEFAULT_SEPARATOR

public static final java.lang.String DEFAULT_SEPARATOR

The default value for setSeparator(String).

See Also:

Constant Field Values

Constructor Detail

StreamLiteralFormatter

public StreamLiteralFormatter()

Creates an instance of StreamLiteralFormatter.

Method Detail

setSeparator

public void setSeparator(java.lang.String separator)

Sets the separator between the literal name and value. The separator is only added if the literal name is not empty.

The default separator is “DEFAULT_SEPARATOR”.

The parameter can be changed at any time during processing. It becomes effective with the next literal received.

Parameters:

separator - the separator string.

getSeparator

public java.lang.String getSeparator()

Gets the separator.

Returns:

the separator

literal

public void literal(java.lang.String name,
                    java.lang.String value)

Specified by:

literal in interface org.metafacture.framework.StreamReceiver

Overrides:

literal in class org.metafacture.framework.helpers.DefaultStreamPipe<org.metafacture.framework.ObjectReceiver<java.lang.String>>