Field (Data Pipeline JavaDoc)

java.lang.Object
- com.northconcepts.datapipeline.core.Node
- - com.northconcepts.datapipeline.core.Field

All Implemented Interfaces:

Session, ValueNodeContainer, Serializable, Comparable<Field>
```
public final class Field
extends Node
implements ValueNodeContainer, Comparable<Field>, Serializable
```
Field holds persistent key-value data as part of a record. Values in a field can be:
- Single values (boolean, date, string, etc. -- see FieldType)
- Records
- Array of single values, records, and arrays
See Also:

SingleValue, Record, ArrayValue, FieldType, Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class com.northconcepts.datapipeline.core.Node
  Node.DuplicateNodeAction, Node.NodeType
- Nested classes/interfaces inherited from interface com.northconcepts.datapipeline.core.Session
  Session.SessionImpl

Field Summary

Fields
Modifier and Type Field and Description

static int JAVA_ARRAY_SIZE

static int JAVA_OBJECT_SIZE

static int MAX_DISPLAY_STRING
- Fields inherited from class com.northconcepts.datapipeline.core.Node
  session

Fields
Modifier and Type	Field and Description
`static int`	`JAVA_ARRAY_SIZE`
`static int`	`JAVA_OBJECT_SIZE`
`static int`	`MAX_DISPLAY_STRING`

Constructor Summary

Constructors
Modifier Constructor and Description

protected Field(Record record)

Constructors
Modifier	Constructor and Description
`protected`	`Field(Record record)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Field`	`addNull(FieldType type)`
`Field`	`addValue(FieldType type, Object value)`
`Field`	`addValue(Object value)`
`int`	`compareTo(Field field)`
`int`	`compareTo(Field field, Collator collator)`
`Field`	`copyFrom(Field field)`
`Field`	`copyFrom(Field field, boolean copyName)`
`boolean`	`equals(Object o)`
`boolean`	`equals(Object o, Collator collator)`
`Field`	`forceValueAsArray()` Converts this field's value to an array if it's not already one, otherwise no change is made.
`int`	`getIndex()` Returns the position of this field within its record.
`String`	`getName()`
`String`	`getName(boolean nullToDefaultName)`
`Node.NodeType`	`getNodeType()`
`Node`	`getParentNode()`
`Record`	`getParentRecord()` Returns the closest parent record that this node is the child of, otherwise null if one does not exist.
`Record`	`getRecord()` Returns the record this field belongs to.
`long`	`getSizeInBytes()`
`long`	`getSizeOfNameInBytes()`
`FieldType`	`getType()`
`Object`	`getValue()`
`ArrayValue`	`getValueAsArray()` Retrieve the field's value as an `ArrayValue`.
`ArrayValue`	`getValueAsArray(boolean force)` Retrieve the field's value as an `ArrayValue`.
`BigDecimal`	`getValueAsBigDecimal()`
`BigInteger`	`getValueAsBigInteger()`
`boolean`	`getValueAsBoolean()`
`byte`	`getValueAsByte()`
`byte[]`	`getValueAsBytes()`
`char`	`getValueAsChar()`
`Date`	`getValueAsDate()`
`Date`	`getValueAsDatetime()`
`double`	`getValueAsDouble()`
`float`	`getValueAsFloat()`
`Instant`	`getValueAsInstant()`
`int`	`getValueAsInteger()`
`<T> List<T>`	`getValueAsList(boolean force, Class<T> elementType)` Retrieve the field's value as a `List`.
`LocalDate`	`getValueAsLocalDate()`
`LocalDateTime`	`getValueAsLocalDateTime()`
`LocalTime`	`getValueAsLocalTime()`
`long`	`getValueAsLong()`
`Record`	`getValueAsRecord()`
`short`	`getValueAsShort()`
`SingleValue`	`getValueAsSingleValue()`
`String`	`getValueAsString()`
`Time`	`getValueAsTime()`
`UUID`	`getValueAsUuid()`
`ValueNode<?>`	`getValueNode()`
`boolean`	`hasChildNodes()` Returns `true` if this node contains any sub nodes.
`boolean`	`hasChildRecords()` Returns `true` if this node contains any descendant, record nodes.
`int`	`hashCode()`
`boolean`	`hasValue()` Returns `true` if this field has been set to a value, including `null`.
`boolean`	`isArray()`
`boolean`	`isNotArray()`
`boolean`	`isNotNull()` Returns `true` if this node does not contain a null value.
`boolean`	`isNotRecord()`
`boolean`	`isNotSingleValue()`
`boolean`	`isNull()` Returns `true` if this node contains a null value.
`boolean`	`isRecord()`
`boolean`	`isSingleValue()`
`boolean`	`isValueNotSet()`
`boolean`	`isValueSet()`
`boolean`	`remove()` Removes this field from its parent record.
`protected void`	`removeChildNode(Node child)`
`Field`	`setName(String name)`
`Field`	`setNull(FieldType type)`
`Field`	`setValue(BigDecimal value)`
`Field`	`setValue(BigInteger value)`
`Field`	`setValue(boolean value)`
`Field`	`setValue(byte value)`
`Field`	`setValue(byte[] value)`
`Field`	`setValue(char value)`
`Field`	`setValue(Date value)`
`Field`	`setValue(Date value)`
`Field`	`setValue(double value)`
`Field`	`setValue(float value)`
`Field`	`setValue(Instant value)`
`Field`	`setValue(int value)`
`Field`	`setValue(LocalDate value)`
`Field`	`setValue(LocalDateTime value)`
`Field`	`setValue(LocalTime value)`
`Field`	`setValue(long value)`
`Field`	`setValue(Object value)`
`Field`	`setValue(Record value)`
`Field`	`setValue(short value)`
`Field`	`setValue(String value)`
`Field`	`setValue(Time value)`
`Field`	`setValue(UUID value)`
`String`	`toString()`

