com.northconcepts.datapipeline.foundations.schema

Class NumericFieldDef

java.lang.Object

com.northconcepts.datapipeline.foundations.core.Bean

com.northconcepts.datapipeline.foundations.core.FoundationObject

com.northconcepts.datapipeline.foundations.schema.SchemaObject

com.northconcepts.datapipeline.foundations.schema.FieldDef

com.northconcepts.datapipeline.foundations.schema.NumericFieldDef

All Implemented Interfaces:

JsonSerializable, RecordSerializable, XmlSerializable, Serializable

public class NumericFieldDef
extends FieldDef

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected DecimalFormat	patternFormat

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
NumericFieldDef()
NumericFieldDef(String name, FieldType type)

Method Summary

Modifier and Type	Method and Description
NumericFieldDef	fromRecord(Record source) Loads this instance's state from a record and returns this (for fluid API call chaining).
NumericFieldDef	fromXmlElement(Element fieldDefElement)
Number	getMaximum() The optional largest number allowed in values of this field.
Number	getMinimum() The optional smallest number allowed in values of this field.
String	getPattern() The optional numeric pattern to use when parsing incoming values (from currency, percentage, etc.) during mapping.
Integer	getPrecision() The optional numeric precision -- currently unused.
Integer	getScale() The optional numeric scale -- currently unused.
protected Object	mapValueImpl(Object value)
NumericFieldDef	setAllowedValues(ValueMatch<?> allowedValues)
NumericFieldDef	setDescription(String description)
NumericFieldDef	setDisplayName(String displayName)
NumericFieldDef	setLimitToAllowedValues(boolean limitToAllowedValues)
NumericFieldDef	setMaximum(Number maximum)
NumericFieldDef	setMinimum(Number minimum)
NumericFieldDef	setName(String name)
NumericFieldDef	setPattern(String pattern)
NumericFieldDef	setPrecision(Integer precision)
NumericFieldDef	setRequired(boolean required)
NumericFieldDef	setScale(Integer scale)
NumericFieldDef	setType(FieldType type)
Record	toRecord()
Element	toXmlElement(Document document)
protected void	validateValueImpl(Object value, ValidationResult result)

Methods inherited from class com.northconcepts.datapipeline.foundations.schema.FieldDef

assertValid, fromJson, getAllowedValues, getAttributes, getDefaultValueExpression, getDefaultValueExpressionAsString, getDescription, getDisplayName, getDisplayNameOrName, getEntityDef, getExample, getMaximumElements, getMinimumElements, getName, getNameForErrorMessage, getPosition, getSchemaDef, getSchemaDef, getTags, getType, isArray, isLimitToAllowedValues, isRequired, isStrictArrays, mapValue, newInstanceFromRecord, newInstanceFromType, newInstanceFromXml, setArray, setAttributes, setDefaultValueExpression, setEntityDef, setExample, setMaximumElements, setMinimumElements, setPosition, setStrictArrays, setTags, validateAllowedValues, validateField, validateField, validateField, validateField, validateValue, validateValue

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

addExceptionProperties, 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, 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

fromXml, fromXml, getAttribute, getAttribute, getAttribute, getAttribute, getAttribute, getAttribute, getAttribute, getAttribute, getAttribute, getAttribute, getChildElement, getChildElements, newInstanceFromXml, newInstanceFromXml, setAttribute, toXml, toXml, toXml, toXml, toXml, writeXml, writeXml

Field Detail

patternFormat

protected DecimalFormat patternFormat

Constructor Detail

NumericFieldDef

public NumericFieldDef()

NumericFieldDef

public NumericFieldDef(String name,
                       FieldType type)

Method Detail

getPattern

public String getPattern()

The optional numeric pattern to use when parsing incoming values (from currency, percentage, etc.) during mapping.

setPattern

public NumericFieldDef setPattern(String pattern)

mapValueImpl

protected Object mapValueImpl(Object value)
                       throws Throwable

Overrides:

mapValueImpl in class FieldDef

Throws:

Throwable

validateValueImpl

protected void validateValueImpl(Object value,
                                 ValidationResult result)
                          throws Throwable

Specified by:

validateValueImpl in class FieldDef

Throws:

Throwable

setName

public NumericFieldDef setName(String name)

Overrides:

setName in class FieldDef

setDisplayName

public NumericFieldDef setDisplayName(String displayName)

Overrides:

setDisplayName in class FieldDef

setDescription

public NumericFieldDef setDescription(String description)

Overrides:

setDescription in class FieldDef

setType

public NumericFieldDef setType(FieldType type)

Overrides:

setType in class FieldDef

setRequired

public NumericFieldDef setRequired(boolean required)

Overrides:

setRequired in class FieldDef

setAllowedValues

public NumericFieldDef setAllowedValues(ValueMatch<?> allowedValues)

Overrides:

setAllowedValues in class FieldDef

setLimitToAllowedValues

public NumericFieldDef setLimitToAllowedValues(boolean limitToAllowedValues)

Overrides:

setLimitToAllowedValues in class FieldDef

getPrecision

public Integer getPrecision()

The optional numeric precision -- currently unused.

setPrecision

public NumericFieldDef setPrecision(Integer precision)

getScale

public Integer getScale()

The optional numeric scale -- currently unused.

setScale

public NumericFieldDef setScale(Integer scale)

getMinimum

public Number getMinimum()

The optional smallest number allowed in values of this field.

setMinimum

public NumericFieldDef setMinimum(Number minimum)

getMaximum

public Number getMaximum()

The optional largest number allowed in values of this field.

setMaximum

public NumericFieldDef setMaximum(Number maximum)

toRecord

public Record toRecord()

Specified by:

toRecord in interface RecordSerializable

Overrides:

toRecord in class FieldDef

fromRecord

public NumericFieldDef 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 FieldDef

Returns:

this instance.

toXmlElement

public Element toXmlElement(Document document)

Specified by:

toXmlElement in interface XmlSerializable

Overrides:

toXmlElement in class FieldDef

fromXmlElement

public NumericFieldDef fromXmlElement(Element fieldDefElement)

Specified by:

fromXmlElement in interface XmlSerializable

Overrides:

fromXmlElement in class FieldDef