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

All Implemented Interfaces:

DataExceptionContributor, JsonSerializable, RecordSerializable, XmlSerializable, SchemaProblemsSupplier, JavaCodeGenerator, Serializable, Cloneable
```
public class EntityDef
extends SchemaPart
implements Cloneable, SchemaProblemsSupplier
```
The metadata structure defining 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

EntityDef()

EntityDef(String name)

Constructors
Constructor and Description
`EntityDef()`
`EntityDef(String name)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`EntityDef`	`addField(FieldDef field)`
`EntityDef`	`addIndex(IndexDef index)`
`EntityDef`	`addValidation(Filter validation)`
`EntityDef`	`addValidation(String validationExpression)`
`EntityDef`	`clone()`
`boolean`	`containsField(String name)` Returns true if this entity contains a `FieldDef` with the specified `name`.
`boolean`	`containsIndex(String name)` Returns true if this entity contains an `IndexDef` with the specified `name`.
`boolean`	`containsInheritedField(String name)` Returns true if this entity or any of its super entities contains a `FieldDef` with the specified `name`.
`boolean`	`containsInheritedIndex(String name)` Returns true if this entity or any of its super entities contains an `IndexDef` with the specified `name`.
`Record`	`createEmptyRecord()`
`boolean`	`equals(Object obj)`
`EntityDef`	`fromJson(String jsonString)`
`EntityDef`	`fromRecord(Record source)` Loads this instance's state from a record and returns `this` (for fluid API call chaining).
`EntityDef`	`fromXmlElement(Element entityDefElement)`
`void`	`generateJavaCode(JavaCodeBuilder code)`
`Attributes`	`getAttributes()` User-defined key-value pairs to attached arbitrary metadata to this entity.
`String`	`getDescription()` The human-readable summary of this entity.
`FieldDef`	`getField(String name)` Returns the `FieldDef` that matches the specified name.
`int`	`getFieldCount()`
`List<String>`	`getFieldNames()`
`List<FieldDef>`	`getFields()`
`List<FieldDef>`	`getFields(boolean create)`
`List<FieldDef>`	`getFields(String name)`
`IndexDef`	`getIndex(String name)`
`int`	`getIndexCount()` Returns the number of indexes in this entity.
`List<IndexDef>`	`getIndexes()`
`List<IndexDef>`	`getIndexes(boolean create)`
`List<IndexDef>`	`getIndexes(String name)`
`List<String>`	`getIndexNames()` Returns the names of all indexes in this entity.
`int`	`getInheritedFieldCount()`
`List<FieldDef>`	`getInheritedFields()` Returns the fields in this entity and its super entities with overridden super fields removed.
`List<FieldDef>`	`getInheritedFields(boolean excludeOverriddenFields)` Returns the fields in this entity and its super entities, optionally removing overridden super fields.
`List<FieldDef>`	`getInheritedFields(List<FieldDef> result, boolean excludeOverriddenFields)` Returns the fields in this entity and its super entities, optionally removing overridden super fields.
`int`	`getInheritedIndexCount()` Returns the number of indexes in this entity and its super entities.
`String`	`getName()` The human-readable text identifier for this entity.
`List<String>`	`getPrimaryKeyFieldNames()`
`List<FieldDef>`	`getPrimaryKeyFields()`
`String`	`getQualifiedName()` Returns the fully qualified name that includes the name of this entity and all names in its hierarchy separated by period.
`SchemaDef`	`getSchemaDef()` The parent schema this entity belongs to.
`SchemaPart`	`getSchemaPartContainer()`
`String`	`getSchemaPartName()`
`SchemaPartType`	`getSchemaPartType()`
`void`	`getSchemaProblems(List<SchemaProblem> problems, boolean includeChildren)`
`EntityDef`	`getSuperEntity()` Returns the parent entity this entity inherits from (a superclass in object-oriented programming).
`String`	`getSuperEntityName()` Returns the name of the parent entity this entity inherits from (a superclass in object-oriented programming).
`Tags`	`getTags()` The set of labels used to organize, filter, and classify this entity.
`List<Filter>`	`getValidations()` The list of arbitrary validations associated with this entity.
`List<Filter>`	`getValidations(boolean create)`
`List<String>`	`getValidationsSource()` The list of `toString()` results from all filters.
`boolean`	`hasCompositePrimaryKeys()`
`int`	`hashCode()`
`int`	`indexOfField(String fieldName)`
`int`	`indexOfField(String fieldName, boolean throwExceptionOnFailure)`
`int`	`indexOfIndex(String indexName)` Returns the zero-based position of the `IndexDef` with the specified name or -1 if it is not found.
`int`	`indexOfIndex(String indexName, boolean throwExceptionOnFailure)` Returns the zero-based position of the `IndexDef` with the specified name or -1 if it is not found and `throwExceptionOnFailure` is false, otherwise a `DataException` is thrown.
`boolean`	`isAddMissingOptionalFields()` Indicates if data mapping should add optional fields in this entity that are not present in the data (doesn't apply during validation).
`boolean`	`isAllowExtraFieldsInMapping()` Indicates if data mapping should fail when the data contains fields not present in this entity (doesn't apply during validation).
`boolean`	`isAllowExtraFieldsInValidation()` Indicates if data validation should fail when the data contains fields not present in this entity (doesn't apply during mapping ).
`ValidationResult`	`mapAndValidateRecord(Record record)`
`ValidationResult`	`mapAndValidateRecord(Record record, ValidationResult result)`
`ValidationResult`	`mapRecord(Record record)`
`ValidationResult`	`mapRecord(Record record, ValidationResult result)`
`void`	`moveField(int oldIndex, int newIndex)` Moves the field at the `oldIndex` to the `newIndex`, shifting any existing elements at or after `newIndex` to the right.
`void`	`moveField(String fieldName, int newIndex)` Moves the field with the given name to the `newIndex`, shifting any existing elements at or after `newIndex` to the right.
`void`	`moveFieldAfter(String fieldName, String afterFieldName)` Moves the field with the given `fieldName` after to the field with the specified `afterFieldName`, shifting any existing elements after `afterFieldName` to the right.
`void`	`moveFieldBefore(String fieldName, String beforeFieldName)` Moves the field with the given `fieldName` before to the field with the specified `beforeFieldName`, shifting elements at or after `beforeFieldName` to the right.
`void`	`moveIndex(int oldIndex, int newIndex)` Moves the index at the `oldIndex` to the `newIndex`, shifting any existing elements at or after `newIndex` to the right.
`void`	`moveIndex(String indexName, int newIndex)` Moves the index with the given name to the `newIndex`, shifting any existing elements at or after `newIndex` to the right.
`void`	`moveIndexAfter(String indexName, String afterIndexName)` Moves the index with the given `indexName` after to the index with the specified `afterIndexName`, shifting any existing elements after `afterIndexName` to the right.
`void`	`moveIndexBefore(String indexName, String beforeIndexName)` Moves the index with the given `indexName` before to the index with the specified `beforeIndexName`, shifting elements at or after `beforeIndexName` to the right.
`EntityDef`	`setAddMissingOptionalFields(boolean addMissingOptionalFields)`
`EntityDef`	`setAllowExtraFieldsInMapping(boolean allowExtraFieldsInMapping)`
`EntityDef`	`setAllowExtraFieldsInValidation(boolean allowExtraFieldsInValidation)`
`EntityDef`	`setAttributes(Attributes attributes)`
`EntityDef`	`setDescription(String description)`
`EntityDef`	`setFields(List<FieldDef> fields)`
`EntityDef`	`setIndexes(List<IndexDef> indexes)`
`EntityDef`	`setName(String name)`
`protected EntityDef`	`setSchemaDef(SchemaDef schemaDef)`
`EntityDef`	`setSuperEntityName(String superEntityName)` Sets the name of the parent entity this entity inherits from (a superclass in object-oriented programming).
`EntityDef`	`setTags(Tags tags)`
`EntityDef`	`setValidations(List<Filter> validations)`
`String`	`toJson()`
`Record`	`toRecord()`
`Element`	`toXmlElement(Document document)`
`ValidationResult`	`validateRecord(Record record)`
`ValidationResult`	`validateRecord(Record record, 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, 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, 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
  - EntityDef
```
public EntityDef()
```
  - EntityDef
```
public EntityDef(String name)
```
- Method Detail
  - getSchemaProblems
```
public void getSchemaProblems(List<SchemaProblem> problems,
                              boolean includeChildren)
```
    Specified by:
    
    getSchemaProblems in interface SchemaProblemsSupplier
  - clone
```
public EntityDef clone()
```
    Overrides:
    
    clone in class FoundationObject
  - mapAndValidateRecord
```
public final ValidationResult mapAndValidateRecord(Record record)
```
  - mapAndValidateRecord
```
public final ValidationResult mapAndValidateRecord(Record record,
                                                   ValidationResult result)
```
  - mapRecord
```
public final ValidationResult mapRecord(Record record)
```
  - mapRecord
```
public final ValidationResult mapRecord(Record record,
                                        ValidationResult result)
```
  - validateRecord
```
public final ValidationResult validateRecord(Record record)
```
  - validateRecord
```
public final ValidationResult validateRecord(Record record,
                                             ValidationResult result)
```
  - generateJavaCode
```
public void generateJavaCode(JavaCodeBuilder code)
```
    Specified by:
    
    generateJavaCode in interface JavaCodeGenerator
  - getSchemaDef
```
public SchemaDef getSchemaDef()
```
    The parent schema this entity belongs to. The parent schema link is automatically created when this entity is added to a schema.
    
    Specified by:
    
    getSchemaDef in class SchemaPart
  - setSchemaDef
```
protected EntityDef setSchemaDef(SchemaDef schemaDef)
```
  - 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 entity.
  - setName
```
public EntityDef setName(String name)
```
  - getQualifiedName
```
public String getQualifiedName()
```
    Returns the fully qualified name that includes the name of this entity and all names in its hierarchy separated by period.
  - getDescription
```
public String getDescription()
```
    The human-readable summary of this entity.
  - setDescription
```
public EntityDef setDescription(String description)
```
  - getSuperEntityName
```
public String getSuperEntityName()
```
    Returns the name of the parent entity this entity inherits from (a superclass in object-oriented programming).
  - setSuperEntityName
```
public EntityDef setSuperEntityName(String superEntityName)
```
    Sets the name of the parent entity this entity inherits from (a superclass in object-oriented programming).
  - getSuperEntity
```
public EntityDef getSuperEntity()
```
    Returns the parent entity this entity inherits from (a superclass in object-oriented programming).
  - getPrimaryKeyFields
```
public List<FieldDef> getPrimaryKeyFields()
```
  - getPrimaryKeyFieldNames
```
public List<String> getPrimaryKeyFieldNames()
```
  - getInheritedFieldCount
```
public int getInheritedFieldCount()
```
  - getFieldCount
```
public int getFieldCount()
```
  - getFieldNames
```
public List<String> getFieldNames()
```
  - getFields
```
public List<FieldDef> getFields(boolean create)
```
  - getInheritedFields
```
public List<FieldDef> getInheritedFields()
```
    Returns the fields in this entity and its super entities with overridden super fields removed.
  - getInheritedFields
```
public List<FieldDef> getInheritedFields(boolean excludeOverriddenFields)
```
    Returns the fields in this entity and its super entities, optionally removing overridden super fields.
  - getInheritedFields
```
public List<FieldDef> getInheritedFields(List<FieldDef> result,
                                         boolean excludeOverriddenFields)
```
    Returns the fields in this entity and its super entities, optionally removing overridden super fields.
  - getFields
```
public List<FieldDef> getFields()
```
  - setFields
```
public EntityDef setFields(List<FieldDef> fields)
```
  - addField
```
public EntityDef addField(FieldDef field)
```
  - indexOfField
```
public int indexOfField(String fieldName)
```
  - indexOfField
```
public int indexOfField(String fieldName,
                        boolean throwExceptionOnFailure)
```
  - indexOfIndex
```
public int indexOfIndex(String indexName)
```
    Returns the zero-based position of the IndexDef with the specified name or -1 if it is not found.
  - indexOfIndex
```
public int indexOfIndex(String indexName,
                        boolean throwExceptionOnFailure)
```
    Returns the zero-based position of the IndexDef with the specified name or -1 if it is not found and throwExceptionOnFailure is false, otherwise a DataException is thrown.
  - containsInheritedField
```
public boolean containsInheritedField(String name)
```
    Returns true if this entity or any of its super entities contains a FieldDef with the specified name.
  - containsField
```
public boolean containsField(String name)
```
    Returns true if this entity contains a FieldDef with the specified name.
  - containsInheritedIndex
```
public boolean containsInheritedIndex(String name)
```
    Returns true if this entity or any of its super entities contains an IndexDef with the specified name.
  - containsIndex
```
public boolean containsIndex(String name)
```
    Returns true if this entity contains an IndexDef with the specified name.
  - hasCompositePrimaryKeys
```
public boolean hasCompositePrimaryKeys()
```
  - getField
```
public FieldDef getField(String name)
```
    Returns the FieldDef that matches the specified name.
  - getFields
```
public List<FieldDef> getFields(String name)
```
  - getValidations
```
public List<Filter> getValidations()
```
    The list of arbitrary validations associated with this entity.
  - getValidationsSource
```
public List<String> getValidationsSource()
```
    The list of toString() results from all filters.
    
    Returns:
  - getValidations
```
public List<Filter> getValidations(boolean create)
```
  - setValidations
```
public EntityDef setValidations(List<Filter> validations)
```
  - addValidation
```
public EntityDef addValidation(String validationExpression)
```
  - addValidation
```
public EntityDef addValidation(Filter validation)
```
  - isAllowExtraFieldsInValidation
```
public boolean isAllowExtraFieldsInValidation()
```
    Indicates if data validation should fail when the data contains fields not present in this entity (doesn't apply during mapping ).
  - setAllowExtraFieldsInValidation
```
public EntityDef setAllowExtraFieldsInValidation(boolean allowExtraFieldsInValidation)
```
  - isAllowExtraFieldsInMapping
```
public boolean isAllowExtraFieldsInMapping()
```
    Indicates if data mapping should fail when the data contains fields not present in this entity (doesn't apply during validation).
  - setAllowExtraFieldsInMapping
```
public EntityDef setAllowExtraFieldsInMapping(boolean allowExtraFieldsInMapping)
```
  - isAddMissingOptionalFields
```
public boolean isAddMissingOptionalFields()
```
    Indicates if data mapping should add optional fields in this entity that are not present in the data (doesn't apply during validation).
  - setAddMissingOptionalFields
```
public EntityDef setAddMissingOptionalFields(boolean addMissingOptionalFields)
```
  - getAttributes
```
public Attributes getAttributes()
```
    User-defined key-value pairs to attached arbitrary metadata to this entity.
  - setAttributes
```
public EntityDef setAttributes(Attributes attributes)
```
  - getTags
```
public Tags getTags()
```
    The set of labels used to organize, filter, and classify this entity.
  - setTags
```
public EntityDef setTags(Tags tags)
```
  - getInheritedIndexCount
```
public int getInheritedIndexCount()
```
    Returns the number of indexes in this entity and its super entities.
  - getIndexCount
```
public int getIndexCount()
```
    Returns the number of indexes in this entity.
  - getIndexNames
```
public List<String> getIndexNames()
```
    Returns the names of all indexes in this entity.
  - getIndexes
```
public List<IndexDef> getIndexes(boolean create)
```
  - getIndexes
```
public List<IndexDef> getIndexes()
```
  - setIndexes
```
public EntityDef setIndexes(List<IndexDef> indexes)
```
  - addIndex
```
public EntityDef addIndex(IndexDef index)
```
  - getIndex
```
public IndexDef getIndex(String name)
```
  - getIndexes
```
public List<IndexDef> getIndexes(String name)
```
  - createEmptyRecord
```
public Record createEmptyRecord()
```
  - toXmlElement
```
public Element toXmlElement(Document document)
```
    Specified by:
    
    toXmlElement in interface XmlSerializable
  - fromXmlElement
```
public EntityDef fromXmlElement(Element entityDefElement)
```
    Specified by:
    
    fromXmlElement in interface XmlSerializable
  - 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 EntityDef 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 EntityDef fromJson(String jsonString)
```
    Specified by:
    
    fromJson in interface JsonSerializable
    
    Specified by:
    
    fromJson in interface RecordSerializable
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - moveField
```
public void moveField(int oldIndex,
                      int newIndex)
```
    Moves the field at the oldIndex to the newIndex, shifting any existing elements at or after newIndex to the right.
  - moveField
```
public void moveField(String fieldName,
                      int newIndex)
```
    Moves the field with the given name to the newIndex, shifting any existing elements at or after newIndex to the right.
  - moveFieldBefore
```
public void moveFieldBefore(String fieldName,
                            String beforeFieldName)
```
    Moves the field with the given fieldName before to the field with the specified beforeFieldName, shifting elements at or after beforeFieldName to the right.
  - moveFieldAfter
```
public void moveFieldAfter(String fieldName,
                           String afterFieldName)
```
    Moves the field with the given fieldName after to the field with the specified afterFieldName, shifting any existing elements after afterFieldName to the right.
  - moveIndex
```
public void moveIndex(int oldIndex,
                      int newIndex)
```
    Moves the index at the oldIndex to the newIndex, shifting any existing elements at or after newIndex to the right.
  - moveIndex
```
public void moveIndex(String indexName,
                      int newIndex)
```
    Moves the index with the given name to the newIndex, shifting any existing elements at or after newIndex to the right.
  - moveIndexBefore
```
public void moveIndexBefore(String indexName,
                            String beforeIndexName)
```
    Moves the index with the given indexName before to the index with the specified beforeIndexName, shifting elements at or after beforeIndexName to the right.
  - moveIndexAfter
```
public void moveIndexAfter(String indexName,
                           String afterIndexName)
```
    Moves the index with the given indexName after to the index with the specified afterIndexName, shifting any existing elements after afterIndexName to the right.

Class EntityDef

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

EntityDef

EntityDef

Method Detail

getSchemaProblems

clone

mapAndValidateRecord

mapAndValidateRecord

mapRecord

mapRecord

validateRecord

validateRecord

generateJavaCode

getSchemaDef

setSchemaDef

getSchemaPartContainer

getSchemaPartType

getSchemaPartName

getName

setName

getQualifiedName

getDescription

setDescription

getSuperEntityName

setSuperEntityName

getSuperEntity

getPrimaryKeyFields

getPrimaryKeyFieldNames

getInheritedFieldCount

getFieldCount

getFieldNames

getFields

getInheritedFields

getInheritedFields

getInheritedFields

getFields

setFields

addField

indexOfField

indexOfField

indexOfIndex

indexOfIndex

containsInheritedField

containsField

containsInheritedIndex

containsIndex

hasCompositePrimaryKeys

getField

getFields

getValidations

getValidationsSource

getValidations

setValidations

addValidation

addValidation

isAllowExtraFieldsInValidation

setAllowExtraFieldsInValidation

isAllowExtraFieldsInMapping

setAllowExtraFieldsInMapping

isAddMissingOptionalFields

setAddMissingOptionalFields

getAttributes

setAttributes

getTags