NumericFieldDef (Data Pipeline JavaDoc)

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.SchemaPart
      - com.northconcepts.datapipeline.foundations.schema.FieldDef
        
        com.northconcepts.datapipeline.foundations.schema.NumericFieldDef

All Implemented Interfaces:

DataExceptionContributor, JsonSerializable, RecordSerializable, XmlSerializable, SchemaProblemsSupplier, JavaCodeGenerator, Serializable, Cloneable
```
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

Fields
Modifier and Type	Field and Description
`protected DecimalFormat`	`patternFormat`

Constructor Summary

Constructors
Constructor and Description

NumericFieldDef()

NumericFieldDef(String name, FieldType type)

Constructors
Constructor and Description
`NumericFieldDef()`
`NumericFieldDef(String name, FieldType type)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`NumericFieldDef`	`clone()`
`boolean`	`equals(Object obj)`
`NumericFieldDef`	`fromRecord(Record source)` Loads this instance's state from a record and returns `this` (for fluid API call chaining).
`NumericFieldDef`	`fromXmlElement(Element fieldDefElement)`
`void`	`generateJavaCode(JavaCodeBuilder code)`
`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.
`void`	`getSchemaProblems(List<SchemaProblem> problems, boolean includeChildren)`
`int`	`hashCode()`
`protected Object`	`mapValueImpl(Object value)`
`NumericFieldDef`	`setAllowedValues(ValueMatch<?> allowedValues)`
`NumericFieldDef`	`setArray(boolean array)` Forces this field to be an array by setting the `FieldDef.getMinimumElements()` to zero (0) if both `FieldDef.getMinimumElements()` and `FieldDef.getMaximumElements()` are null, otherwise, does nothing.
`NumericFieldDef`	`setAttributes(Attributes attributes)`
`NumericFieldDef`	`setDefaultValueExpression(Expression defaultValueExpression)` The calculated value to set in the data if the field is null or missing.
`NumericFieldDef`	`setDescription(String description)`
`NumericFieldDef`	`setDisplayName(String displayName)`
`protected NumericFieldDef`	`setEntityDef(EntityDef entityDef)`
`NumericFieldDef`	`setExample(String example)`
`NumericFieldDef`	`setLimitToAllowedValues(boolean limitToAllowedValues)`
`NumericFieldDef`	`setMaximum(Number maximum)`
`NumericFieldDef`	`setMaximumElements(Integer maximumElements)`
`NumericFieldDef`	`setMinimum(Number minimum)`
`NumericFieldDef`	`setMinimumElements(Integer minimumElements)`
`NumericFieldDef`	`setName(String name)`
`NumericFieldDef`	`setPattern(String pattern)`
`NumericFieldDef`	`setPosition(Integer position)`
`NumericFieldDef`	`setPrecision(Integer precision)`
`NumericFieldDef`	`setPrimaryKeyPosition(Integer primaryKeyPosition)`
`NumericFieldDef`	`setPrimaryKeyType(PrimaryKeyType primaryKeyType)`
`NumericFieldDef`	`setRequired(boolean required)`
`NumericFieldDef`	`setScale(Integer scale)`
`NumericFieldDef`	`setStrictArrays(boolean strictArrays)`
`NumericFieldDef`	`setTags(Tags tags)`
`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, generateConstructor, getAllowedValues, getAttributes, getDefaultValueExpression, getDefaultValueExpressionAsString, getDescription, getDisplayName, getDisplayNameOrName, getEntityDef, getEntityQualifiedName, getExample, getIndexInEntityDef, getMaximumElements, getMinimumElements, getName, getNameForErrorMessage, getPosition, getPrimaryKeyPosition, getPrimaryKeyType, getQualifiedName, getSchemaDef, getSchemaDef, getSchemaPartContainer, getSchemaPartName, getSchemaPartType, getTags, getType, isArray, isLimitToAllowedValues, isPrimaryKey, isRequired, isStrictArrays, mapValue, newInstanceFromRecord, newInstanceFromType, newInstanceFromXml, toJson, validateAllowedValues, validateField, validateField, validateField, validateField, validateValue, validateValue

Methods inherited from class com.northconcepts.datapipeline.foundations.schema.SchemaPart
getSchemaName, getSchemaPartContainerName, getSchemaPartContainerType

Methods inherited from class com.northconcepts.datapipeline.foundations.core.FoundationObject
addExceptionProperties, assertValid, exception, exception, exception, getInternalId, getInternalName, resetInternalId

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

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.northconcepts.datapipeline.foundations.schema.SchemaProblemsSupplier
getSchemaProblems, getSchemaProblems