Methods inherited from class com.northconcepts.datapipeline.core.Node
assertNotAncestorOf, containsSessionProperty, containsSessionProperty, containsSessionProperty, copySessionPropertiesFrom, getNodeDepth, getParentField, getSessionProperty, getSessionProperty, getSessionProperty, isAncestorOf, isChildNode, isValueNode, keySet, setSessionProperty, setSessionProperty, setSessionProperty

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - MAX_DISPLAY_STRING
```
public static final int MAX_DISPLAY_STRING
```
    See Also:
    
    Constant Field Values
  - JAVA_OBJECT_SIZE
```
public static final int JAVA_OBJECT_SIZE
```
    See Also:
    
    Constant Field Values
  - JAVA_ARRAY_SIZE
```
public static final int JAVA_ARRAY_SIZE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Field
```
protected Field(Record record)
```
- Method Detail
  - getNodeType
```
public Node.NodeType getNodeType()
```
    Specified by:
    
    getNodeType in class Node
  - hasChildNodes
```
public boolean hasChildNodes()
```
    Description copied from class: Node
    
    Returns true if this node contains any sub nodes.
    
    Specified by:
    
    hasChildNodes in class Node
  - hasChildRecords
```
public boolean hasChildRecords()
```
    Description copied from class: Node
    
    Returns true if this node contains any descendant, record nodes.
    
    Specified by:
    
    hasChildRecords in class Node
  - removeChildNode
```
protected void removeChildNode(Node child)
```
    Specified by:
    
    removeChildNode in class Node
  - copyFrom
```
public Field copyFrom(Field field)
```
  - copyFrom
```
public Field copyFrom(Field field,
                      boolean copyName)
