com.northconcepts.datapipeline.core

Class ArrayValue

java.lang.Object

com.northconcepts.datapipeline.core.Node

com.northconcepts.datapipeline.core.ValueNode<ArrayValue>

com.northconcepts.datapipeline.core.ArrayValue

All Implemented Interfaces:

Session, ValueNodeContainer, Serializable, Cloneable, Comparable<ValueNode<ArrayValue>>, Iterable<ValueNode<?>>

public final class ArrayValue
extends ValueNode<ArrayValue>
implements ValueNodeContainer, Iterable<ValueNode<?>>

ArrayValue holds an ordered collection (also known as a sequence) of persistent data. Data elements can be single values, records, sub arrays, or any combination. If ArrayValue has elements, its getType() method will return a FieldType matching all elements or FieldType.UNDEFINED if elements contain different types. If ArrayValue has no elements, its defaultType will be returned.

See Also:

SingleValue, Record, Node, Field, 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 inherited from class com.northconcepts.datapipeline.core.Node

session

Constructor Summary

Constructors

Constructor and Description
ArrayValue()
ArrayValue(FieldType defaultType) Creates a new empty array.
ArrayValue(Object... collection)

Method Summary

Modifier and Type	Method and Description
ArrayValue	addAll(ArrayValue array)
ArrayValue	addNull(FieldType type)
ArrayValue	addNull(int index, FieldType type)
ArrayValue	addValue(FieldType type, Object element)
ArrayValue	addValue(int index, FieldType type, Object element)
ArrayValue	addValue(int index, Object element)
ArrayValue	addValue(Object element)
ArrayValue	clone()
int	compareTo(ValueNode<ArrayValue> o)
ArrayValue	ensureCapacity(int minCapacity)
boolean	equals(Object o)
void	forEach(Consumer<? super ValueNode<?>> consumer) Performs the given action for each element in this array.
protected static ArrayValue	fromArray(Object array)
FieldType	getDefaultType()
int	getNodeDepth() Returns this node's distance from its root node.
Node.NodeType	getNodeType()
long	getSizeInBytes()
FieldType	getType() Returns defaultType if there are no elements, the FieldType matching all elements if they are the same or FieldType.UNDEFINED if elements contain multiple types.
ArrayValue	getValue()
Object	getValue(int index) Returns the value at the specified index (for zero or positive indexes) or from the end of the list (for negative indexes by adding index to the size of the list).
ArrayValue	getValueAsArray(int index)
BigDecimal	getValueAsBigDecimal(int index)
BigInteger	getValueAsBigInteger(int index)
boolean	getValueAsBoolean(int index)
byte	getValueAsByte(int index)
byte[]	getValueAsBytes(int index)
char	getValueAsChar(int index)
Date	getValueAsDate(int index)
Date	getValueAsDatetime(int index)
double	getValueAsDouble(int index)
float	getValueAsFloat(int index)
Instant	getValueAsInstant(int index)
int	getValueAsInteger(int index)
<T> List<T>	getValueAsList(int index, Class<T> elementType) Returns the array element value at the specified index as a List with each element coerced to the specified type.
LocalDate	getValueAsLocalDate(int index)
LocalDateTime	getValueAsLocalDateTime(int index)
LocalTime	getValueAsLocalTime(int index)
long	getValueAsLong(int index)
Record	getValueAsRecord(int index)
short	getValueAsShort(int index)
SingleValue	getValueAsSingleValue(int index)
String	getValueAsString()
String	getValueAsString(int index)
Time	getValueAsTime(int index)
UUID	getValueAsUuid(int index)
ValueNode<?>	getValueNode(int index) Returns the value node at the specified index (for zero or positive indexes) or from the end of the list (for negative indexes by adding index to the size of the list).
List<Object>	getValues() Returns a list of values.
<T> List<T>	getValues(Class<T> elementType) Returns a list of values with each element coerced to the supplied type.
Stream<Object>	getValueStream() Returns a stream of values.
<T> Stream<T>	getValueStream(Class<T> elementType) Returns a stream of values with each element coerced to the supplied type.
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 container has had any value added, including null.
int	indexOfNode(Node child)
int	indexOfValue(Object value)
boolean	isArray()
boolean	isEmpty() Returns true if this array contains no elements -- equivalent to size() == 0.
boolean	isNotEmpty() Returns true if this array contains elements -- equivalent to size() > 0.
boolean	isRecord()
boolean	isSingleValue()
Iterator<ValueNode<?>>	iterator()
Stream<ValueNode<?>>	parallelStream() Returns a parallel Stream of the elements in this array.
protected void	removeChildNode(Node child)
Object	removeValue(int index)
boolean	removeValue(Object value)
ArrayValue	setDefaultType(FieldType defaultType)
ArrayValue	setNull(int index, FieldType type)
ArrayValue	setValue(int index, FieldType type, Object element)
ArrayValue	setValue(int index, Object element)
int	size()
Stream<ValueNode<?>>	stream() Returns a sequential Stream of the elements in this array.
byte[]	toBinary()
String	toJson()
String	toString()
String	toXml()

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

