com.northconcepts.datapipeline.foundations.schema

Class TextFieldDef

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

All Implemented Interfaces:

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

public class TextFieldDef
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
TextFieldDef()
TextFieldDef(String name, FieldType type)

Method Summary

Modifier and Type	Method and Description
TextFieldDef	clone()
boolean	equals(Object obj)
TextFieldDef	fromRecord(Record source) Loads this instance's state from a record and returns this (for fluid API call chaining).
TextFieldDef	fromXmlElement(Element fieldDefElement)
void	generateJavaCode(JavaCodeBuilder code)
Integer	getMaximumLength() The optional most number of characters in values of this field.
Integer	getMinimumLength() The optional least number of characters in values of this field.
Pattern	getPattern() The optional regular expression pattern to use when parsing incoming values during validation (not used during mapping).
void	getSchemaProblems(List<SchemaProblem> problems, boolean includeChildren)
int	hashCode()
boolean	isAllowBlank() Indicates if empty strings are allowed as values for this field.
boolean	isTrim() Indicates if leading and trailing whitespace characters should be removed (default is false).
protected Object	mapValueImpl(Object value)
TextFieldDef	setAllowBlank(boolean allowBlank)
TextFieldDef	setAllowedValues(ValueMatch<?> allowedValues)
TextFieldDef	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.
TextFieldDef	setAttributes(Attributes attributes)
TextFieldDef	setDefaultValueExpression(Expression defaultValueExpression) The calculated value to set in the data if the field is null or missing.
TextFieldDef	setDescription(String description)
TextFieldDef	setDisplayName(String displayName)
protected TextFieldDef	setEntityDef(EntityDef entityDef)
TextFieldDef	setExample(String example)
TextFieldDef	setLimitToAllowedValues(boolean limitToAllowedValues)
TextFieldDef	setMaximumElements(Integer maximumElements)
TextFieldDef	setMaximumLength(Integer maximumLength)
TextFieldDef	setMinimumElements(Integer minimumElements)
TextFieldDef	setMinimumLength(Integer minimumLength)
TextFieldDef	setName(String name)
TextFieldDef	setPattern(Pattern pattern) The optional regular expression pattern to use when parsing incoming values during validation (not used during mapping).
TextFieldDef	setPattern(String pattern) The optional regular expression pattern to use when parsing incoming values during validation (not used during mapping).
TextFieldDef	setPosition(Integer position)
TextFieldDef	setPrimaryKeyPosition(Integer primaryKeyPosition)
TextFieldDef	setPrimaryKeyType(PrimaryKeyType primaryKeyType)
TextFieldDef	setRequired(boolean required)
TextFieldDef	setStrictArrays(boolean strictArrays)
TextFieldDef	setTags(Tags tags)
TextFieldDef	setTrim(boolean trim) Indicates if leading and trailing whitespace characters should be removed (default is false).
TextFieldDef	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

Constructor Detail

TextFieldDef

public TextFieldDef()

TextFieldDef

public TextFieldDef(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 TextFieldDef clone()

Overrides:

clone in class FieldDef

generateJavaCode

public void generateJavaCode(JavaCodeBuilder code)

Specified by:

generateJavaCode in interface JavaCodeGenerator

Overrides:

generateJavaCode in class FieldDef

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 TextFieldDef setEntityDef(EntityDef entityDef)

Overrides:

setEntityDef in class FieldDef

setName

public TextFieldDef setName(String name)

Overrides:

setName in class FieldDef

setDisplayName

public TextFieldDef setDisplayName(String displayName)

Overrides:

setDisplayName in class FieldDef

setDescription

public TextFieldDef setDescription(String description)

Overrides:

setDescription in class FieldDef

setType

public TextFieldDef setType(FieldType type)

Overrides:

setType in class FieldDef

setRequired

public TextFieldDef setRequired(boolean required)

Overrides:

setRequired in class FieldDef

setMinimumElements

public TextFieldDef setMinimumElements(Integer minimumElements)

Overrides:

setMinimumElements in class FieldDef

setMaximumElements

public TextFieldDef setMaximumElements(Integer maximumElements)

Overrides:

setMaximumElements in class FieldDef

setArray

public TextFieldDef 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 TextFieldDef setStrictArrays(boolean strictArrays)

Overrides:

setStrictArrays in class FieldDef

setAllowedValues

public TextFieldDef setAllowedValues(ValueMatch<?> allowedValues)

Overrides:

setAllowedValues in class FieldDef

setLimitToAllowedValues

public TextFieldDef setLimitToAllowedValues(boolean limitToAllowedValues)

Overrides:

setLimitToAllowedValues in class FieldDef

setPrimaryKeyPosition

public TextFieldDef setPrimaryKeyPosition(Integer primaryKeyPosition)

Overrides:

setPrimaryKeyPosition in class FieldDef

setPrimaryKeyType

public TextFieldDef setPrimaryKeyType(PrimaryKeyType primaryKeyType)

Overrides:

setPrimaryKeyType in class FieldDef

getMinimumLength

public Integer getMinimumLength()

The optional least number of characters in values of this field. Negative values will be set to zero (0).

setMinimumLength

public TextFieldDef setMinimumLength(Integer minimumLength)

getMaximumLength

public Integer getMaximumLength()

The optional most number of characters in values of this field. Negative values will be set to the max integer (2147483647). Zero (0) is allowed, it means the characters must always be zero in length.

setMaximumLength

public TextFieldDef setMaximumLength(Integer maximumLength)

isAllowBlank

public boolean isAllowBlank()

Indicates if empty strings are allowed as values for this field.

setAllowBlank

public TextFieldDef setAllowBlank(boolean allowBlank)

getPattern

public Pattern getPattern()

The optional regular expression pattern to use when parsing incoming values during validation (not used during mapping).

setPattern

public TextFieldDef setPattern(Pattern pattern)

The optional regular expression pattern to use when parsing incoming values during validation (not used during mapping).

setPattern

public TextFieldDef setPattern(String pattern)

The optional regular expression pattern to use when parsing incoming values during validation (not used during mapping).

isTrim

public boolean isTrim()

Indicates if leading and trailing whitespace characters should be removed (default is false).

setTrim

public TextFieldDef setTrim(boolean trim)

Indicates if leading and trailing whitespace characters should be removed (default is false).

setPosition

public TextFieldDef setPosition(Integer position)

Overrides:

setPosition in class FieldDef

setDefaultValueExpression

public TextFieldDef 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 TextFieldDef setExample(String example)

Overrides:

setExample in class FieldDef

setAttributes

public TextFieldDef setAttributes(Attributes attributes)

Overrides:

setAttributes in class FieldDef

setTags

public TextFieldDef 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 TextFieldDef 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 TextFieldDef 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