```
  - toString
```
public String toString()
```
    Specified by:
    
    toString in class Node
  - remove
```
public boolean remove()
```
    Removes this field from its parent record.
    
    Returns:
    
    true if the record contained this field (i.e. the field hadn't already been removed).
  - getIndex
```
public int getIndex()
```
    Returns the position of this field within its record.
  - getName
```
public String getName()
```
  - getName
```
public String getName(boolean nullToDefaultName)
```
  - setName
```
public Field setName(String name)
```
  - getType
```
public FieldType getType()
```
  - isArray
```
public boolean isArray()
```
  - isNotArray
```
public boolean isNotArray()
```
  - isRecord
```
public boolean isRecord()
```
  - isSingleValue
```
public boolean isSingleValue()
```
  - isNotSingleValue
```
public boolean isNotSingleValue()
```
  - isNotRecord
```
public boolean isNotRecord()
```
  - forceValueAsArray
```
public Field forceValueAsArray()
```
    Converts this field's value to an array if it's not already one, otherwise no change is made.
  - isValueSet
```
public boolean isValueSet()
```
  - isValueNotSet
```
public boolean isValueNotSet()
```
  - hasValue
```
public boolean hasValue()
```
    Returns true if this field has been set to a value, including null. Otherwise, it returns false. This method is an alias for isValueSet().
    
    Specified by:
    
    hasValue in interface ValueNodeContainer
  - isNull
```
public boolean isNull()
```
    Description copied from class: Node
    
    Returns true if this node contains a null value. In concrete terms, only Field and SingleValue can contain nulls while not being null themselves. Both Record and ArrayValue will return false even if they have no values or null only values.
    
    Specified by:
    
    isNull in class Node
  - isNotNull
```
public boolean isNotNull()
```
    Description copied from class: Node
    
    Returns true if this node does not contain a null value. In concrete terms, only Field and SingleValue can contain nulls while not being null themselves. Both Record and ArrayValue will return true even if they have no values or null only values.
    
    Specified by:
    
    isNotNull in class Node
  - addValue
```
public Field addValue(FieldType type,
                      Object value)
```
    Specified by:
    
    addValue in interface ValueNodeContainer
  - setValue
```
public Field setValue(Object value)
```
  - addValue
```
public Field addValue(Object value)
```
    Specified by:
    
    addValue in interface ValueNodeContainer
  - setNull
```
public Field setNull(FieldType type)
```
  - addNull
```
public Field addNull(FieldType type)
```
    Specified by:
    
    addNull in interface ValueNodeContainer
  - compareTo
```
public int compareTo(Field field)
```
    Specified by:
    
    compareTo in interface Comparable<Field>
  - compareTo
```
public int compareTo(Field field,
                     Collator collator)
```
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - equals
```
public boolean equals(Object o,
                      Collator collator)
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - getSizeOfNameInBytes
```
public long getSizeOfNameInBytes()
```
  - getSizeInBytes
```
public long getSizeInBytes()
```
  - getRecord
```
public Record getRecord()
```
    Returns the record this field belongs to.
  - getParentRecord
```
public Record getParentRecord()
```
    Description copied from class: Node
    
    Returns the closest parent record that this node is the child of, otherwise null if one does not exist.
    
    Overrides:
    
    getParentRecord in class Node
    
    See Also:
    
    Node.getParentField(), Node.isChildNode(), Node.hasChildRecords(), Node.getNodeDepth(), getValueAsRecord(), Field#getValueAsRecords()
  - getParentNode
```
public Node getParentNode()
```
    Specified by:
    
    getParentNode in class Node
  - getValue
```
public Object getValue()
```
  - getValueNode
```
public ValueNode<?> getValueNode()
```
  - getValueAsArray
```
public ArrayValue getValueAsArray()
```
    Retrieve the field's value as an ArrayValue.
  - getValueAsArray
```
public ArrayValue getValueAsArray(boolean force)
```
    Retrieve the field's value as an ArrayValue. An exception will be thrown when typecasting if the value is not an ArrayValue.
  - getValueAsList
```
public <T> List<T> getValueAsList(boolean force,
                                  Class<T> elementType)
```
    Retrieve the field's value as a List.
    
    Type Parameters:
    
    T - The list's parameterized element type
    
    Parameters:
    
    force - indicates if a field containing a single value should be forced to become an ArrayValue of one element, otherwise, an exception will be thrown when the typecast to ArrayValue fails.
    
    elementType - the target Class of the list's elements. This is used internally to coerce the actual value into this desired type.
  - getValueAsRecord
```
public Record getValueAsRecord()
```
  - getValueAsSingleValue
```
public SingleValue getValueAsSingleValue()
```
  - getValueAsString
```
public String getValueAsString()
```
  - getValueAsDatetime
```
public Date getValueAsDatetime()
```
  - getValueAsDate
```
public Date getValueAsDate()
```
  - getValueAsTime
