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

All Implemented Interfaces:

DataExceptionContributor, JsonSerializable, RecordSerializable, XmlSerializable, SchemaProblemsSupplier, JavaCodeGenerator, Serializable, Cloneable
```
public class RecordFieldDef
extends FieldDef
```
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

RecordFieldDef()

RecordFieldDef(String name, String referencedEntityName)

Constructors
Constructor and Description
`RecordFieldDef()`
`RecordFieldDef(String name, String referencedEntityName)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`RecordFieldDef`	`clone()`
`boolean`	`equals(Object obj)`
`RecordFieldDef`	`fromRecord(Record source)` Loads this instance's state from a record and returns `this` (for fluid API call chaining).
`RecordFieldDef`	`fromXmlElement(Element fieldDefElement)`
`protected void`	`generateConstructor(JavaCodeBuilder code, CodeWriter writer)`
`void`	`generateJavaCode(JavaCodeBuilder code)`
`EntityDef`	`getReferencedEntityDef()` The entity in the parent schema to use when validating and mapping this nested field.
`EntityDef`	`getReferencedEntityDef(boolean throwException)`
`String`	`getReferencedEntityName()` The name of the entity in the parent schema to use when validating and mapping this nested field.
`void`	`getSchemaProblems(List<SchemaProblem> problems, boolean includeChildren)`
`int`	`hashCode()`
`protected Object`	`mapValueImpl(Object value)`
`RecordFieldDef`	`setAllowedValues(ValueMatch<?> allowedValues)`
`RecordFieldDef`	`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.
`RecordFieldDef`	`setAttributes(Attributes attributes)`
`RecordFieldDef`	`setDefaultValueExpression(Expression defaultValueExpression)` The calculated value to set in the data if the field is null or missing.
`RecordFieldDef`	`setDescription(String description)`
`RecordFieldDef`	`setDisplayName(String displayName)`
`protected RecordFieldDef`	`setEntityDef(EntityDef entityDef)`
`RecordFieldDef`	`setExample(String example)`
`RecordFieldDef`	`setLimitToAllowedValues(boolean limitToAllowedValues)`
`RecordFieldDef`	`setMaximumElements(Integer maximumElements)`
`RecordFieldDef`	`setMinimumElements(Integer minimumElements)`
`RecordFieldDef`	`setName(String name)`
`RecordFieldDef`	`setPosition(Integer position)`
`RecordFieldDef`	`setPrimaryKeyPosition(Integer primaryKeyPosition)`
`RecordFieldDef`	`setPrimaryKeyType(PrimaryKeyType primaryKeyType)`
`RecordFieldDef`	`setReferencedEntityName(String referencedEntityName)`
`RecordFieldDef`	`setRequired(boolean required)`
`RecordFieldDef`	`setStrictArrays(boolean strictArrays)`
`RecordFieldDef`	`setTags(Tags tags)`
`RecordFieldDef`	`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, 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

- Constructor Detail
  - RecordFieldDef
```
public RecordFieldDef()
```
  - RecordFieldDef
```
public RecordFieldDef(String name,
                      String referencedEntityName)
```
- Method Detail
  - clone
```
public RecordFieldDef clone()
```
    Overrides:
    
    clone in class FieldDef
  - generateConstructor
```
protected void generateConstructor(JavaCodeBuilder code,
                                   CodeWriter writer)
```
    Overrides:
    
    generateConstructor in class FieldDef
  - generateJavaCode
```
public void generateJavaCode(JavaCodeBuilder code)
```
    Specified by:
    
    generateJavaCode in interface JavaCodeGenerator
    
    Overrides:
    
    generateJavaCode in class FieldDef
  - getSchemaProblems
```
public void getSchemaProblems(List<SchemaProblem> problems,
                              boolean includeChildren)
