FieldDef (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

All Implemented Interfaces:

DataExceptionContributor, JsonSerializable, RecordSerializable, XmlSerializable, SchemaProblemsSupplier, JavaCodeGenerator, Serializable, Cloneable

Direct Known Subclasses:

BinaryFieldDef, BooleanFieldDef, NumericFieldDef, RecordFieldDef, TemporalFieldDef, TextFieldDef, UuidFieldDef
```
public abstract class FieldDef
extends SchemaPart
implements Cloneable, SchemaProblemsSupplier
```
The metadata structure of one column or property in a file, JSON object, database table, or class for validation and mapping.

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

FieldDef()

FieldDef(String name, FieldType type)

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

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`FieldDef`	`assertValid()`
`FieldDef`	`clone()`
`boolean`	`equals(Object obj)`
`FieldDef`	`fromJson(String jsonString)`
`FieldDef`	`fromRecord(Record source)` Loads this instance's state from a record and returns `this` (for fluid API call chaining).
`FieldDef`	`fromXmlElement(Element fieldDefElement)`
`protected void`	`generateConstructor(JavaCodeBuilder code, CodeWriter writer)`
`void`	`generateJavaCode(JavaCodeBuilder code)`
`ValueMatch<?>`	`getAllowedValues()` The optional set of values this field allows.
`Attributes`	`getAttributes()` User-defined key-value pairs to attached arbitrary metadata to this field.
`Expression`	`getDefaultValueExpression()` The calculated value to set in the data if the field is null or missing.
`String`	`getDefaultValueExpressionAsString()` The calculated value to set in the data if the field is null or missing.
`String`	`getDescription()` The human-readable summary of this field.
`String`	`getDisplayName()` The user-friendly name for this field.
`String`	`getDisplayNameOrName()` The user-friendly name for this field if one is set or the `getName()` value otherwise.
`EntityDef`	`getEntityDef()` The parent entity containing this field.
`String`	`getEntityQualifiedName()` Returns the qualified name that includes the name of this field and the `EntityDef` above it separated by period.
`String`	`getExample()` A human-readable example of values supported by this field.
`int`	`getIndexInEntityDef()` Returns the zero-based index of this field in `EntityDef`.
`Integer`	`getMaximumElements()` The maximum numbers of array elements allowed by this array field.
`Integer`	`getMinimumElements()` The minimum numbers of array elements allowed by this array field.
`String`	`getName()` The human-readable text identifier for this field.
`String`	`getNameForErrorMessage()` The fully-qualified name for use in error and validation messages using `getDisplayNameOrName()` for each name segment.
`Integer`	`getPosition()` The zero-based location of this field in the data (if applicable).
`Integer`	`getPrimaryKeyPosition()`
`PrimaryKeyType`	`getPrimaryKeyType()`
`String`	`getQualifiedName()` Returns the fully qualified name that includes the name of this field definition and all names in its hierarchy separated by period.
`SchemaDef`	`getSchemaDef()` The schema of the parent entity containing this field.
`SchemaDef`	`getSchemaDef(boolean throwException)`
`SchemaPart`	`getSchemaPartContainer()`
`String`	`getSchemaPartName()`
`SchemaPartType`	`getSchemaPartType()`
`void`	`getSchemaProblems(List<SchemaProblem> problems, boolean includeChildren)`
`Tags`	`getTags()` The set of labels used to organize, filter, and classify this field.
`FieldType`	`getType()` The data type of this field.
`int`	`hashCode()`
`boolean`	`isArray()` Indicates if either `getMinimumElements()` or `getMaximumElements()` are not null.
`boolean`	`isLimitToAllowedValues()` Indicates if values not it `getAllowedValues()` are allowed.
`boolean`	`isPrimaryKey()` Returns `true` if `primaryKeyPosition` is not null.
`boolean`	`isRequired()` Indicates if this field can be null or missing.
`boolean`	`isStrictArrays()` Indicates if arrays should be strictly handled as arrays (default/true) or if an array with one value can be treated and a non-array and vice-versa (false).
`Object`	`mapValue(Object sourceValue)`
`protected Object`	`mapValueImpl(Object value)`
`static FieldDef`	`newInstanceFromRecord(Record fieldDefRecord)`
`static FieldDef`	`newInstanceFromType(String type)`
`static FieldDef`	`newInstanceFromXml(Element fieldDefElement)`
`FieldDef`	`setAllowedValues(ValueMatch<?> allowedValues)`
`FieldDef`	`setArray(boolean array)` Forces this field to be an array by setting the `getMinimumElements()` to zero (0) if both `getMinimumElements()` and `getMaximumElements()` are null, otherwise, does nothing.
`FieldDef`	`setAttributes(Attributes attributes)`
`FieldDef`	`setDefaultValueExpression(Expression defaultValueExpression)` The calculated value to set in the data if the field is null or missing.
`FieldDef`	`setDescription(String description)`
`FieldDef`	`setDisplayName(String displayName)`
`protected FieldDef`	`setEntityDef(EntityDef entityDef)`
`FieldDef`	`setExample(String example)`
`FieldDef`	`setLimitToAllowedValues(boolean limitToAllowedValues)`
`FieldDef`	`setMaximumElements(Integer maximumElements)`
`FieldDef`	`setMinimumElements(Integer minimumElements)`
`FieldDef`	`setName(String name)`
`FieldDef`	`setPosition(Integer position)`
`FieldDef`	`setPrimaryKeyPosition(Integer primaryKeyPosition)`
`FieldDef`	`setPrimaryKeyType(PrimaryKeyType primaryKeyType)`
`FieldDef`	`setRequired(boolean required)`
`FieldDef`	`setStrictArrays(boolean strictArrays)`
`FieldDef`	`setTags(Tags tags)`
`FieldDef`	`setType(FieldType type)`
`String`	`toJson()`
`Record`	`toRecord()`
`Element`	`toXmlElement(Document document)`
`protected void`	`validateAllowedValues(Object value, ValidationResult result)`
`ValidationResult`	`validateField(Field field)`
`ValidationResult`	`validateField(Field field, ValidationResult result)`
`ValidationResult`	`validateField(Record record)`
`ValidationResult`	`validateField(Record record, ValidationResult result)`
`ValidationResult`	`validateValue(Object value)`
`ValidationResult`	`validateValue(Object value, ValidationResult result)`
`protected abstract void`	`validateValueImpl(Object value, ValidationResult result)`

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

- Constructor Detail
  - FieldDef
```
public FieldDef()
```
  - FieldDef
```
public FieldDef(String name,
                FieldType type)
```
- Method Detail
  - getSchemaProblems
```
public void getSchemaProblems(List<SchemaProblem> problems,
                              boolean includeChildren)
```
    Specified by:
    
    getSchemaProblems in interface SchemaProblemsSupplier
  - clone
```
public FieldDef clone()
```
    Overrides:
    
    clone in class FoundationObject
  - validateField
```
public ValidationResult validateField(Record record)
```
  - validateField
```
public ValidationResult validateField(Record record,
                                      ValidationResult result)
```
  - validateField
```
public final ValidationResult validateField(Field field)
```
  - validateField
```
public final ValidationResult validateField(Field field,
                                            ValidationResult result)
```
  - assertValid
```
public FieldDef assertValid()
```
    Overrides:
    
    assertValid in class FoundationObject
  - validateValue
```
public final ValidationResult validateValue(Object value)
```
  - validateValue
```
public final ValidationResult validateValue(Object value,
                                            ValidationResult result)
```
  - validateAllowedValues
```
protected void validateAllowedValues(Object value,
                                     ValidationResult result)
```
  - validateValueImpl
```
protected abstract void validateValueImpl(Object value,
                                          ValidationResult result)
                                   throws Throwable
```
    Throws:
    
    Throwable
  - mapValue
```
public final Object mapValue(Object sourceValue)
```
  - mapValueImpl
```
protected Object mapValueImpl(Object value)
                       throws Throwable
```
    Throws:
    
    Throwable
  - generateConstructor
```
protected void generateConstructor(JavaCodeBuilder code,
                                   CodeWriter writer)
```
  - generateJavaCode
```
public void generateJavaCode(JavaCodeBuilder code)
```
    Specified by:
    
    generateJavaCode in interface JavaCodeGenerator
  - getEntityDef
```
public EntityDef getEntityDef()
```
    The parent entity containing this field.
  - setEntityDef
```
protected FieldDef setEntityDef(EntityDef entityDef)
```
  - getSchemaDef
```
public SchemaDef getSchemaDef(boolean throwException)
```
  - getSchemaDef
```
public SchemaDef getSchemaDef()
```
    The schema of the parent entity containing this field.
    
    Specified by:
    
    getSchemaDef in class SchemaPart
  - getSchemaPartContainer
```
public SchemaPart getSchemaPartContainer()
```
    Specified by:
    
    getSchemaPartContainer in class SchemaPart
  - getSchemaPartType
```
public SchemaPartType getSchemaPartType()
```
    Specified by:
    
    getSchemaPartType in class SchemaPart
  - getSchemaPartName
```
public String getSchemaPartName()
```
    Specified by:
    
    getSchemaPartName in class SchemaPart
  - getName
```
public String getName()
```
    The human-readable text identifier for this field.
  - setName
```
public FieldDef setName(String name)
```
  - getQualifiedName
```
public String getQualifiedName()
```
    Returns the fully qualified name that includes the name of this field definition and all names in its hierarchy separated by period.
  - getEntityQualifiedName
```
public String getEntityQualifiedName()
```
    Returns the qualified name that includes the name of this field and the EntityDef above it separated by period.
  - getDisplayName
```
public String getDisplayName()
```
    The user-friendly name for this field.
  - setDisplayName
```
public FieldDef setDisplayName(String displayName)
```
  - getDisplayNameOrName
```
public String getDisplayNameOrName()
```
    The user-friendly name for this field if one is set or the getName() value otherwise.
  - getNameForErrorMessage
```
public String getNameForErrorMessage()
```
    The fully-qualified name for use in error and validation messages using getDisplayNameOrName() for each name segment.
  - getDescription
```
public String getDescription()
```
    The human-readable summary of this field.
  - setDescription
```
public FieldDef setDescription(String description)
```
  - getType
```
public FieldType getType()
```
    The data type of this field.
  - setType
```
public FieldDef setType(FieldType type)
```
  - isRequired
```
public boolean isRequired()
```
    Indicates if this field can be null or missing.
  - setRequired
```
public FieldDef setRequired(boolean required)
```
  - getMinimumElements
```
public Integer getMinimumElements()
```
    The minimum numbers of array elements allowed by this array field. This field is treated as an array if either this property of the getMaximumElements() property are not null. Negative values will be set to zero (0).
  - setMinimumElements
```
public FieldDef setMinimumElements(Integer minimumElements)
```
  - getMaximumElements
```
public Integer getMaximumElements()
```
    The maximum numbers of array elements allowed by this array field. This field is treated as an array if either this property of the getMinimumElements() property are not null. Negative values will be set to the max integer (2147483647). Zero (0) is allowed, it means the array must always be empty.
  - setMaximumElements
```
public FieldDef setMaximumElements(Integer maximumElements)
```
  - isArray
```
public boolean isArray()
```
    Indicates if either getMinimumElements() or getMaximumElements() are not null.
  - setArray
```
public FieldDef setArray(boolean array)
```
    Forces this field to be an array by setting the getMinimumElements() to zero (0) if both getMinimumElements() and getMaximumElements() are null, otherwise, does nothing.
  - isStrictArrays
```
public boolean isStrictArrays()
```
    Indicates if arrays should be strictly handled as arrays (default/true) or if an array with one value can be treated and a non-array and vice-versa (false). Most developers will want to leave this set to the default (true).
  - setStrictArrays
```
public FieldDef setStrictArrays(boolean strictArrays)
```
  - isLimitToAllowedValues
```
public boolean isLimitToAllowedValues()
```
    Indicates if values not it getAllowedValues() are allowed.
  - setLimitToAllowedValues
```
public FieldDef setLimitToAllowedValues(boolean limitToAllowedValues)
```
  - getAllowedValues
```
public ValueMatch<?> getAllowedValues()
```
    The optional set of values this field allows. The isLimitToAllowedValues() property indicates if other values can be set.
  - setAllowedValues
```
public FieldDef setAllowedValues(ValueMatch<?> allowedValues)
```
  - getPosition
```
public Integer getPosition()
```
    The zero-based location of this field in the data (if applicable). This can be used to name previously unnamed fields based on their position (or override the names of already named fields).
  - setPosition
```
public FieldDef setPosition(Integer position)
```
  - getDefaultValueExpression
```
public Expression getDefaultValueExpression()
```
    The calculated value to set in the data if the field is null or missing.
  - getDefaultValueExpressionAsString
```
public String getDefaultValueExpressionAsString()
```
    The calculated value to set in the data if the field is null or missing.
  - setDefaultValueExpression
```
public FieldDef setDefaultValueExpression(Expression defaultValueExpression)
```
    The calculated value to set in the data if the field is null or missing.
  - getExample
```
public String getExample()
```
    A human-readable example of values supported by this field. A "country" field might have "Japan" as an example.
  - setExample
```
public FieldDef setExample(String example)
```
  - getAttributes
```
public Attributes getAttributes()
```
    User-defined key-value pairs to attached arbitrary metadata to this field.
  - setAttributes
```
public FieldDef setAttributes(Attributes attributes)
```
  - getTags
```
public Tags getTags()
```
    The set of labels used to organize, filter, and classify this field.
  - setTags
```
public FieldDef setTags(Tags tags)
```
  - getPrimaryKeyPosition
```
public Integer getPrimaryKeyPosition()
```
  - setPrimaryKeyPosition
```
public FieldDef setPrimaryKeyPosition(Integer primaryKeyPosition)
```
  - isPrimaryKey
```
public boolean isPrimaryKey()
```
    Returns true if primaryKeyPosition is not null.
  - getPrimaryKeyType
```
public PrimaryKeyType getPrimaryKeyType()
```
  - setPrimaryKeyType
```
public FieldDef setPrimaryKeyType(PrimaryKeyType primaryKeyType)
```
  - getIndexInEntityDef
```
public int getIndexInEntityDef()
```
    Returns the zero-based index of this field in EntityDef.
  - toJson
```
public String toJson()
```
    Specified by:
    
    toJson in interface JsonSerializable
    
    Specified by:
    
    toJson in interface RecordSerializable
  - toRecord
```
public Record toRecord()
```
    Specified by:
    
    toRecord in interface RecordSerializable
    
    Overrides:
    
    toRecord in class Bean
  - fromRecord
```
public FieldDef 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.
  - fromJson
```
public FieldDef fromJson(String jsonString)
```
    Specified by:
    
    fromJson in interface JsonSerializable
    
    Specified by:
    
    fromJson in interface RecordSerializable
  - toXmlElement
```
public Element toXmlElement(Document document)
```
    Specified by:
    
    toXmlElement in interface XmlSerializable
  - fromXmlElement
```
public FieldDef fromXmlElement(Element fieldDefElement)
```
    Specified by:
    
    fromXmlElement in interface XmlSerializable
  - newInstanceFromType
```
public static FieldDef newInstanceFromType(String type)
```
  - newInstanceFromXml
```
public static FieldDef newInstanceFromXml(Element fieldDefElement)
```
  - newInstanceFromRecord
```
public static FieldDef newInstanceFromRecord(Record fieldDefRecord)
```
    Specified by:
    
    newInstanceFromRecord in interface RecordSerializable
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object

Class FieldDef

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

Constructor Detail

FieldDef

FieldDef

Method Detail

getSchemaProblems

clone

validateField

validateField

validateField

validateField

assertValid

validateValue

validateValue

validateAllowedValues

validateValueImpl

mapValue

mapValueImpl

generateConstructor

generateJavaCode

getEntityDef

setEntityDef

getSchemaDef

getSchemaDef

getSchemaPartContainer

getSchemaPartType

getSchemaPartName

getName

setName

getQualifiedName

getEntityQualifiedName

getDisplayName

setDisplayName

getDisplayNameOrName

getNameForErrorMessage

getDescription

setDescription

getType

setType

isRequired

setRequired

getMinimumElements

setMinimumElements

getMaximumElements

setMaximumElements

isArray

setArray

isStrictArrays

setStrictArrays

isLimitToAllowedValues

setLimitToAllowedValues

getAllowedValues

setAllowedValues

getPosition

setPosition

getDefaultValueExpression

getDefaultValueExpressionAsString

setDefaultValueExpression

getExample

setExample

getAttributes

setAttributes

getTags

setTags

getPrimaryKeyPosition