Class BinaryFieldDef

Method Details

• getSchemaProblems

  public void getSchemaProblems(List<SchemaProblem> problems, boolean includeChildren)

  Description copied from interface: SchemaProblemsSupplier

  Adds this element's problems to the list, plus those of its children when includeChildren is true; the default adds none.

  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

  Description copied from class: FieldDef

  Applies the subclass-specific checks to a single (non-array) value, adding any errors to the result; called after the common type, array and allowed-value checks.

  Specified by:

  validateValueImpl in class FieldDef

  Throws:

  Throwable

• generateConstructor

  protected void generateConstructor(JavaCodeBuilder code, CodeWriter writer)

  Description copied from class: FieldDef

  Writes the constructor call that starts this field's generated Java code; subclasses override it to match their constructors.

  Overrides:

  generateConstructor in class FieldDef

• generateJavaCode

  public void generateJavaCode(JavaCodeBuilder code)

  Description copied from interface: JavaCodeGenerator

  Appends Java source code representing this object to the given builder.

  Specified by:

  generateJavaCode in interface JavaCodeGenerator

  Overrides:

  generateJavaCode in class FieldDef

• setEntityDef

  protected BinaryFieldDef setEntityDef(EntityDef entityDef)

  Description copied from class: FieldDef

  Sets the parent entity; called by EntityDef when this field is added to it.

  Overrides:

  setEntityDef in class FieldDef

• setName

  public BinaryFieldDef setName(String name)

  Overrides:

  setName in class FieldDef

• setDisplayName

  public BinaryFieldDef setDisplayName(String displayName)

  Description copied from class: FieldDef

  Sets the user-friendly name for this field, used instead of the name in validation messages.

  Overrides:

  setDisplayName in class FieldDef

• setDescription

  public BinaryFieldDef setDescription(String description)

  Overrides:

  setDescription in class FieldDef

• setType

  public BinaryFieldDef setType(FieldType type)

  Description copied from class: FieldDef

  Sets the data type of this field; each subclass accepts only its own kind of type, such as numeric types for NumericFieldDef.

  Overrides:

  setType in class FieldDef

• setRequired

  public BinaryFieldDef setRequired(boolean required)

  Description copied from class: FieldDef

  Indicates if this field must be present and not null to pass validation (defaults to false).

  Overrides:

  setRequired in class FieldDef

• setMinimumElements

  public BinaryFieldDef setMinimumElements(Integer minimumElements)

  Description copied from class: FieldDef

  Sets the minimum number of array elements allowed; a non-null value makes this field an array. Negative values are set to zero (0).

  Overrides:

  setMinimumElements in class FieldDef

• setMaximumElements

  public BinaryFieldDef setMaximumElements(Integer maximumElements)

  Description copied from class: FieldDef

  Sets the maximum number of array elements allowed; a non-null value makes this field an array. Negative values are set to the max integer and zero (0) means the array must be empty.

  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)

  Description copied from class: FieldDef

  Indicates if values must match this field's array setting exactly (defaults to true); when false, a single value and a one-element array are interchangeable.

  Overrides:

  setStrictArrays in class FieldDef

• setAllowedValues

  public BinaryFieldDef setAllowedValues(ValueMatch<?> allowedValues)

  Description copied from class: FieldDef

  Sets the optional set of values this field allows; they are enforced only when FieldDef.isLimitToAllowedValues() is true.

  Overrides:

  setAllowedValues in class FieldDef

• setLimitToAllowedValues

  public BinaryFieldDef setLimitToAllowedValues(boolean limitToAllowedValues)

  Description copied from class: FieldDef

  Indicates if values must be one of FieldDef.getAllowedValues() to pass validation (defaults to false).

  Overrides:

  setLimitToAllowedValues in class FieldDef

• setPrimaryKeyPosition

  public BinaryFieldDef setPrimaryKeyPosition(Integer primaryKeyPosition)

  Description copied from class: FieldDef

  Sets the zero-based position of this field in its entity's primary key or null if it is not part of the key.

  Overrides:

  setPrimaryKeyPosition in class FieldDef

• setPrimaryKeyType

  public BinaryFieldDef setPrimaryKeyType(PrimaryKeyType primaryKeyType)

  Description copied from class: FieldDef

  Sets the strategy used to generate this primary key field's values; a primary key position must also be set.

  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)

  Sets the optional least number of bytes in values of this field; negative values are set to zero (0).

• 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)

  Sets the optional most number of bytes in values of this field; negative values are set to the max long and zero (0) means values must be empty.

• setPosition

  public BinaryFieldDef setPosition(Integer position)

  Description copied from class: FieldDef

  Sets the zero-based position of this field in the data or null to locate it by name; mapping renames the field found at this position to this field's name.

  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)

  Description copied from class: FieldDef

  Sets the user-defined key-value pairs attached to this field (null is treated as empty).

  Overrides:

  setAttributes in class FieldDef

• setTags

  public BinaryFieldDef setTags(Tags tags)

  Description copied from class: FieldDef

  Sets the labels used to organize, filter, and classify this field (null is treated as empty).

  Overrides:

  setTags in class FieldDef

• toRecord

  public Record toRecord()

  Description copied from interface: RecordSerializable

  Converts this object's state to a record that RecordSerializable.fromRecord(Record) can load.

  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

  Parameters:

  source -

  Returns:

  this instance.

• toXmlElement

  public Element toXmlElement(Document document)

  Description copied from interface: XmlSerializable

  Returns an element, created with document, describing this object; the default implementation throws a DataException.

  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