com.northconcepts.datapipeline.core

Class MultiWriter

java.lang.Object

com.northconcepts.datapipeline.core.DataObject

com.northconcepts.datapipeline.core.Endpoint

com.northconcepts.datapipeline.core.DataEndpoint

com.northconcepts.datapipeline.core.DataWriter

com.northconcepts.datapipeline.core.MultiWriter

public class MultiWriter
extends DataWriter

Writes records to multiple DataWriter.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MultiWriter.AvailableCapacityWriteStrategy Writes each record to a single writer by choosing the one with the highest available capacity (DataWriter.available() If all writers have identical capacities, this strategy behaves like MultiWriter.RoundRobinWriteStrategy and writes to each writer in turn.
static class	MultiWriter.ReplicateCloneWriteStrategy Writes a clone (to prevent side effects) of each record to all writers.
static class	MultiWriter.ReplicateWriteStrategy Writes each record to all writers.
static class	MultiWriter.RoundRobinWriteStrategy Divides records evenly between all writers by cycling through the list and writing each record to a single writer in turn.
static class	MultiWriter.WriteStrategy

Nested classes/interfaces inherited from class com.northconcepts.datapipeline.core.DataEndpoint

DataEndpoint.State

Field Summary

Fields

Modifier and Type	Field and Description
static MultiWriter.WriteStrategy	REPLICATE See MultiWriter.ReplicateWriteStrategy
static MultiWriter.WriteStrategy	REPLICATE_CLONE See MultiWriter.ReplicateCloneWriteStrategy

Fields inherited from class com.northconcepts.datapipeline.core.DataEndpoint

lastRecord, PRODUCT, PRODUCT_VERSION, VENDOR, XML_INPUT_FACTORY_KEY

Fields inherited from class com.northconcepts.datapipeline.core.Endpoint

BUFFER_SIZE, captureElapsedTime, DEFAULT_READ_BUFFER_SIZE

Fields inherited from class com.northconcepts.datapipeline.core.DataObject

id, log, name, TIMESTAMP_FORMAT

Constructor Summary

Constructors

Constructor and Description
MultiWriter()
MultiWriter(DataWriter... sinks)
MultiWriter(MultiWriter.WriteStrategy writeStrategy)

Method Summary

Modifier and Type	Method and Description
MultiWriter	add(DataWriter... sinks)
DataException	addExceptionProperties(DataException exception) Adds this endpoint's current state to a DataException.
void	close() Indicates that this endpoint has finished reading or writing.
DataEndpoint	get(int index)
int	getCount()
MultiWriter.WriteStrategy	getWriteStrategy()
void	open() Makes this endpoint ready for reading or writing.
MultiWriter	remove(DataWriter sink)
MultiWriter	removeAllDataSink()
MultiWriter	setWriteStrategy(MultiWriter.WriteStrategy writeStrategy)
protected void	writeImpl(Record record) Overridden by subclasses to write the specified record to this DataWriter.

Methods inherited from class com.northconcepts.datapipeline.core.DataWriter

available, getNestedEndpoint, getNestedWriter, getRootEndpoint, getRootWriter, getWriter, write

Methods inherited from class com.northconcepts.datapipeline.core.DataEndpoint

decrementRecordCount, enableJmx, getLastRecord, getRecordCount, getRecordCountAsBigInteger, getRecordCountAsString, incrementRecordCount, isRecordCountBigInteger, resetRecordCount, toString

Methods inherited from class com.northconcepts.datapipeline.core.Endpoint

addElapsedtime, assertClosed, assertNotOpened, assertOpened, finalize, getClosedOn, getDescription, getElapsedTime, getElapsedTimeAsString, getOpenedOn, getOpenElapsedTime, getOpenElapsedTimeAsString, getSelfTime, getSelfTimeAsString, getState, isCaptureElapsedTime, isClosed, isOpen, setCaptureElapsedTime, setDescription

Methods inherited from class com.northconcepts.datapipeline.core.DataObject

exception, exception, exception, getId, getName, resetID

Methods inherited from class java.lang.Object

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

Field Detail

REPLICATE

public static final MultiWriter.WriteStrategy REPLICATE

See MultiWriter.ReplicateWriteStrategy

REPLICATE_CLONE

public static final MultiWriter.WriteStrategy REPLICATE_CLONE

See MultiWriter.ReplicateCloneWriteStrategy

Constructor Detail

MultiWriter

public MultiWriter()

MultiWriter

public MultiWriter(MultiWriter.WriteStrategy writeStrategy)

MultiWriter

public MultiWriter(DataWriter... sinks)

Method Detail

getWriteStrategy

public MultiWriter.WriteStrategy getWriteStrategy()

setWriteStrategy

public MultiWriter setWriteStrategy(MultiWriter.WriteStrategy writeStrategy)

add

public MultiWriter add(DataWriter... sinks)

getCount

public int getCount()

remove

public MultiWriter remove(DataWriter sink)

removeAllDataSink

public MultiWriter removeAllDataSink()

get

public DataEndpoint get(int index)

open

public void open()
          throws DataException

Description copied from class: DataEndpoint

Makes this endpoint ready for reading or writing.

Overrides:

open in class DataEndpoint

Throws:

DataException

close

public void close()
           throws DataException

Description copied from class: DataEndpoint

Indicates that this endpoint has finished reading or writing.

Overrides:

close in class DataEndpoint

Throws:

DataException

writeImpl

protected void writeImpl(Record record)
                  throws Throwable

Description copied from class: DataWriter

Overridden by subclasses to write the specified record to this DataWriter.

Specified by:

writeImpl in class DataWriter

Throws:

Throwable

addExceptionProperties

public DataException addExceptionProperties(DataException exception)

Description copied from class: Endpoint

Adds this endpoint's current state to a DataException. Since this method is called whenever an exception is thrown, subclasses should override it to add their specific information.

Overrides:

addExceptionProperties in class DataWriter