com.northconcepts.datapipeline.foundations.expression

Class CalculatedField

java.lang.Object

com.northconcepts.datapipeline.foundations.core.Bean

com.northconcepts.datapipeline.foundations.core.FoundationObject

com.northconcepts.datapipeline.foundations.expression.CalculatedField

All Implemented Interfaces:

DataExceptionContributor, JsonSerializable, RecordSerializable, XmlSerializable, Serializable

public class CalculatedField
extends FoundationObject

See Also:

Serialized Form

Field Summary

Fields inherited from class com.northconcepts.datapipeline.foundations.core.FoundationObject

internalId, internalName, log, 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
CalculatedField()
CalculatedField(String variable, String expression)
CalculatedField(String variable, String expression, boolean includeInOutcome)

Method Summary

Modifier and Type	Method and Description
DataException	addExceptionProperties(DataException exception) Adds this object's current state to a DataException.
CalculatedField	assertValid()
void	evaluate(DefaultExpressionContext expressionContext)
CalculatedField	fromRecord(Record source) Loads this instance's state from a record and returns this (for fluid API call chaining).
CalculatedField	fromXmlElement(Element element)
Expression	getExpression()
String	getExpressionSource()
String	getVariable()
boolean	isIncludeInOutcome()
CalculatedField	setExpression(Expression expression)
CalculatedField	setIncludeInOutcome(boolean includeInOutcome)
CalculatedField	setVariable(String variable)
Record	toRecord()
Element	toXmlElement(Document document)

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

assertValid, clone, exception, exception, exception, getInternalId, getInternalName, resetInternalId

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

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, getAttribute, getAttribute, getAttribute, getAttribute, getAttribute, getAttribute, getAttribute, getAttribute, getAttribute, getAttribute, getChildElement, getChildElements, newInstanceFromXml, newInstanceFromXml, setAttribute, toXml, toXml, toXml, toXml, toXml, writeXml, writeXml

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

addExceptionProperties, contributeExceptionProperties, contributeExceptionProperties

Constructor Detail

CalculatedField

public CalculatedField()

CalculatedField

public CalculatedField(String variable,
                       String expression)

CalculatedField

public CalculatedField(String variable,
                       String expression,
                       boolean includeInOutcome)

Method Detail

getVariable

public String getVariable()

setVariable

public CalculatedField setVariable(String variable)

getExpression

public Expression getExpression()

getExpressionSource

public String getExpressionSource()

setExpression

public CalculatedField setExpression(Expression expression)

isIncludeInOutcome

public boolean isIncludeInOutcome()

setIncludeInOutcome

public CalculatedField setIncludeInOutcome(boolean includeInOutcome)

assertValid

public CalculatedField assertValid()

Overrides:

assertValid in class FoundationObject

evaluate

public void evaluate(DefaultExpressionContext expressionContext)

addExceptionProperties

public DataException addExceptionProperties(DataException exception)

Description copied from class: FoundationObject

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 FoundationObject

toRecord

public Record toRecord()

Specified by:

toRecord in interface RecordSerializable

Overrides:

toRecord in class Bean

fromRecord

public CalculatedField fromRecord(Record source)

Description copied from interface: RecordSerializable

Loads this instance's state from a record and returns this (for fluid API call chaining). For fluid API call chaining, the overridden method should change the declared return type to its class.

Specified by:

fromRecord in interface RecordSerializable

Overrides:

fromRecord in class Bean

Returns:

this instance.

toXmlElement

public Element toXmlElement(Document document)

fromXmlElement

public CalculatedField fromXmlElement(Element element)