TemporalFieldDef (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.TemporalFieldDef

All Implemented Interfaces:

DataExceptionContributor, JsonSerializable, RecordSerializable, XmlSerializable, SchemaProblemsSupplier, JavaCodeGenerator, Serializable, Cloneable
```
public class TemporalFieldDef
extends FieldDef
```
See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

protected DateTimeFormatter 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 DateTimeFormatter`	`patternFormat`

Constructor Summary

Constructors
Constructor and Description

TemporalFieldDef()

TemporalFieldDef(String name, FieldType type)

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`TemporalFieldDef`	`clone()`
`boolean`	`equals(Object obj)`
`TemporalFieldDef`	`fromRecord(Record source)` Loads this instance's state from a record and returns `this` (for fluid API call chaining).
`TemporalFieldDef`	`fromXmlElement(Element fieldDefElement)`
`void`	`generateJavaCode(JavaCodeBuilder code)`
`TemporalAccessor`	`getMaximum()` The optional largest date, time, or datetime allowed in values of this field.
`TemporalAccessor`	`getMinimum()` The optional smallest date, time, or datetime allowed in values of this field.
`String`	`getPattern()` The optional date, time, or datetime pattern to use when parsing incoming values during mapping.
`void`	`getSchemaProblems(List<SchemaProblem> problems, boolean includeChildren)`
`int`	`hashCode()`
`boolean`	`isLenientPattern()`
`protected Object`	`mapValueImpl(Object value)`
`TemporalFieldDef`	`setAllowedValues(ValueMatch<?> allowedValues)`
`TemporalFieldDef`	`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.
`TemporalFieldDef`	`setAttributes(Attributes attributes)`
`TemporalFieldDef`	`setDefaultValueExpression(Expression defaultValueExpression)` The calculated value to set in the data if the field is null or missing.
`TemporalFieldDef`	`setDescription(String description)`
`TemporalFieldDef`	`setDisplayName(String displayName)`
`protected TemporalFieldDef`	`setEntityDef(EntityDef entityDef)`
`TemporalFieldDef`	`setExample(String example)`
`TemporalFieldDef`	`setLenientPattern(boolean lenientPattern)`
`TemporalFieldDef`	`setLimitToAllowedValues(boolean limitToAllowedValues)`
`TemporalFieldDef`	`setMaximum(TemporalAccessor maximum)`
`TemporalFieldDef`	`setMaximumElements(Integer maximumElements)`
`TemporalFieldDef`	`setMinimum(TemporalAccessor minimum)`
`TemporalFieldDef`	`setMinimumElements(Integer minimumElements)`
`TemporalFieldDef`	`setName(String name)`
`TemporalFieldDef`	`setPattern(String pattern)`
`TemporalFieldDef`	`setPosition(Integer position)`
`TemporalFieldDef`	`setPrimaryKeyPosition(Integer primaryKeyPosition)`
`TemporalFieldDef`	`setPrimaryKeyType(PrimaryKeyType primaryKeyType)`
`TemporalFieldDef`	`setRequired(boolean required)`
`TemporalFieldDef`	`setStrictArrays(boolean strictArrays)`
`TemporalFieldDef`	`setTags(Tags tags)`
`TemporalFieldDef`	`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 DateTimeFormatter patternFormat
```
- Constructor Detail
  - TemporalFieldDef
```
public TemporalFieldDef()
```
  - TemporalFieldDef
```
public TemporalFieldDef(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 TemporalFieldDef 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 date, time, or datetime pattern to use when parsing incoming values during mapping.
  - setPattern
```
public TemporalFieldDef setPattern(String pattern)
```
  - isLenientPattern
```
public boolean isLenientPattern()
```
  - setLenientPattern
```
public TemporalFieldDef setLenientPattern(boolean lenientPattern)
```
  - 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 TemporalFieldDef setEntityDef(EntityDef entityDef)
```
    Overrides:
    
    setEntityDef in class FieldDef
  - setName
```
public TemporalFieldDef setName(String name)
```
    Overrides:
    
    setName in class FieldDef
  - setDisplayName
```
public TemporalFieldDef setDisplayName(String displayName)
```
    Overrides:
    
    setDisplayName in class FieldDef
  - setDescription
```
public TemporalFieldDef setDescription(String description)
```
    Overrides:
    
    setDescription in class FieldDef
  - setType
```
public TemporalFieldDef setType(FieldType type)
```
    Overrides:
    
    setType in class FieldDef
  - setRequired
```
public TemporalFieldDef setRequired(boolean required)
```
    Overrides:
    
    setRequired in class FieldDef
  - setMinimumElements
```
public TemporalFieldDef setMinimumElements(Integer minimumElements)
```
    Overrides:
    
    setMinimumElements in class FieldDef
  - setMaximumElements
```
public TemporalFieldDef setMaximumElements(Integer maximumElements)
```
    Overrides:
    
    setMaximumElements in class FieldDef
  - setArray
```
public TemporalFieldDef 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 TemporalFieldDef setStrictArrays(boolean strictArrays)
```
    Overrides:
    
    setStrictArrays in class FieldDef
  - setAllowedValues
```
public TemporalFieldDef setAllowedValues(ValueMatch<?> allowedValues)
```
    Overrides:
    
    setAllowedValues in class FieldDef
  - setLimitToAllowedValues
```
public TemporalFieldDef setLimitToAllowedValues(boolean limitToAllowedValues)
```
    Overrides:
    
    setLimitToAllowedValues in class FieldDef
  - setPrimaryKeyPosition
```
public TemporalFieldDef setPrimaryKeyPosition(Integer primaryKeyPosition)
```
    Overrides:
    
    setPrimaryKeyPosition in class FieldDef
  - setPrimaryKeyType
```
public TemporalFieldDef setPrimaryKeyType(PrimaryKeyType primaryKeyType)
```
    Overrides:
    
    setPrimaryKeyType in class FieldDef
  - getMinimum
```
public TemporalAccessor getMinimum()
```
    The optional smallest date, time, or datetime allowed in values of this field.
  - setMinimum
```
public TemporalFieldDef setMinimum(TemporalAccessor minimum)
```
  - getMaximum
```
public TemporalAccessor getMaximum()
```
    The optional largest date, time, or datetime allowed in values of this field.
  - setMaximum
```
public TemporalFieldDef setMaximum(TemporalAccessor maximum)
```
  - setPosition
```
public TemporalFieldDef setPosition(Integer position)
```
    Overrides:
    
    setPosition in class FieldDef
  - setDefaultValueExpression
```
public TemporalFieldDef 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 TemporalFieldDef setExample(String example)
```
    Overrides:
    
    setExample in class FieldDef
  - setAttributes
```
public TemporalFieldDef setAttributes(Attributes attributes)
```
    Overrides:
    
    setAttributes in class FieldDef
  - setTags
```
public TemporalFieldDef 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 TemporalFieldDef 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 TemporalFieldDef 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 TemporalFieldDef

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

TemporalFieldDef

TemporalFieldDef

Method Detail

getSchemaProblems

clone

generateJavaCode

getPattern

setPattern

isLenientPattern

setLenientPattern

mapValueImpl

validateValueImpl

setEntityDef

setName

setDisplayName

setDescription

setType

setRequired

setMinimumElements

setMaximumElements

setArray

setStrictArrays

setAllowedValues

setLimitToAllowedValues

setPrimaryKeyPosition

setPrimaryKeyType

getMinimum

setMinimum

getMaximum

setMaximum

setPosition

setDefaultValueExpression

setExample

setAttributes

setTags

toRecord

fromRecord

toXmlElement

fromXmlElement

hashCode

equals