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

All Implemented Interfaces:

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

BinaryFieldDef()

BinaryFieldDef(String name)

BinaryFieldDef(String name, FieldType type)

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BinaryFieldDef`	`clone()`
`boolean`	`equals(Object obj)`
`BinaryFieldDef`	`fromRecord(Record source)` Loads this instance's state from a record and returns `this` (for fluid API call chaining).
`BinaryFieldDef`	`fromXmlElement(Element fieldDefElement)`
`protected void`	`generateConstructor(JavaCodeBuilder code, CodeWriter writer)`
`void`	`generateJavaCode(JavaCodeBuilder code)`
`Long`	`getMaximumLength()` The optional most number of bytes in values of this field.
`Long`	`getMinimumLength()` The optional least number of bytes in values of this field.
`void`	`getSchemaProblems(List<SchemaProblem> problems, boolean includeChildren)`
`int`	`hashCode()`
`BinaryFieldDef`	`setAllowedValues(ValueMatch<?> allowedValues)`
`BinaryFieldDef`	`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.
`BinaryFieldDef`	`setAttributes(Attributes attributes)`
`BinaryFieldDef`	`setDefaultValueExpression(Expression defaultValueExpression)` The calculated value to set in the data if the field is null or missing.
`BinaryFieldDef`	`setDescription(String description)`
`BinaryFieldDef`	`setDisplayName(String displayName)`
`protected BinaryFieldDef`	`setEntityDef(EntityDef entityDef)`
`BinaryFieldDef`	`setExample(String example)`
`BinaryFieldDef`	`setLimitToAllowedValues(boolean limitToAllowedValues)`
`BinaryFieldDef`	`setMaximumElements(Integer maximumElements)`
`BinaryFieldDef`	`setMaximumLength(Long maximumLength)`
`BinaryFieldDef`	`setMinimumElements(Integer minimumElements)`
`BinaryFieldDef`	`setMinimumLength(Long minimumLength)`
`BinaryFieldDef`	`setName(String name)`
`BinaryFieldDef`	`setPosition(Integer position)`
`BinaryFieldDef`	`setPrimaryKeyPosition(Integer primaryKeyPosition)`
`BinaryFieldDef`	`setPrimaryKeyType(PrimaryKeyType primaryKeyType)`
`BinaryFieldDef`	`setRequired(boolean required)`
`BinaryFieldDef`	`setStrictArrays(boolean strictArrays)`
`BinaryFieldDef`	`setTags(Tags tags)`
`BinaryFieldDef`	`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, mapValueImpl, 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
  - BinaryFieldDef
```
public BinaryFieldDef()
```
  - BinaryFieldDef
```
public BinaryFieldDef(String name)
```
  - BinaryFieldDef
```
public BinaryFieldDef(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 BinaryFieldDef clone()
```
    Overrides:
    
    clone in class FieldDef
  - validateValueImpl
```
protected void validateValueImpl(Object value,
                                 ValidationResult result)
                          throws Throwable
```
    Specified by:
    
    validateValueImpl in class FieldDef
    
    Throws:
    
    Throwable
  - 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
  - setEntityDef
```
protected BinaryFieldDef setEntityDef(EntityDef entityDef)
```
    Overrides:
    
    setEntityDef in class FieldDef
  - setName
```
public BinaryFieldDef setName(String name)
```
    Overrides:
    
    setName in class FieldDef
  - setDisplayName
```
public BinaryFieldDef setDisplayName(String displayName)
```
    Overrides:
    
    setDisplayName in class FieldDef
  - setDescription
```
public BinaryFieldDef setDescription(String description)
```
    Overrides:
    
    setDescription in class FieldDef
  - setType
```
public BinaryFieldDef setType(FieldType type)
```
    Overrides:
    
    setType in class FieldDef
  - setRequired
```
public BinaryFieldDef setRequired(boolean required)
```
    Overrides:
    
    setRequired in class FieldDef
  - setMinimumElements
```
public BinaryFieldDef setMinimumElements(Integer minimumElements)
```
    Overrides:
    
    setMinimumElements in class FieldDef
  - setMaximumElements
```
public BinaryFieldDef setMaximumElements(Integer maximumElements)
```
    Overrides:
    
    setMaximumElements in class FieldDef
  - setArray
```
public BinaryFieldDef 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 BinaryFieldDef setStrictArrays(boolean strictArrays)
```
    Overrides:
    
    setStrictArrays in class FieldDef
  - setAllowedValues
```
public BinaryFieldDef setAllowedValues(ValueMatch<?> allowedValues)
```
    Overrides:
    
    setAllowedValues in class FieldDef
  - setLimitToAllowedValues
```
public BinaryFieldDef setLimitToAllowedValues(boolean limitToAllowedValues)
```
    Overrides:
    
    setLimitToAllowedValues in class FieldDef
  - setPrimaryKeyPosition
```
public BinaryFieldDef setPrimaryKeyPosition(Integer primaryKeyPosition)
```
    Overrides:
    
    setPrimaryKeyPosition in class FieldDef
  - setPrimaryKeyType
```
public BinaryFieldDef setPrimaryKeyType(PrimaryKeyType primaryKeyType)
```
    Overrides:
    
    setPrimaryKeyType in class FieldDef
  - getMinimumLength
```
public Long getMinimumLength()
```
    The optional least number of bytes in values of this field. Negative values will be set to zero (0).
  - setMinimumLength
```
public BinaryFieldDef setMinimumLength(Long minimumLength)
```
  - getMaximumLength
```
public Long getMaximumLength()
```
    The optional most number of bytes in values of this field. Negative values will be set to the max long (9,223,372,036,854,775,807). Zero (0) is allowed, it means the bytes must always be zero in length.
  - setMaximumLength
```
public BinaryFieldDef setMaximumLength(Long maximumLength)
```
  - setPosition
```
public BinaryFieldDef setPosition(Integer position)
```
    Overrides:
    
    setPosition in class FieldDef
  - setDefaultValueExpression
```
public BinaryFieldDef 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 BinaryFieldDef setExample(String example)
```
    Overrides:
    
    setExample in class FieldDef
  - setAttributes
```
public BinaryFieldDef setAttributes(Attributes attributes)
```
    Overrides:
    
    setAttributes in class FieldDef
  - setTags
```
public BinaryFieldDef 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 BinaryFieldDef 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 BinaryFieldDef 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 BinaryFieldDef

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

BinaryFieldDef

BinaryFieldDef

BinaryFieldDef

Method Detail

getSchemaProblems

clone

validateValueImpl

generateConstructor

generateJavaCode

setEntityDef

setName

setDisplayName

setDescription

setType

setRequired

setMinimumElements

setMaximumElements

setArray

setStrictArrays

setAllowedValues

setLimitToAllowedValues

setPrimaryKeyPosition

setPrimaryKeyType

getMinimumLength

setMinimumLength

getMaximumLength

setMaximumLength

setPosition

setDefaultValueExpression

setExample

setAttributes

setTags

toRecord

fromRecord

toXmlElement

fromXmlElement

hashCode

equals