Package net.sf.saxon.ma.arrays
Interface ArrayItem
- All Superinterfaces:
Callable
,Function
,GroundedValue
,Item
,Sequence
- All Known Implementing Classes:
AbstractArrayItem
,ImmutableArrayItem
,SimpleArrayItem
Interface supported by different implementations of an XDM array item
-
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptionint
Get the number of members in the arrayConcatenate this array with anotherget
(int index) Get a member of the arraydefault Genre
getGenre()
Get the genre of this itemGet the lowest common item type of the members of the arrayinsert
(int position, GroundedValue member) Insert a new member into an arrayboolean
isEmpty()
Ask whether the array is emptymembers()
Get the list of all members of the arrayput
(int index, GroundedValue newValue) Replace a member of the arrayremove
(int index) Remove a member from the arrayremoveSeveral
(IntSet positions) Remove zero or more members from the arraysubArray
(int start, int end) Get a sub-array given a start and end positiondefault String
Provide a short string showing the contents of the item, suitable for use in error messagesMethods inherited from interface net.sf.saxon.om.Function
call, deepEquals, export, getAnnotations, getArity, getDescription, getFunctionItemType, getFunctionName, getOperandRoles, isArray, isMap, isTrustedResultType, makeNewContext
Methods inherited from interface net.sf.saxon.om.GroundedValue
asIterable, concatenate, containsNode, effectiveBooleanValue, materialize
Methods inherited from interface net.sf.saxon.om.Item
atomize, getLength, getStringValue, getStringValueCS, head, isStreamed, itemAt, iterate, reduce, subsequence
Methods inherited from interface net.sf.saxon.om.Sequence
makeRepeatable
-
Field Details
-
SINGLE_ARRAY_TYPE
-
-
Method Details
-
get
Get a member of the array- Parameters:
index
- the position of the member to retrieve (zero-based)- Returns:
- the value at the given position.
- Throws:
IndexOutOfBoundsException
- if the index is out of range
-
put
Replace a member of the array- Parameters:
index
- the position of the member to replace (zero-based)newValue
- the replacement value- Returns:
- the value at the given position.
- Throws:
IndexOutOfBoundsException
- if the index is out of range
-
arrayLength
int arrayLength()Get the number of members in the arrayNote: the
method always returns 1, because an array is an item
- Returns:
- the number of members in this array.
-
isEmpty
boolean isEmpty()Ask whether the array is empty- Returns:
- true if and only if the size of the array is zero
-
members
Iterable<GroundedValue> members()Get the list of all members of the array- Returns:
- an iterator over the members of the array
-
concat
Concatenate this array with another- Parameters:
other
- the second array- Returns:
- the concatenation of the two arrays; that is, an array containing first the members of this array, and then the members of the other array
-
remove
Remove a member from the array- Parameters:
index
- the position of the member to be removed (zero-based)- Returns:
- a new array in which the requested member has been removed.
- Throws:
IndexOutOfBoundsException
- if index is out of range
-
removeSeveral
Remove zero or more members from the array- Parameters:
positions
- the positions of the members to be removed (zero-based). A value that is out of range is ignored.- Returns:
- a new array in which the requested member has been removed
- Throws:
IndexOutOfBoundsException
- if any of the positions is out of range
-
subArray
Get a sub-array given a start and end position- 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
- Throws:
IndexOutOfBoundsException
- if start, or start+end, is out of range
-
insert
Insert a new member into an array- Parameters:
position
- the 0-based position that the new item will assumemember
- the new member to be inserted- Returns:
- a new array item with the new member inserted
- Throws:
IndexOutOfBoundsException
- if position is out of range
-
getMemberType
Get the lowest common item type of the members of the array- Returns:
- the most specific type to which all the members belong.
-
toShortString
Provide a short string showing the contents of the item, suitable for use in error messages- Specified by:
toShortString
in interfaceFunction
- Specified by:
toShortString
in interfaceGroundedValue
- Specified by:
toShortString
in interfaceItem
- Returns:
- a depiction of the item suitable for use in error messages
-
getGenre
Get the genre of this item- Specified by:
getGenre
in interfaceFunction
- Specified by:
getGenre
in interfaceItem
- Returns:
- the genre: specifically,
Genre.ARRAY
.
-