com.northconcepts.datapipeline.core

Class DataWriter

java.lang.Object

com.northconcepts.datapipeline.core.DataObject

com.northconcepts.datapipeline.core.Endpoint

com.northconcepts.datapipeline.core.DataEndpoint

com.northconcepts.datapipeline.core.DataWriter

Direct Known Subclasses:

AbstractWriter, CollectionWriter, EventBusWriter, FileWriter, IntegrationWriter, JdbcUpsertWriter, JdbcWriter, JmsWriter, MapWriter, MemoryWriter, MultiWriter, NullWriter, PipedWriter, ProxyWriter, SplitWriter, StreamWriter, TailWriter, TextStreamWriter

public abstract class DataWriter
extends DataEndpoint

Abstract super-class for writing records. The only method that a subclass must implement is writeImpl(Record), however, most subclasses will also override DataEndpoint.open() and DataEndpoint.close().

Nested Class Summary

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
DataWriter()

Method Summary

Modifier and Type	Method and Description
DataException	addExceptionProperties(DataException exception) Adds this endpoint's current state to a DataException.
int	available() Returns the number of records that can probably be written without blocking.
DataWriter	getNestedEndpoint() Returns the Endpoint held inside this one or null if there isn't one.
DataWriter	getNestedWriter() Returns the DataWriter held inside this one or null if there isn't one.
DataWriter	getRootEndpoint() Returns the deepest, nested Endpoint held inside this one, otherwise this instance is returned if there aren't any nested Endpoints.
DataWriter	getRootWriter() Returns the deepest, nested DataWriter held inside this one, otherwise this instance is returned if there aren't any nested DataWriters.
<T extends DataWriter> T	getWriter(Class<T> type) Returns the first DataWriter of the specified type held inside this one or null if there isn't one.
void	write(Record record) Writes the specified record to this DataWriter and increases the record-count by 1.
protected abstract void	writeImpl(Record record) Overridden by subclasses to write the specified record to this DataWriter.

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

close, decrementRecordCount, enableJmx, getLastRecord, getRecordCount, getRecordCountAsBigInteger, getRecordCountAsString, incrementRecordCount, isRecordCountBigInteger, open, 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

DataWriter

public DataWriter()

Method Detail

getNestedEndpoint

public DataWriter getNestedEndpoint()

Description copied from class: Endpoint

Returns the Endpoint held inside this one or null if there isn't one.

Overrides:

getNestedEndpoint in class DataEndpoint

getRootEndpoint

public DataWriter getRootEndpoint()

Description copied from class: Endpoint

Returns the deepest, nested Endpoint held inside this one, otherwise this instance is returned if there aren't any nested Endpoints.

Overrides:

getRootEndpoint in class DataEndpoint

getNestedWriter

public DataWriter getNestedWriter()

Returns the DataWriter held inside this one or null if there isn't one.

getWriter

public <T extends DataWriter> T getWriter(Class<T> type)

Returns the first DataWriter of the specified type held inside this one or null if there isn't one.

getRootWriter

public DataWriter getRootWriter()

Returns the deepest, nested DataWriter held inside this one, otherwise this instance is returned if there aren't any nested DataWriters.

available

public int available()
              throws DataException

Returns the number of records that can probably be written without blocking.

Throws:

DataException

writeImpl

protected abstract void writeImpl(Record record)
                           throws Throwable

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

Throws:

Throwable

write

public void write(Record record)
           throws DataException

Writes the specified record to this DataWriter and increases the record-count by 1. Any exception raised while writing will be converted to a DataException using DataObject.exception(Throwable).

Subclasses generally do not need to override this method, instead they should implement writeImpl(Record).

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 DataEndpoint