com.northconcepts.datapipeline.core

Class DataEndpoint

java.lang.Object

com.northconcepts.datapipeline.core.DataObject

com.northconcepts.datapipeline.core.Endpoint

com.northconcepts.datapipeline.core.DataEndpoint

Direct Known Subclasses:

DataEndpointGroup, DataReader, DataWriter, RecordBuffer, Window

public abstract class DataEndpoint
extends Endpoint

Abstract super-class for reading and writing records. Common operations like open(), close(), and getRecordCount() are defined here.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DataEndpoint.State

Field Summary

Fields

Modifier and Type	Field and Description
protected Record	lastRecord
static String	PRODUCT
static String	PRODUCT_VERSION
static String	VENDOR
protected static String	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
DataEndpoint()

Method Summary

Modifier and Type	Method and Description
DataException	addExceptionProperties(DataException exception) Adds this endpoint's current state to a DataException.
void	close() Indicates that this endpoint has finished reading or writing.
protected void	decrementRecordCount() Reduces this endpoint's record-count by 1.
static void	enableJmx() Turns JMX (Java Management Extensions) monitoring & management on and exposes running Jobs and EventBuses as managed beans.
Record	getLastRecord() Returns the most recent record seen by this endpoint while it is open or null.
DataEndpoint	getNestedEndpoint() Returns the Endpoint held inside this one or null if there isn't one.
long	getRecordCount() Returns this endpoint's record-count as a long.
BigInteger	getRecordCountAsBigInteger() Returns this endpoint's record-count as a BigInteger.
String	getRecordCountAsString() Returns this endpoint's record-count as a String.
DataEndpoint	getRootEndpoint() Returns the deepest, nested Endpoint held inside this one, otherwise this instance is returned if there aren't any nested Endpoints.
protected void	incrementRecordCount() Increases this endpoint's record-count by 1.
boolean	isRecordCountBigInteger() Indicates if this endpoint's record-count is too big (over 1000000000000000000L or 1.0e+18) for a long and should be retrieved as a BigInteger using getRecordCountAsBigInteger().
void	open() Makes this endpoint ready for reading or writing.
protected void	resetRecordCount() Restarts this endpoint's record-count at 0.
String	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

VENDOR

public static final String VENDOR

See Also:

Constant Field Values

PRODUCT

public static final String PRODUCT

See Also:

Constant Field Values

PRODUCT_VERSION

public static final String PRODUCT_VERSION

See Also:

Constant Field Values

XML_INPUT_FACTORY_KEY

protected static final String XML_INPUT_FACTORY_KEY

See Also:

Constant Field Values

lastRecord

protected Record lastRecord

Constructor Detail

DataEndpoint

public DataEndpoint()

Method Detail

getNestedEndpoint

public DataEndpoint getNestedEndpoint()

Description copied from class: Endpoint

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

Overrides:

getNestedEndpoint in class Endpoint

getRootEndpoint

public DataEndpoint 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 Endpoint

getLastRecord

public Record getLastRecord()

Returns the most recent record seen by this endpoint while it is open or null.

open

public void open()
          throws DataException

Makes this endpoint ready for reading or writing.

Overrides:

open in class Endpoint

Throws:

DataException

close

public void close()
           throws DataException

Indicates that this endpoint has finished reading or writing.

Overrides:

close in class Endpoint

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 Endpoint

toString

public String toString()

Overrides:

toString in class Endpoint

incrementRecordCount

protected void incrementRecordCount()

Increases this endpoint's record-count by 1.

See Also:

getRecordCountAsBigInteger(), getRecordCount(), isRecordCountBigInteger()

decrementRecordCount

protected void decrementRecordCount()

Reduces this endpoint's record-count by 1.

See Also:

getRecordCountAsBigInteger(), getRecordCount(), isRecordCountBigInteger()

resetRecordCount

protected void resetRecordCount()

Restarts this endpoint's record-count at 0.

See Also:

getRecordCountAsBigInteger(), getRecordCount(), isRecordCountBigInteger()

isRecordCountBigInteger

public boolean isRecordCountBigInteger()

Indicates if this endpoint's record-count is too big (over 1000000000000000000L or 1.0e+18) for a long and should be retrieved as a BigInteger using getRecordCountAsBigInteger().

See Also:

getRecordCountAsBigInteger(), getRecordCount()

getRecordCount

public long getRecordCount()

Returns this endpoint's record-count as a long. If the count grows above 1000000000000000000L or 1.0e+18, it will wrap to 1, but getRecordCountAsBigInteger() will contain the full value.

See Also:

getRecordCountAsBigInteger(), isRecordCountBigInteger()

getRecordCountAsBigInteger

public BigInteger getRecordCountAsBigInteger()

Returns this endpoint's record-count as a BigInteger.

See Also:

getRecordCount(), isRecordCountBigInteger()

getRecordCountAsString

public String getRecordCountAsString()

Returns this endpoint's record-count as a String.

See Also:

getRecordCountAsBigInteger(), getRecordCount(), isRecordCountBigInteger()

enableJmx

public static void enableJmx()

Turns JMX (Java Management Extensions) monitoring & management on and exposes running Jobs and EventBuses as managed beans.