Package net.sf.saxon.om
Class AtomicArray
java.lang.Object
net.sf.saxon.om.AtomicArray
- All Implemented Interfaces:
Iterable<AtomicValue>
,AtomicSequence
,GroundedValue
,Sequence
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 -
Constructor Summary
ConstructorsConstructorDescriptionAtomicArray
(List<AtomicValue> content) Create an AtomicArray over a supplied arrayList of atomic valuesAtomicArray
(SequenceIterator iter) Create an AtomicArray supplying the contents as an iterator -
Method Summary
Modifier and TypeMethodDescriptionboolean
Get the effective boolean value of this sequenceGet the canonical lexical representation as defined in XML Schema.int
Get the length of the sequenceGet a Comparable value that implements the XML Schema ordering comparison semantics for this value.Get a string representation of the sequence.Get the value of the item as a CharSequence.head()
Get the first item in the sequenceitemAt
(int n) Get the n'th item in the sequence (base-zero addressing)iterate()
Make an iterator over the items in the sequenceiterator()
Returns a Java iterator over the atomic sequence.reduce()
Reduce the sequence to its simplest form.subsequence
(int start, int length) Get a subsequence of this sequenceMethods 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 java.lang.Iterable
forEach, spliterator
Methods inherited from interface net.sf.saxon.om.Sequence
makeRepeatable
-
Field Details
-
EMPTY_ATOMIC_ARRAY
-
-
Constructor Details
-
AtomicArray
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
Create an AtomicArray supplying the contents as an iterator- Parameters:
iter
- the iterator that supplies the atomic values (which must be position at the start of the sequence, and which will be consumed by the method).- Throws:
XPathException
- if evaluation of the SequenceIterator failsClassCastException
- if any of the items returned by the SequenceIterator is not atomic
-
-
Method Details
-
head
Description copied from interface:AtomicSequence
Get the first item in the sequence- Specified by:
head
in interfaceAtomicSequence
- Specified by:
head
in interfaceGroundedValue
- Specified by:
head
in interfaceSequence
- Returns:
- the first item in the sequence, or null if the sequence is empty
-
iterate
Description copied from interface:AtomicSequence
Make an iterator over the items in the sequence- Specified by:
iterate
in interfaceAtomicSequence
- Specified by:
iterate
in interfaceGroundedValue
- Specified by:
iterate
in interfaceSequence
- Returns:
- an iterator over the items in the sequence
-
itemAt
Get the n'th item in the sequence (base-zero addressing)- Specified by:
itemAt
in interfaceAtomicSequence
- Specified by:
itemAt
in interfaceGroundedValue
- 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 interfaceAtomicSequence
- Specified by:
getLength
in interfaceGroundedValue
- Returns:
- the number of items in the sequence
-
subsequence
Get a subsequence of this sequence- Specified by:
subsequence
in interfaceGroundedValue
- 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 returnedlength
- 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
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 interfaceAtomicSequence
- Returns:
- the canonical lexical representation if defined in XML Schema; otherwise, the result of casting to string according to the XPath 2.0 rules
-
getStringValueCS
Get the value of the item as a CharSequence. This is in some cases more efficient than the version of the method that returns a String.- Specified by:
getStringValueCS
in interfaceAtomicSequence
- Specified by:
getStringValueCS
in interfaceGroundedValue
- Returns:
- a whitespace-separated concatenation of the string values of the items making up the sequence, as a CharSequence.
-
getStringValue
Description copied from interface:AtomicSequence
Get a string representation of the sequence. The is the space-separated concatenation of the result of casting each of the items in the sequence to xs:string- Specified by:
getStringValue
in interfaceAtomicSequence
- Specified by:
getStringValue
in interfaceGroundedValue
- Returns:
- a whitespace-separated concatenation of the string values of the items making up the sequence, as a String.
-
effectiveBooleanValue
Description copied from interface:GroundedValue
Get the effective boolean value of this sequence- Specified by:
effectiveBooleanValue
in interfaceGroundedValue
- Returns:
- the effective boolean value
- Throws:
XPathException
- if the sequence has no effective boolean value (for example a sequence of two integers)
-
getSchemaComparable
Get a Comparable value that implements the XML Schema ordering comparison semantics for this value. The default implementation is written to compare sequences of atomic values. This method is overridden for AtomicValue and its subclasses.In the case of data types that are partially ordered, the returned Comparable extends the standard semantics of the compareTo() method by returning the value
SequenceTool.INDETERMINATE_ORDERING
when there is no defined order relationship between two given values.For comparing key/keyref values, XSD 1.1 defines that a singleton list is equal to its only member. To achieve this, this method returns the schema comparable of the singleton member if the list has length one. This won't give the correct ordering semantics, but we rely on lists never taking part in ordering comparisons.
- Specified by:
getSchemaComparable
in interfaceAtomicSequence
- Returns:
- a Comparable that follows XML Schema comparison rules
-
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 interfaceGroundedValue
- Returns:
- the simplified sequence
-
iterator
Returns a Java iterator over the atomic sequence.- Specified by:
iterator
in interfaceIterable<AtomicValue>
- Returns:
- an Iterator.
-