Package net.sf.saxon.ma.arrays

Class ArrayItem

java.lang.Object

net.sf.saxon.ma.arrays.ArrayItem

All Implemented Interfaces:

Callable, Function, GroundedValue, Item, Sequence

Direct Known Subclasses:

AbstractArrayItem

public abstract class ArrayItem
extends java.lang.Object
implements Function

Interface supported by different implementations of an XDM array item

Constructor Summary

Constructors

Constructor	Description
ArrayItem()

Method Summary

Modifier and Type	Method	Description
abstract int	arrayLength()	Get the number of members in the array
abstract ArrayItem	concat(ArrayItem other)	Concatenate this array with another
abstract GroundedValue	get(int index)	Get a member of the array
Genre	getGenre()	Get the genre of this item
abstract SequenceType	getMemberType(TypeHierarchy th)	Get the lowest common item type of the members of the array
long	getSerialNumber()	Allocate a unique serial number.
abstract ArrayItem	insert(int position, GroundedValue member)	Insert a new member into an array
boolean	isArray()	Ask whether this function item is an array
boolean	isEmpty()	Ask whether the array is empty
boolean	isMap()	Ask whether this function item is a map
abstract java.lang.Iterable<GroundedValue>	members()	Get the list of all members of the array
abstract ArrayItem	put(int index, GroundedValue newValue)	Replace a member of the array
abstract ArrayItem	remove(int index)	Remove a member from the array
abstract ArrayItem	removeSeveral(IntSet positions)	Remove zero or more members from the array
abstract ArrayItem	subArray(int start, int end)	Get a sub-array given a start and end position
java.lang.String	toShortString()	Provide a short string showing the contents of the item, suitable for use in error messages

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.sf.saxon.expr.Callable

call

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

deepEquals, export, getAnnotations, getArity, getDescription, getFunctionItemType, getFunctionName, getOperandRoles, isSequenceVariadic, 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, getUnicodeStringValue, head, isStreamed, itemAt, iterate, reduce, subsequence

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

makeRepeatable

Constructor Detail

ArrayItem

public ArrayItem()

Method Detail

getSerialNumber

public long getSerialNumber()

Description copied from interface: Function

Allocate a unique serial number.

Introduced on the 11.x branch for bug #5887, so that function items, arrays, and maps can be used as keys for memo functions. This is not needed for 12.x, which uses a different design.

Specified by:

getSerialNumber in interface Function

isArray

public final boolean isArray()

Ask whether this function item is an array

Specified by:

isArray in interface Function

Returns:

true if this function item is an array, otherwise false

isMap

public final boolean isMap()

Ask whether this function item is a map

Specified by:

isMap in interface Function

Returns:

false (it is not a map)

get

public abstract GroundedValue get(int index)

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:

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

put

public abstract ArrayItem put(int index,
                              GroundedValue newValue)

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:

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

arrayLength

public abstract 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

public boolean isEmpty()

Ask whether the array is empty

Returns:

true if and only if the size of the array is zero

members

public abstract java.lang.Iterable<GroundedValue> members()

Get the list of all members of the array

Returns:

an iterator over the members of the array

concat

public abstract 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

public abstract 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

public abstract 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

Throws:

java.lang.IndexOutOfBoundsException - if any of the positions is out of range

subArray

public abstract 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:

java.lang.IndexOutOfBoundsException - if start, or start+end, is out of range

insert

public abstract 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:

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

getMemberType

public abstract SequenceType getMemberType(TypeHierarchy th)

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

Parameters:

th - the type hierarchy

Returns:

the most specific type to which all the members belong.

toShortString

public java.lang.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

Specified by:

toShortString in interface Item

Returns:

a depiction of the item suitable for use in error messages

getGenre

public final Genre getGenre()

Get the genre of this item

Specified by:

getGenre in interface Function

Specified by:

getGenre in interface Item

Returns:

the genre: specifically, Genre.ARRAY.