```
    Specified by:
    
    getSchemaProblems in interface SchemaProblemsSupplier
    
    Overrides:
    
    getSchemaProblems in class FieldDef
  - getReferencedEntityName
```
public String getReferencedEntityName()
```
    The name of the entity in the parent schema to use when validating and mapping this nested field.
  - setReferencedEntityName
```
public RecordFieldDef setReferencedEntityName(String referencedEntityName)
```
  - getReferencedEntityDef
```
public EntityDef getReferencedEntityDef(boolean throwException)
```
  - getReferencedEntityDef
```
public EntityDef getReferencedEntityDef()
```
    The entity in the parent schema to use when validating and mapping this nested field.
  - validateValueImpl
```
protected void validateValueImpl(Object value,
                                 ValidationResult result)
                          throws Throwable
```
    Specified by:
    
    validateValueImpl in class FieldDef
    
    Throws:
    
    Throwable
  - mapValueImpl
```
protected Object mapValueImpl(Object value)
                       throws Throwable
```
    Overrides:
    
    mapValueImpl in class FieldDef
    
    Throws:
    
    Throwable
  - setEntityDef
```
protected RecordFieldDef setEntityDef(EntityDef entityDef)
```
    Overrides:
    
    setEntityDef in class FieldDef
  - setName
```
public RecordFieldDef setName(String name)
```
    Overrides:
    
    setName in class FieldDef
  - setDisplayName
```
public RecordFieldDef setDisplayName(String displayName)
```
    Overrides:
    
    setDisplayName in class FieldDef
  - setDescription
```
public RecordFieldDef setDescription(String description)
```
    Overrides:
    
    setDescription in class FieldDef
  - setType
```
public RecordFieldDef setType(FieldType type)
```
    Overrides:
    
    setType in class FieldDef
  - setRequired
```
public RecordFieldDef setRequired(boolean required)
```
    Overrides:
    
    setRequired in class FieldDef
  - setAllowedValues
```
public RecordFieldDef setAllowedValues(ValueMatch<?> allowedValues)
```
    Overrides:
    
    setAllowedValues in class FieldDef
  - setMinimumElements
```
public RecordFieldDef setMinimumElements(Integer minimumElements)
```
    Overrides:
    
    setMinimumElements in class FieldDef
  - setMaximumElements
```
public RecordFieldDef setMaximumElements(Integer maximumElements)
```
    Overrides:
    
    setMaximumElements in class FieldDef
  - setArray
```
public RecordFieldDef 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 RecordFieldDef setStrictArrays(boolean strictArrays)
```
    Overrides:
    
    setStrictArrays in class FieldDef
  - setLimitToAllowedValues
```
public RecordFieldDef setLimitToAllowedValues(boolean limitToAllowedValues)
```
    Overrides:
    
    setLimitToAllowedValues in class FieldDef
  - setPrimaryKeyPosition
```
public RecordFieldDef setPrimaryKeyPosition(Integer primaryKeyPosition)
```
    Overrides:
    
    setPrimaryKeyPosition in class FieldDef
  - setPrimaryKeyType
```
public RecordFieldDef setPrimaryKeyType(PrimaryKeyType primaryKeyType)
```
    Overrides:
    
    setPrimaryKeyType in class FieldDef
  - setPosition
```
public RecordFieldDef setPosition(Integer position)
```
    Overrides:
    
    setPosition in class FieldDef
  - setDefaultValueExpression
```
public RecordFieldDef 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 RecordFieldDef setExample(String example)
```
    Overrides:
    
    setExample in class FieldDef
  - setAttributes
```
public RecordFieldDef setAttributes(Attributes attributes)
```
    Overrides:
    
    setAttributes in class FieldDef
  - setTags
```
public RecordFieldDef 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 RecordFieldDef 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 RecordFieldDef 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 RecordFieldDef

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

Constructor Detail

RecordFieldDef

RecordFieldDef

Method Detail

clone

generateConstructor

generateJavaCode

getSchemaProblems

getReferencedEntityName

setReferencedEntityName

getReferencedEntityDef

getReferencedEntityDef

validateValueImpl

mapValueImpl

setEntityDef

setName

setDisplayName

setDescription

setType

setRequired

setAllowedValues

setMinimumElements

setMaximumElements

setArray

setStrictArrays

setLimitToAllowedValues

setPrimaryKeyPosition

setPrimaryKeyType

setPosition

setDefaultValueExpression

setExample

setAttributes

setTags

toRecord

fromRecord

toXmlElement

fromXmlElement

hashCode

equals