net.sf.saxon.ma.arrays

Interface ArrayItem

All Superinterfaces:

Callable, Function, GroundedValue, Item, Iterable<Sequence>, PullEvent, Sequence

All Known Implementing Classes:

SimpleArrayItem

public interface ArrayItem
extends Function, 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

Methods

Modifier and Type	Method and Description
ArrayItem	concat(ArrayItem other) Concatenate this array with another
Sequence	get(int index) Get a member of the array
List<Sequence>	getMembers() Get a list of the members of the array
SequenceType	getMemberType() Get the lowest common item type of the members of the array
boolean	isEmpty() Ask whether the array is empty
Iterator<Sequence>	iterator() Get the list of all members of the array
ArrayItem	remove(int index) Remove a member from the array
int	size() Get the size of the array

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

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

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

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

size

int size()

Get the size of the array

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

Iterator<Sequence> iterator()

Get the list of all members of the array

Specified by:

iterator in interface 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)
                 throws XPathException

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:

XPathException - if the index is out of range

getMemberType

SequenceType getMemberType()

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

Returns:

the most specific type to which all the members belong.

getMembers

List<Sequence> getMembers()

Get a list of the members of the array

Returns:

the list of members.