esa.opensf.osfi

Class ArrayNode<V,S extends ArrayNode<V,S>>

java.lang.Object

esa.opensf.osfi.ArrayNode<V,S>

Type Parameters:

V - Type used to store values. May be an array for parsed nodes, or a String for unparsed.

S - CRTP parameter, used so that getSubNodes() and similar return the same type.

Direct Known Subclasses:

ArrayNode.Parsed, ArrayNode.Raw

public abstract class ArrayNode<V,S extends ArrayNode<V,S>>
extends java.lang.Object

Class that represents a tree with data (leaf) nodes and internal nodes. The data may be raw (a String with the unparsed values) or fully parsed.

See Also:

Class representing unparsed array nodes.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ArrayNode.Parsed<A> A parsed tree that represents the values of (part of) an ARRAY-valued parameter.
static class	ArrayNode.Raw An unparsed tree that represents (part of) an ARRAY-valued parameter.

Field Summary

Fields

Modifier and Type	Field and Description
protected V	elems Elements for a data node.

Constructor Summary

Constructors

Constructor and Description
ArrayNode(java.util.List<? extends S> subNodes) Create an internal node with the given subnodes.
ArrayNode(V values) Create a data node with the given values.

Method Summary

Modifier and Type	Method and Description
protected boolean	dataEquals(ArrayNode<?,?> other) Comparison of data values, override if more fields need to be compared.
protected int	dataHashCode() Hash code of data values, override if more fields need to be considered.
protected abstract java.lang.String	dataToStr() String version of the data elements.
boolean	equals(java.lang.Object other)
V	getData() Returns the raw data elements, or null if this is an internal node without data.
V	getDataAtSub(int... indices) Return the data at the given index position in the tree.
protected abstract int	getDataDim() For data nodes, return the size of the data elements.
int	getDim() Get the size of this array node (i.e.
java.util.List<java.lang.Integer>	getDimsEnvelope() Compute the rectangular envelope for the dimensions of this array node, considering all nodes below it in the tree.
S	getSubNodeAt(int... indices) Return the subnode at the given index position in the tree.
java.util.List<S>	getSubNodes() Returns the list of subnodes, or the empty list if this is a data node without subnodes.
int	hashCode()
boolean	isDataNode() Returns true if this node was built with data elements, false if it was built with subnodes.
java.lang.String	toString() Return a user-understandable representation of the tree, useful for debugging.

Methods inherited from class java.lang.Object

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

Field Detail

elems

protected final V elems

Elements for a data node. If null, this is an internal node.

Constructor Detail

ArrayNode

public ArrayNode(V values)

Create a data node with the given values.

ArrayNode

public ArrayNode(java.util.List<? extends S> subNodes)

Create an internal node with the given subnodes.

Method Detail

isDataNode

public final boolean isDataNode()

Returns true if this node was built with data elements, false if it was built with subnodes.

getData

public V getData()

Returns the raw data elements, or null if this is an internal node without data.

getSubNodes

public final java.util.List<S> getSubNodes()

Returns the list of subnodes, or the empty list if this is a data node without subnodes.

getSubNodeAt

public final S getSubNodeAt(int... indices)

Return the subnode at the given index position in the tree. Equivalent to calling s = s.getSubNodes().get(i) for each index given, with s initially equal to this object. The final s value is returned.

Parameters:

indices - Index values for each dimension.

getDataAtSub

public final V getDataAtSub(int... indices)

Return the data at the given index position in the tree. Equivalent to getSubNodeAt(indices).getData(), except in the case that indices is empty, in which this method does return the result of calling getData() on this instead of throwing.

Parameters:

indices - Index values for each dimension.

See Also:

getData(), getSubNodeAt(int...)

getDim

public final int getDim()

Get the size of this array node (i.e. of this dimension level).

getDataDim

protected abstract int getDataDim()

For data nodes, return the size of the data elements.

getDimsEnvelope

public final java.util.List<java.lang.Integer> getDimsEnvelope()

Compute the rectangular envelope for the dimensions of this array node, considering all nodes below it in the tree.

toString

public java.lang.String toString()

Return a user-understandable representation of the tree, useful for debugging.

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object

Returns:

true if the data/subnodes of this node match those on other for a data/internal node respectively.

dataEquals

protected boolean dataEquals(ArrayNode<?,?> other)

Comparison of data values, override if more fields need to be compared.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

dataHashCode

protected int dataHashCode()

Hash code of data values, override if more fields need to be considered.

dataToStr

protected abstract java.lang.String dataToStr()

String version of the data elements.