public final class SequenceExtent extends Value implements GroundedValue
INDETERMINATE_ORDERING
EMPTY_VALUE_ARRAY
Constructor and Description |
---|
SequenceExtent(Item[] items)
Construct an sequence from an array of items.
|
SequenceExtent(Item[] value,
int start,
int length)
Construct a SequenceExtent from part of an array of items
|
SequenceExtent(java.util.List<? extends Item> list)
Construct a SequenceExtent from a List.
|
SequenceExtent(SequenceExtent ext,
int start,
int length)
Construct a SequenceExtent as a view of another SequenceExtent
|
SequenceExtent(SequenceIterator iter)
Construct a sequence containing all the items in a SequenceIterator.
|
Modifier and Type | Method and Description |
---|---|
boolean |
effectiveBooleanValue()
Get the effective boolean value
|
int |
getCardinality()
Determine the cardinality
|
ItemType |
getItemType(TypeHierarchy th)
Get the (lowest common) item type
|
int |
getLength()
Get the number of items in the sequence
|
Item |
itemAt(int n)
Get the n'th item in the sequence (starting with 0 as the first item)
|
SequenceIterator |
iterate()
Return an iterator over this sequence.
|
static ValueRepresentation |
makeSequenceExtent(java.util.List<Item> input)
Factory method to make a Value holding the contents of any List of items
|
static ValueRepresentation |
makeSequenceExtent(SequenceIterator iter)
Factory method to make a Value holding the contents of any SequenceIterator
|
Value |
reduce()
Reduce a value to its simplest form.
|
UnfailingIterator |
reverseIterate()
Return an enumeration of this sequence in reverse order (used for reverse axes)
|
Value |
simplify()
Simplify this SequenceExtent
|
GroundedValue |
subsequence(int start,
int length)
Get a subsequence of the value
|
void |
swap(int a,
int b)
Swap two items (needed to support sorting)
|
java.lang.String |
toString() |
asItem, asItem, asIterator, asValue, checkPermittedContents, convertToJava, equals, fromItem, getCanonicalLexicalRepresentation, getIterator, getSchemaComparable, getStringValue, getStringValueCS, hashCode, isIdentical, iterate, process
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
getStringValue, getStringValueCS
public SequenceExtent(Item[] items)
items
- the array of items to be included in the sequencepublic SequenceExtent(Item[] value, int start, int length)
value
- The arraystart
- zero-based offset of the first item in the array
that is to be included in the new SequenceExtentlength
- The number of items in the new SequenceExtentpublic SequenceExtent(SequenceExtent ext, int start, int length)
ext
- The existing SequenceExtentstart
- zero-based offset of the first item in the existing SequenceExtent
that is to be included in the new SequenceExtentlength
- The number of items in the new SequenceExtentpublic SequenceExtent(java.util.List<? extends Item> list)
list
- the list of items to be included in the sequencepublic SequenceExtent(SequenceIterator iter) throws XPathException
iter
- The supplied sequence of items. This must be positioned at
the start, so that hasNext() returns true if there are any nodes in
the node-set, and next() returns the first node.XPathException
- if reading the items using the
SequenceIterator raises an errorpublic static ValueRepresentation makeSequenceExtent(SequenceIterator iter) throws XPathException
iter
- a Sequence iterator that will be consumed to deliver the items in the sequenceEmptySequence
. If it is of length
one, the result will be an Item
. In all other cases, it will be an instance of
SequenceExtent
.XPathException
public static ValueRepresentation makeSequenceExtent(java.util.List<Item> input) throws XPathException
input
- a List containing the items in the sequenceEmptySequence
. If it is of length
one, the result will be an Item
. In all other cases, it will be an instance of
SequenceExtent
.XPathException
public Value simplify()
EmptySequence
. If it is of length
one, the result will be an AtomicValue
or a SingletonItem
.
In all other cases, the SequenceExtent
will be returned unchanged.public Value reduce()
public int getLength()
public int getCardinality()
getCardinality
in class Value
Cardinality
public ItemType getItemType(TypeHierarchy th)
getItemType
in class Value
th
- the type hierarchy cachepublic Item itemAt(int n)
itemAt
in interface GroundedValue
itemAt
in class Value
n
- the position of the required itempublic void swap(int a, int b)
a
- the position of the first item to be swappedb
- the position of the second item to be swappedpublic SequenceIterator iterate()
public UnfailingIterator reverseIterate()
public boolean effectiveBooleanValue() throws XPathException
effectiveBooleanValue
in class Value
XPathException
- if any dynamic error occurs evaluating the
expressionpublic GroundedValue subsequence(int start, int length)
subsequence
in interface GroundedValue
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 sequencepublic java.lang.String toString()
toString
in class java.lang.Object