net.sf.saxon.ma.arrays

Interface ArrayItem

All Superinterfaces:

Callable, Function, GroundedValue, Item, java.lang.Iterable<Sequence>, Sequence

All Known Implementing Classes:

SimpleArrayItem

public interface ArrayItem
extends Function, java.lang.Iterable<Sequence>

Interface supported by different implementations of an XDM array item

Field Summary

Fields

Modifier and Type	Field and Description
static SequenceType	SINGLE_ARRAY_TYPE

Method Summary

Modifier and Type	Method and Description
int	arrayLength() Get the number of members in the array
ArrayItem	concat(ArrayItem other) Concatenate this array with another
Sequence	get(int index) Get a member of the array
java.util.List<Sequence>	getMembers() Get a list of the members of the array
SequenceType	getMemberType(TypeHierarchy th) Get the lowest common item type of the members of the array
boolean	isEmpty() Ask whether the array is empty
java.util.Iterator<Sequence>	iterator() Get the list of all members of the array
ArrayItem	put(int index, Sequence newValue) Replace a member of the array
ArrayItem	remove(int index) Remove a member from the array
ArrayItem	removeSeveral(IntSet positions) Remove zero or more members from the array

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

call, deepEquals, export, getAnnotations, getArity, getDescription, getFunctionItemType, getFunctionName, getOperandRoles, isArray, isMap, isTrustedResultType, iterate, makeNewContext

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

atomize, getStringValue, getStringValueCS, head

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

effectiveBooleanValue, getLength, getStringValue, getStringValueCS, head, itemAt, reduce, subsequence

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

SINGLE_ARRAY_TYPE

static final SequenceType SINGLE_ARRAY_TYPE

Method Detail

get

Sequence get(int index)
      throws XPathException

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:

XPathException - if the index is out of range

put

ArrayItem put(int index,
              Sequence newValue)
       throws XPathException

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:

XPathException - if the index is out of range

arrayLength

int arrayLength()

Get the number of members in the array

Note: 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

iterator

java.util.Iterator<Sequence> iterator()

Get the list of all members of the array

Specified by:

iterator in interface java.lang.Iterable<Sequence>

Returns:

an iterator over the members of the array

concat

ArrayItem concat(ArrayItem other)

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

ArrayItem remove(int index)

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:

java.lang.IndexOutOfBoundsException - if index is out of range

removeSeveral

ArrayItem removeSeveral(IntSet positions)

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

getMemberType

SequenceType getMemberType(TypeHierarchy th)

Get the lowest common item type of the members of the array

Returns:

the most specific type to which all the members belong.

getMembers

java.util.List<Sequence> getMembers()

Get a list of the members of the array

Returns:

the list of members.