com.northconcepts.datapipeline.foundations.core

Class FoundationObject

java.lang.Object

com.northconcepts.datapipeline.foundations.core.Bean

com.northconcepts.datapipeline.foundations.core.FoundationObject

All Implemented Interfaces:

DataExceptionContributor, JsonSerializable, RecordSerializable, XmlSerializable, Serializable

Direct Known Subclasses:

CalculatedField, DataMappingObject, Dataset, DecisionTableObject, DecisionTreeObject, JdbcConnection, JdbcSchema, PipelineObject, SchemaObject

public abstract class FoundationObject
extends Bean

Abstract super-class for DP Foundation classes that require a consistent error handling mechanism.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected long	internalId
protected String	internalName
static Logger	log
protected static SimpleDateFormat	TIMESTAMP_FORMAT

Fields inherited from interface com.northconcepts.datapipeline.core.RecordSerializable

SERIALIZED_CLASS_NAME, TYPE

Fields inherited from interface com.northconcepts.datapipeline.core.XmlSerializable

XML_SERIALIZED_CLASS_NAME

Constructor Summary

Constructors

Constructor and Description
FoundationObject()

Method Summary

Modifier and Type	Method and Description
DataException	addExceptionProperties(DataException exception) Adds this object's current state to a DataException.
FoundationObject	assertValid()
protected FoundationObject	assertValid(Collection<? extends FoundationObject> objects)
protected FoundationObject	clone()
DataException	exception(String message) Creates an exception with the specified message and containing this endpoint's properties (name-value pairs).
DataException	exception(String message, Throwable exception) Converts an exception to a DataException, prefixing the original message with the specified text and adding this endpoint's properties (name-value pairs).
DataException	exception(Throwable exception) Converts an exception to a DataException and adds this endpoint's properties (name-value pairs).
long	getInternalId() The auto numbered ID of this instance.
String	getInternalName() The name of this instance (-).
static long	resetInternalId()

Methods inherited from class com.northconcepts.datapipeline.foundations.core.Bean

fromRecord, toRecord, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.northconcepts.datapipeline.core.RecordSerializable

fromArrayValue, fromArrayValue, fromArrayValue, fromJson, fromJson, newInstanceFromRecord, newInstanceFromRecord, toArrayValue, toJson, toJson, toJson, toRecord

Methods inherited from interface com.northconcepts.datapipeline.core.JsonSerializable

newInstanceFromJson

Methods inherited from interface com.northconcepts.datapipeline.core.XmlSerializable

forEachGrandChildElement, fromXml, fromXml, fromXmlElement, getAttribute, getAttribute, getAttribute, getAttribute, getAttribute, getAttribute, getAttribute, getAttribute, getAttribute, getAttribute, getChildElement, getChildElements, newInstanceFromXml, newInstanceFromXml, setAttribute, toXml, toXml, toXml, toXml, toXml, toXmlElement, writeXml, writeXml

Methods inherited from interface com.northconcepts.datapipeline.core.DataExceptionContributor

addExceptionProperties, contributeExceptionProperties, contributeExceptionProperties

Field Detail

log

public static final Logger log

TIMESTAMP_FORMAT

protected static final SimpleDateFormat TIMESTAMP_FORMAT

internalId

protected long internalId

internalName

protected String internalName

Constructor Detail

FoundationObject

public FoundationObject()

Method Detail

resetInternalId

public static long resetInternalId()

clone

protected FoundationObject clone()
                          throws CloneNotSupportedException

Overrides:

clone in class Object

Throws:

CloneNotSupportedException

getInternalId

public final long getInternalId()

The auto numbered ID of this instance.

getInternalName

public final String getInternalName()

The name of this instance (-).

addExceptionProperties

public DataException addExceptionProperties(DataException exception)

Adds this object'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.

Specified by:

addExceptionProperties in interface DataExceptionContributor

Overrides:

addExceptionProperties in class Bean

exception

public DataException exception(String message,
                               Throwable exception)

Converts an exception to a DataException, prefixing the original message with the specified text and adding this endpoint's properties (name-value pairs).

The returned exception can then be thrown in the normal way.

If the supplied exception is an instanceof DataException, it will be returned, otherwise it will be nested inside a DataException. In either case the result message will contain the new prefix along with this endpoint properties.

exception

public DataException exception(Throwable exception)

Converts an exception to a DataException and adds this endpoint's properties (name-value pairs).

The returned exception can then be thrown in the normal way.

If the supplied exception is an instanceof DataException, it will be returned, otherwise it will be nested inside a DataException. In either case the result message will contain this endpoint properties.

exception

public DataException exception(String message)

Creates an exception with the specified message and containing this endpoint's properties (name-value pairs).

The returned exception can then be thrown in the normal way.

assertValid

public FoundationObject assertValid()

assertValid

protected FoundationObject assertValid(Collection<? extends FoundationObject> objects)