```
public Time getValueAsTime()
```
  - getValueAsInteger
```
public int getValueAsInteger()
```
  - getValueAsLong
```
public long getValueAsLong()
```
  - getValueAsShort
```
public short getValueAsShort()
```
  - getValueAsByte
```
public byte getValueAsByte()
```
  - getValueAsBoolean
```
public boolean getValueAsBoolean()
```
  - getValueAsChar
```
public char getValueAsChar()
```
  - getValueAsDouble
```
public double getValueAsDouble()
```
  - getValueAsFloat
```
public float getValueAsFloat()
```
  - getValueAsBytes
```
public byte[] getValueAsBytes()
```
  - getValueAsBigDecimal
```
public BigDecimal getValueAsBigDecimal()
```
  - getValueAsBigInteger
```
public BigInteger getValueAsBigInteger()
```
  - getValueAsInstant
```
public Instant getValueAsInstant()
```
  - getValueAsLocalDateTime
```
public LocalDateTime getValueAsLocalDateTime()
```
  - getValueAsLocalDate
```
public LocalDate getValueAsLocalDate()
```
  - getValueAsLocalTime
```
public LocalTime getValueAsLocalTime()
```
  - getValueAsUuid
```
public UUID getValueAsUuid()
```
  - setValue
```
public Field setValue(String value)
```
  - setValue
```
public Field setValue(Date value)
```
  - setValue
```
public Field setValue(Date value)
```
  - setValue
```
public Field setValue(Time value)
```
  - setValue
```
public Field setValue(int value)
```
  - setValue
```
public Field setValue(long value)
```
  - setValue
```
public Field setValue(short value)
```
  - setValue
```
public Field setValue(byte value)
```
  - setValue
```
public Field setValue(boolean value)
```
  - setValue
```
public Field setValue(char value)
```
  - setValue
```
public Field setValue(double value)
```
  - setValue
```
public Field setValue(float value)
```
  - setValue
```
public Field setValue(byte[] value)
```
  - setValue
```
public Field setValue(BigDecimal value)
```
  - setValue
```
public Field setValue(BigInteger value)
```
  - setValue
```
public Field setValue(Record value)
```
  - setValue
```
public Field setValue(Instant value)
```
  - setValue
```
public Field setValue(LocalDateTime value)
```
  - setValue
```
public Field setValue(LocalDate value)
```
  - setValue
```
public Field setValue(LocalTime value)
```
  - setValue
```
public Field setValue(UUID value)
```

Class Field

Nested Class Summary

Nested classes/interfaces inherited from class com.northconcepts.datapipeline.core.Node

Nested classes/interfaces inherited from interface com.northconcepts.datapipeline.core.Session

Field Summary

Fields inherited from class com.northconcepts.datapipeline.core.Node

Constructor Summary

Method Summary

Methods inherited from class com.northconcepts.datapipeline.core.Node

Methods inherited from class java.lang.Object

Field Detail

MAX_DISPLAY_STRING

JAVA_OBJECT_SIZE

JAVA_ARRAY_SIZE

Constructor Detail

Field

Method Detail

getNodeType

hasChildNodes

hasChildRecords

removeChildNode

copyFrom

copyFrom

toString

remove

getIndex

getName

getName

setName

getType

isArray

isNotArray

isRecord

isSingleValue

isNotSingleValue

isNotRecord

forceValueAsArray

isValueSet

isValueNotSet

hasValue

isNull

isNotNull

addValue

setValue

addValue

setNull

addNull

compareTo

compareTo

equals

equals

hashCode

getSizeOfNameInBytes

getSizeInBytes

getRecord

getParentRecord

getParentNode

getValue

getValueNode

getValueAsArray

getValueAsArray

getValueAsList

getValueAsRecord

getValueAsSingleValue

getValueAsString

getValueAsDatetime

getValueAsDate

getValueAsTime

getValueAsInteger

getValueAsLong

getValueAsShort

getValueAsByte

getValueAsBoolean

getValueAsChar

getValueAsDouble

getValueAsFloat

getValueAsBytes

getValueAsBigDecimal

getValueAsBigInteger

getValueAsInstant