net.sf.saxon.ma.arrays

Interface ArrayItem

All Superinterfaces:

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

All Known Implementing Classes:

AbstractArrayItem, ImmutableArrayItem, SimpleArrayItem

public interface ArrayItem
extends Function

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
GroundedValue<?>	get(int index) Get a member of the array
default Genre	getGenre() Get the genre of this item
SequenceType	getMemberType(TypeHierarchy th) Get the lowest common item type of the members of the array
ArrayItem	insert(int position, GroundedValue<?> member) Insert a new member into an array
boolean	isEmpty() Ask whether the array is empty
Iterable<GroundedValue<?>>	members() Get the list of all members of the array
ArrayItem	put(int index, GroundedValue<?> 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
ArrayItem	subArray(int start, int end) Get a sub-array given a start and end position
default String	toShortString() Provide a short string showing the contents of the item, suitable for use in error messages

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

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

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

atomize, getLength, getStringValue, getStringValueCS, head, isStreamed, itemAt, iterate, iterator, reduce, subsequence, toGroundedValue

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

asIterable, effectiveBooleanValue, materialize

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

makeRepeatable

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

SINGLE_ARRAY_TYPE

static final SequenceType SINGLE_ARRAY_TYPE

Method Detail

get

GroundedValue<?> 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,
              GroundedValue<?> 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

members

Iterable<GroundedValue<?>> members()

Get the list of all members of the array

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:

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

subArray

ArrayItem subArray(int start,
                   int end)

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

ArrayItem insert(int position,
                 GroundedValue<?> member)

Insert a new member into an array

Parameters:

position - the 0-based position that the new item will assume

member - 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

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.

toShortString

default String toShortString()

Provide a short string showing the contents of the item, suitable for use in error messages

Specified by:

toShortString in interface Function

Specified by:

toShortString in interface GroundedValue<Function>

Specified by:

toShortString in interface Item<Function>

Returns:

a depiction of the item suitable for use in error messages

getGenre

default Genre getGenre()

Get the genre of this item

Specified by:

getGenre in interface Function

Specified by:

getGenre in interface Item<Function>

Returns:

the genre: specifically, Genre.ARRAY.