asArray, from, getParentNode, isNotArray, isNotNull, isNotRecord, isNotSingleValue, isNull, isValueNode, nullValue, nullValue, setParentNode

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

assertNotAncestorOf, containsSessionProperty, containsSessionProperty, containsSessionProperty, copySessionPropertiesFrom, getParentField, getParentRecord, getSessionProperty, getSessionProperty, getSessionProperty, isAncestorOf, isChildNode, keySet, setSessionProperty, setSessionProperty, setSessionProperty

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

spliterator

Constructor Detail

ArrayValue

public ArrayValue()

ArrayValue

public ArrayValue(FieldType defaultType)

Creates a new empty array.

Parameters:

defaultType - the value returned by getType() if there are no elements.

ArrayValue

public ArrayValue(Object... collection)

Method Detail

ensureCapacity

public ArrayValue ensureCapacity(int minCapacity)

iterator

public Iterator<ValueNode<?>> iterator()

Specified by:

iterator in interface Iterable<ValueNode<?>>

addValue

public ArrayValue addValue(FieldType type,
                           Object element)

Specified by:

addValue in interface ValueNodeContainer

addValue

public ArrayValue addValue(Object element)

Specified by:

addValue in interface ValueNodeContainer

addAll

public ArrayValue addAll(ArrayValue array)

addValue

public ArrayValue addValue(int index,
                           FieldType type,
                           Object element)

addValue

public ArrayValue addValue(int index,
                           Object element)

setValue

public ArrayValue setValue(int index,
                           FieldType type,
                           Object element)

setValue

public ArrayValue setValue(int index,
                           Object element)

addNull

public ArrayValue addNull(FieldType type)

Specified by:

addNull in interface ValueNodeContainer

addNull

public ArrayValue addNull(int index,
                          FieldType type)

setNull

public ArrayValue setNull(int index,
                          FieldType type)

removeValue

public Object removeValue(int index)

removeValue

public boolean removeValue(Object value)

getDefaultType

public FieldType getDefaultType()

setDefaultType

public ArrayValue setDefaultType(FieldType defaultType)

getType

public FieldType getType()

Returns defaultType if there are no elements, the FieldType matching all elements if they are the same or FieldType.UNDEFINED if elements contain multiple types.

Specified by:

getType in class ValueNode<ArrayValue>

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

indexOfNode

public int indexOfNode(Node child)

indexOfValue

public int indexOfValue(Object value)

getNodeDepth

public int getNodeDepth()

Description copied from class: Node

Returns this node's distance from its root node. It returns 0 if it is the root node (i.e. it has no parents), 1 if it is the direct child of the root node, 2 if it is the grandchild of the root, and so on.

Overrides:

getNodeDepth in class Node

isArray

public boolean isArray()

Specified by:

isArray in class ValueNode<ArrayValue>

isRecord

public boolean isRecord()

Specified by:

isRecord in class ValueNode<ArrayValue>

isSingleValue

public boolean isSingleValue()

Specified by:

isSingleValue in class ValueNode<ArrayValue>

size

public int size()

isEmpty

public boolean isEmpty()

