Package com.saxonica.xsltextn.pedigree
Class PedigreeArrayItem
java.lang.Object
net.sf.saxon.ma.arrays.ArrayItem
net.sf.saxon.ma.arrays.AbstractArrayItem
com.saxonica.xsltextn.pedigree.DelegatingArrayItem
com.saxonica.xsltextn.pedigree.PedigreeArrayItem
- All Implemented Interfaces:
PedigreeValue
,Callable
,FunctionItem
,GroundedValue
,Item
,Sequence
A
PedigreeArrayItem
represents an XDM array together with a Pedigree
:
that is, retained information about how the array was selected with a JSON-like tree.-
Constructor Summary
ConstructorsConstructorDescriptionPedigreeArrayItem
(ArrayItem base) Create a PedigreeArrayItem with an empty pedigreePedigreeArrayItem
(ArrayItem base, Pedigree pedigree) Create a PedigreeArrayItem with a known pedigree -
Method Summary
Modifier and TypeMethodDescriptionget
(int index) Get the member of the array at a specified index, retaining information about how that member was selectedGet the pedigree of this array item, providing information as to how it was selected.members()
Return the members of the array as an iterable collectionremove
(int index) Get all members of the array except that at a specified position, retaining information about how the remaining members were selectedsubArray
(int start, int end) Get a sub-array given a start and end positionMethods inherited from class com.saxonica.xsltextn.pedigree.DelegatingArrayItem
append, arrayLength, concat, insert, isEmpty, put, removeSeveral
Methods inherited from class net.sf.saxon.ma.arrays.AbstractArrayItem
atomize, call, deepEqual40, deepEquals, effectiveBooleanValue, export, getAnnotations, getArity, getDescription, getFunctionItemType, getFunctionName, getMemberType, getOperandRoles, getUnicodeStringValue, isTrustedResultType, makeNewContext, toString
Methods inherited from class net.sf.saxon.ma.arrays.ArrayItem
getGenre, isArray, isMap, parcels, toShortString
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface net.sf.saxon.om.FunctionItem
isSequenceVariadic
Methods inherited from interface net.sf.saxon.om.GroundedValue
asIterable, concatenate, containsNode, materialize
Methods inherited from interface net.sf.saxon.om.Item
getLength, getStringValue, head, isStreamed, itemAt, iterate, reduce, subsequence
Methods inherited from interface com.saxonica.xsltextn.pedigree.PedigreeValue
getOrigin
Methods inherited from interface net.sf.saxon.om.Sequence
makeRepeatable
-
Constructor Details
-
PedigreeArrayItem
Create a PedigreeArrayItem with an empty pedigree- Parameters:
base
- the underlying array item
-
PedigreeArrayItem
Create a PedigreeArrayItem with a known pedigree- Parameters:
base
- the underlying array item
-
-
Method Details
-
get
Get the member of the array at a specified index, retaining information about how that member was selected- Overrides:
get
in classDelegatingArrayItem
- Parameters:
index
- the zero-based subscript of the selected member of the array- Returns:
- the requested array member, which will itself have a pedigree if it is a singleton map or array.
- Throws:
IndexOutOfBoundsException
- if the index is out of bounds
-
remove
Get all members of the array except that at a specified position, retaining information about how the remaining members were selected- Overrides:
remove
in classDelegatingArrayItem
- Parameters:
index
- the zero-based subscript of the member of the array that is to be removed- Returns:
- the remaining array members, which will themselves have a pedigree (indicating their original position in the original array) in the case of members that are singleton maps or arrays.
- Throws:
IndexOutOfBoundsException
- if the index is out of bounds
-
subArray
Description copied from class:ArrayItem
Get a sub-array given a start and end position- Overrides:
subArray
in classDelegatingArrayItem
- Parameters:
start
- the start position (zero based)end
- the end position (the position of the first item not to be returned) (zero based)- Returns:
- a new array item containing the sub-array
-
members
Return the members of the array as an iterable collection- Overrides:
members
in classDelegatingArrayItem
- Returns:
- the members of the array as an iterable collection. Any members that are singleton maps or arrays will have a pedigree indicating how they were selected.
-
getPedigree
Get the pedigree of this array item, providing information as to how it was selected.- Specified by:
getPedigree
in interfacePedigreeValue
- Returns:
- the pedigree of this array item
-
getBaseItem
- Overrides:
getBaseItem
in classDelegatingArrayItem
-