Methods inherited from interface com.northconcepts.datapipeline.core.RecordSerializable
fromArrayValue, fromArrayValue, fromArrayValue, fromJson, newInstanceFromRecord, toArrayValue, 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

- Field Detail
  - patternFormat
```
protected DecimalFormat patternFormat
```
- Constructor Detail
  - NumericFieldDef
```
public NumericFieldDef()
```
  - NumericFieldDef
```
public NumericFieldDef(String name,
                       FieldType type)
```
- Method Detail
  - getSchemaProblems
```
public void getSchemaProblems(List<SchemaProblem> problems,
                              boolean includeChildren)
```
    Specified by:
    
    getSchemaProblems in interface SchemaProblemsSupplier
    
    Overrides:
    
    getSchemaProblems in class FieldDef
  - clone
```
public NumericFieldDef clone()
```
    Overrides:
    
    clone in class FieldDef
  - generateJavaCode
```
public void generateJavaCode(JavaCodeBuilder code)
```
    Specified by:
    
    generateJavaCode in interface JavaCodeGenerator
    
    Overrides:
    
    generateJavaCode in class FieldDef
  - 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
  - setEntityDef
```
protected NumericFieldDef setEntityDef(EntityDef entityDef)
```
    Overrides:
    
    setEntityDef in class FieldDef
  - 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
  - setMinimumElements
```
public NumericFieldDef setMinimumElements(Integer minimumElements)
```
    Overrides:
    
    setMinimumElements in class FieldDef
  - setMaximumElements
```
public NumericFieldDef setMaximumElements(Integer maximumElements)
```
    Overrides:
    
    setMaximumElements in class FieldDef
  - setArray
```
public NumericFieldDef setArray(boolean array)
```
    Description copied from class: FieldDef
    
    Forces this field to be an array by setting the FieldDef.getMinimumElements() to zero (0) if both FieldDef.getMinimumElements() and FieldDef.getMaximumElements() are null, otherwise, does nothing.
    
    Overrides:
    
    setArray in class FieldDef
  - setStrictArrays
```
public NumericFieldDef setStrictArrays(boolean strictArrays)
```
    Overrides:
    
    setStrictArrays 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
  - setPrimaryKeyPosition
```
public NumericFieldDef setPrimaryKeyPosition(Integer primaryKeyPosition)
```
    Overrides:
    
    setPrimaryKeyPosition in class FieldDef
  - setPrimaryKeyType
```
public NumericFieldDef setPrimaryKeyType(PrimaryKeyType primaryKeyType)
```
    Overrides:
    
    setPrimaryKeyType 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)
```
  - setPosition
```
public NumericFieldDef setPosition(Integer position)
```
    Overrides:
    
    setPosition in class FieldDef
  - setDefaultValueExpression
```
public NumericFieldDef setDefaultValueExpression(Expression defaultValueExpression)
```
    Description copied from class: FieldDef
    
    The calculated value to set in the data if the field is null or missing.
    
    Overrides:
    
    setDefaultValueExpression in class FieldDef
  - setExample
```
public NumericFieldDef setExample(String example)
```
    Overrides:
    
    setExample in class FieldDef
  - setAttributes
```
public NumericFieldDef setAttributes(Attributes attributes)
```
    Overrides:
    
    setAttributes in class FieldDef
  - setTags
```
public NumericFieldDef setTags(Tags tags)
```
    Overrides:
    
    setTags in class FieldDef
  - 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
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class FieldDef
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class FieldDef

Class NumericFieldDef

Field Summary

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

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

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

Constructor Summary

Method Summary

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

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

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

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

Methods inherited from class java.lang.Object

Methods inherited from interface com.northconcepts.datapipeline.foundations.schema.SchemaProblemsSupplier

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

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

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

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

Field Detail

patternFormat

Constructor Detail

NumericFieldDef

NumericFieldDef

Method Detail

getSchemaProblems

clone

generateJavaCode

getPattern

setPattern

mapValueImpl

validateValueImpl

setEntityDef

setName

setDisplayName

setDescription

setType

setRequired

setMinimumElements

setMaximumElements

setArray

setStrictArrays

setAllowedValues

setLimitToAllowedValues

setPrimaryKeyPosition

setPrimaryKeyType

getPrecision

setPrecision

getScale

setScale

getMinimum

setMinimum

getMaximum

setMaximum

setPosition

setDefaultValueExpression

setExample

setAttributes

setTags

toRecord

fromRecord

toXmlElement

fromXmlElement

hashCode

equals