Returns true if this array contains no elements -- equivalent to size() == 0.

isNotEmpty

public boolean isNotEmpty()

Returns true if this array contains elements -- equivalent to size() > 0.

hasValue

public boolean hasValue()

Description copied from interface: ValueNodeContainer

Returns true if this container has had any value added, including null. Otherwise, it returns false.

Specified by:

hasValue in interface ValueNodeContainer

getValue

public Object getValue(int index)

Returns the value at the specified index (for zero or positive indexes) or from the end of the list (for negative indexes by adding index to the size of the list).

getValues

public List<Object> getValues()

Returns a list of values.

getValues

public <T> List<T> getValues(Class<T> elementType)

Returns a list of values with each element coerced to the supplied type.

getValueStream

public Stream<Object> getValueStream()

Returns a stream of values.

getValueStream

public <T> Stream<T> getValueStream(Class<T> elementType)

Returns a stream of values with each element coerced to the supplied type.

getValueNode

public ValueNode<?> getValueNode(int index)

Returns the value node at the specified index (for zero or positive indexes) or from the end of the list (for negative indexes by adding index to the size of the list).

forEach

public void forEach(Consumer<? super ValueNode<?>> consumer)

Performs the given action for each element in this array.

Specified by:

forEach in interface Iterable<ValueNode<?>>

stream

public Stream<ValueNode<?>> stream()

Returns a sequential Stream of the elements in this array.

parallelStream

public Stream<ValueNode<?>> parallelStream()

Returns a parallel Stream of the elements in this array.

getValueAsArray

public ArrayValue getValueAsArray(int index)

getValueAsList

public <T> List<T> getValueAsList(int index,
                                  Class<T> elementType)

Returns the array element value at the specified index as a List with each element coerced to the specified type. See FieldPath for supported fieldPath expressions.

getValueAsRecord

public Record getValueAsRecord(int index)

getValueAsSingleValue

public SingleValue getValueAsSingleValue(int index)

getValueAsString

public String getValueAsString(int index)

getValueAsDatetime

public Date getValueAsDatetime(int index)

getValueAsDate

public Date getValueAsDate(int index)

getValueAsTime

public Time getValueAsTime(int index)

getValueAsInteger

public int getValueAsInteger(int index)

getValueAsLong

public long getValueAsLong(int index)

getValueAsShort

public short getValueAsShort(int index)

getValueAsByte

public byte getValueAsByte(int index)

getValueAsBoolean

public boolean getValueAsBoolean(int index)

getValueAsChar

public char getValueAsChar(int index)

getValueAsDouble

public double getValueAsDouble(int index)

getValueAsFloat

public float getValueAsFloat(int index)

getValueAsBytes

public byte[] getValueAsBytes(int index)

getValueAsBigDecimal

public BigDecimal getValueAsBigDecimal(int index)

getValueAsBigInteger

public BigInteger getValueAsBigInteger(int index)

getValueAsInstant

public Instant getValueAsInstant(int index)

getValueAsLocalDateTime

public LocalDateTime getValueAsLocalDateTime(int index)

getValueAsLocalDate

public LocalDate getValueAsLocalDate(int index)

getValueAsLocalTime

public LocalTime getValueAsLocalTime(int index)

getValueAsUuid

public UUID getValueAsUuid(int index)

getValue

public ArrayValue getValue()

Specified by:

getValue in class ValueNode<ArrayValue>

getValueAsString

public String getValueAsString()

Specified by:

getValueAsString in class ValueNode<ArrayValue>

getSizeInBytes

public long getSizeInBytes()

Specified by:

getSizeInBytes in class ValueNode<ArrayValue>

compareTo

public int compareTo(ValueNode<ArrayValue> o)

Specified by:

compareTo in interface Comparable<ValueNode<ArrayValue>>

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public ArrayValue clone()

Specified by:

clone in class ValueNode<ArrayValue>

toString

public String toString()

Specified by:

toString in class Node

toJson

public String toJson()

toXml

public String toXml()

toBinary

public byte[] toBinary()

fromArray

protected static ArrayValue fromArray(Object array)