net.sf.saxon.om

Class AtomicArray

java.lang.Object

net.sf.saxon.om.AtomicArray

All Implemented Interfaces:

java.lang.Iterable<AtomicValue>, AtomicSequence, GroundedValue, Sequence

public class AtomicArray
extends java.lang.Object
implements AtomicSequence

A sequence of atomic values, implemented using an underlying arrayList.

Often used for representing the typed value of a list-valued node.

Since:

9.5

Field Summary

Fields

Modifier and Type	Field and Description
static AtomicArray	EMPTY_ATOMIC_ARRAY

Constructor Summary

Constructors

Constructor and Description
AtomicArray(java.util.List<AtomicValue> content) Create an AtomicArray over a supplied arrayList of atomic values
AtomicArray(SequenceIterator iter) Create an AtomicArray supplying the contents as an iterator

Method Summary

Modifier and Type	Method and Description
boolean	effectiveBooleanValue() Get the effective boolean value of this sequence
UnicodeString	getCanonicalLexicalRepresentation() Get the canonical lexical representation as defined in XML Schema.
int	getLength() Get the length of the sequence
java.lang.String	getStringValue() Get the value of the item as a UnicodeString.
UnicodeString	getUnicodeStringValue() Get the value of the item as a UnicodeString.
AtomicValue	head() Get the first item in the sequence
AtomicValue	itemAt(int n) Get the n'th item in the sequence (base-zero addressing)
AtomicIterator	iterate() Make an iterator over the items in the sequence
java.util.Iterator<AtomicValue>	iterator() Returns a Java iterator over the atomic sequence.
GroundedValue	reduce() Reduce the sequence to its simplest form.
AtomicArray	subsequence(int start, int length) Get a subsequence of this sequence

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.sf.saxon.om.GroundedValue

asIterable, concatenate, containsNode, materialize, toShortString

Methods inherited from interface net.sf.saxon.om.Sequence

makeRepeatable

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

EMPTY_ATOMIC_ARRAY

public static AtomicArray EMPTY_ATOMIC_ARRAY

Constructor Detail

AtomicArray

public AtomicArray(java.util.List<AtomicValue> content)

Create an AtomicArray over a supplied arrayList of atomic values

Parameters:

content - the supplied arrayList. The caller warrants that the contents of this array will not change.

AtomicArray

public AtomicArray(SequenceIterator iter)
            throws XPathException

Create an AtomicArray supplying the contents as an iterator

Parameters:

iter - the iterator that supplies the atomic values (which must be positioned at the start of the sequence, and which will be consumed by the method).

Throws:

XPathException - if evaluation of the SequenceIterator fails

java.lang.ClassCastException - if any of the items returned by the SequenceIterator is not atomic

Method Detail

head

public AtomicValue head()

Description copied from interface: AtomicSequence

Get the first item in the sequence

Specified by:

head in interface AtomicSequence

Specified by:

head in interface GroundedValue

Specified by:

head in interface Sequence

Returns:

the first item in the sequence, or null if the sequence is empty

iterate

public AtomicIterator iterate()

Description copied from interface: AtomicSequence

Make an iterator over the items in the sequence

Specified by:

iterate in interface AtomicSequence

Specified by:

iterate in interface GroundedValue

Specified by:

iterate in interface Sequence

Returns:

an iterator over the items in the sequence

itemAt

public AtomicValue itemAt(int n)

Get the n'th item in the sequence (base-zero addressing)

Specified by:

itemAt in interface AtomicSequence

Specified by:

itemAt in interface GroundedValue

Parameters:

n - the index of the required item, the first item being zero

Returns:

the n'th item if n is in range, or null otherwise

getLength

public int getLength()

Get the length of the sequence

Specified by:

getLength in interface AtomicSequence

Specified by:

getLength in interface GroundedValue

Returns:

the number of items in the sequence

subsequence

public AtomicArray subsequence(int start,
                               int length)

Get a subsequence of this sequence

Specified by:

subsequence in interface GroundedValue

Parameters:

start - the index of the first item to be included in the result, counting from zero. A negative value is taken as zero. If the value is beyond the end of the sequence, an empty sequence is returned

length - the number of items to be included in the result. Specify Integer.MAX_VALUE to get the subsequence up to the end of the base sequence. If the value is negative, an empty sequence is returned. If the value goes off the end of the sequence, the result returns items up to the end of the sequence

Returns:

the required subsequence

getCanonicalLexicalRepresentation

public UnicodeString getCanonicalLexicalRepresentation()

Get the canonical lexical representation as defined in XML Schema. This is not always the same as the result of casting to a string according to the XPath rules.

Specified by:

getCanonicalLexicalRepresentation in interface AtomicSequence

Returns:

the canonical lexical representation if defined in XML Schema; otherwise, the result of casting to string according to the XPath 2.0 rules

getUnicodeStringValue

public UnicodeString getUnicodeStringValue()

Get the value of the item as a UnicodeString. This is in some cases more efficient than the version of the method that returns a String.

Specified by:

getUnicodeStringValue in interface AtomicSequence

Specified by:

getUnicodeStringValue in interface GroundedValue

Returns:

the string value, as a UnicodeString

getStringValue

public java.lang.String getStringValue()

Get the value of the item as a UnicodeString. This is in some cases more efficient than the version of the method that returns a String.

Specified by:

getStringValue in interface GroundedValue

Returns:

the string value, as a UnicodeString

effectiveBooleanValue

public boolean effectiveBooleanValue()
                              throws XPathException

Description copied from interface: GroundedValue

Get the effective boolean value of this sequence

Specified by:

effectiveBooleanValue in interface GroundedValue

Returns:

the effective boolean value

Throws:

XPathException - if the sequence has no effective boolean value (for example a sequence of two integers)

reduce

public GroundedValue reduce()

Reduce the sequence to its simplest form. If the value is an empty sequence, the result will be EmptySequence.getInstance(). If the value is a single atomic value, the result will be an instance of AtomicValue. If the value is a single item of any other kind, the result will be an instance of SingletonItem. Otherwise, the result will typically be unchanged.

Specified by:

reduce in interface GroundedValue

Returns:

the simplified sequence

iterator

public java.util.Iterator<AtomicValue> iterator()

Returns a Java iterator over the atomic sequence.

Specified by:

iterator in interface java.lang.Iterable<AtomicValue>

Returns:

an Iterator.