stream.io

Class AbstractWriter

java.lang.Object

stream.AbstractProcessor

stream.ConditionedProcessor

stream.io.AbstractWriter

All Implemented Interfaces:

Processor, StatefulProcessor

Direct Known Subclasses:

BinaryWriter, CsvWriter, DataObjectWriter, JSONWriter

public abstract class AbstractWriter
extends ConditionedProcessor

Author:

chris

Field Summary

Fields

Modifier and Type	Field and Description
protected Keys	keys
(package private) String	url

Fields inherited from class stream.ConditionedProcessor

condition

Fields inherited from class stream.AbstractProcessor

context

Constructor Summary

Constructors

Constructor and Description
AbstractWriter()

Method Summary

Modifier and Type	Method and Description
Keys	getKeys()
String	getUrl()
Data	processMatchingData(Data data)
protected Set<String>	selectedKeys(Data item) This class returns the keys that need to be written based on the selection pattern.
void	setKeys(Keys keys)
void	setUrl(String url)
abstract void	write(Data item) This method is actually responsible for writing the data item to the output stream in the format that the implementing class supports.

Methods inherited from class stream.ConditionedProcessor

getCondition, matches, process, setCondition

Methods inherited from class stream.AbstractProcessor

finish, init, resetState

Methods inherited from class java.lang.Object

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

Field Detail

url

String url

keys

protected Keys keys

Constructor Detail

AbstractWriter

public AbstractWriter()

Method Detail

processMatchingData

public Data processMatchingData(Data data)

Specified by:

processMatchingData in class ConditionedProcessor

See Also:

ConditionedProcessor.processMatchingData(stream.Data)

getKeys

public Keys getKeys()

Returns:

the keys

setKeys

@Parameter(description="The keys, which shall be written out (supports wildcards *, ? and negation with !",
           defaultValue="*")
public void setKeys(Keys keys)

Parameters:

keys - the keys to set

getUrl

public String getUrl()

Returns:

the url

setUrl

@Parameter(description="The URL to write to, currently, only file URLs are supported.",
           required=true)
public void setUrl(String url)

Parameters:

url - the url to set

selectedKeys

protected Set<String> selectedKeys(Data item)

This class returns the keys that need to be written based on the selection pattern.

Parameters:

item - The item to extract keys from.

Returns:

The keys matching the selection pattern.

write

public abstract void write(Data item)
                    throws Exception

This method is actually responsible for writing the data item to the output stream in the format that the implementing class supports.

Parameters:

item -

Throws:

Exception