com.northconcepts.datapipeline.core

Class SequenceWriter

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.ProxyWriter

com.northconcepts.datapipeline.core.SequenceWriter

public class SequenceWriter
extends ProxyWriter

Writes to sequence of data writers created by a factory in turn and rolled based on a ISequenceStrategy policy. Each writer is closed when the ISequenceStrategy indicates it sholud end and a new one is created by the factory.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SequenceWriter.DataWriterFactory
static class	SequenceWriter.ElapsedTimeSequenceStrategy
static interface	SequenceWriter.ISequenceStrategy
static class	SequenceWriter.OrSequenceStrategy
static class	SequenceWriter.RecordCountSequenceStrategy
static class	SequenceWriter.SchedulerSequenceStrategy
static class	SequenceWriter.Sequence

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

DataEndpoint.State

Field Summary

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
SequenceWriter(SequenceWriter.ISequenceStrategy strategy, SequenceWriter.DataWriterFactory factory)

Method Summary

Modifier and Type	Method and Description
DataException	addExceptionProperties(DataException exception) Adds this endpoint's current state to a DataException.
protected void	afterSequenceCreated()
protected void	afterSequenceFinished()
protected void	beforeSequenceCreated()
void	close() Indicates that this endpoint has finished reading or writing.
SequenceWriter.Sequence	getCurrentSequence() Returns the current Sequence in use by this writer, null if it hasn't started writing, or the last sequence if it has finished writing.
SequenceWriter.DataWriterFactory	getFactory()
long	getSequenceCount() Deprecated. use getSequencesStarted() instead The number of sequences created by this writer (alias for getSequencesStarted()).
long	getSequencesFinished()
long	getSequencesStarted()
SequenceWriter.ISequenceStrategy	getStrategy()
protected void	writeImpl(Record record) Overridden by subclasses to write the specified record to this DataWriter.

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

available, getNestedWriter, interceptRecord, map, map, open, setNestedDataWriter, setNestedDataWriter

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

getNestedEndpoint, getRootEndpoint, getRootWriter, 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

Constructor Detail

SequenceWriter

public SequenceWriter(SequenceWriter.ISequenceStrategy strategy,
                      SequenceWriter.DataWriterFactory factory)

Method Detail

getStrategy

public SequenceWriter.ISequenceStrategy getStrategy()

getFactory

public SequenceWriter.DataWriterFactory getFactory()

getSequencesStarted

public long getSequencesStarted()

getSequencesFinished

public long getSequencesFinished()

getSequenceCount

@Deprecated
public long getSequenceCount()

Deprecated. use getSequencesStarted() instead The number of sequences created by this writer (alias for getSequencesStarted()).

getCurrentSequence

public SequenceWriter.Sequence getCurrentSequence()

Returns the current Sequence in use by this writer, null if it hasn't started writing, or the last sequence if it has finished writing.

writeImpl

protected void writeImpl(Record record)
                  throws Throwable

Description copied from class: DataWriter

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

Overrides:

writeImpl in class ProxyWriter

Throws:

Throwable

beforeSequenceCreated

protected void beforeSequenceCreated()

afterSequenceCreated

protected void afterSequenceCreated()

afterSequenceFinished

protected void afterSequenceFinished()

close

public void close()
           throws DataException

Description copied from class: DataEndpoint

Indicates that this endpoint has finished reading or writing.

Overrides:

close in class ProxyWriter

Throws:

DataException

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 ProxyWriter