Package net.sf.saxon.ma.arrays
Class AbstractArrayItem
java.lang.Object
net.sf.saxon.ma.arrays.AbstractArrayItem
- Direct Known Subclasses:
ImmutableArrayItem
,SimpleArrayItem
An abstract implementation of XDM array items, containing methods that can be implemented generically.
-
Field Summary
Fields inherited from interface net.sf.saxon.ma.arrays.ArrayItem
SINGLE_ARRAY_TYPE
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionatomize()
Atomize the item.call
(XPathContext context, Sequence[] args) Invoke the array in its role as a functionboolean
deepEquals
(Function other, XPathContext context, AtomicComparer comparer, int flags) Test whether this array is deep-equal to another array, under the rules of the deep-equal functionboolean
Get the effective boolean value of this sequencevoid
Output information about this function item to the diagnostic explain() outputGet the function annotations (as defined in XQuery).int
getArity()
Get the arity of the functionGet a description of this function for use in error messages.Get the item type of the function itemGet the name of the function, or null if it is anonymousGet the lowest common item type of the members of the arrayGet the roles of the arguments, for the purposes of streamingGet the value of the item as a string.Get the value of the item as a CharSequence.boolean
isArray()
Ask whether this function item is an arrayboolean
isMap()
Ask whether this function item is a mapboolean
Check that result type is of the trusted system functions to return a result of the correct typemakeNewContext
(XPathContext callingContext, ContextOriginator originator) Prepare an XPathContext object for evaluating the functiontoString()
Output a string representation of the array, suitable for diagnosticsMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface net.sf.saxon.ma.arrays.ArrayItem
arrayLength, concat, get, getGenre, insert, isEmpty, members, put, remove, removeSeveral, subArray, toShortString
Methods inherited from interface net.sf.saxon.om.GroundedValue
asIterable, concatenate, containsNode, materialize
Methods inherited from interface net.sf.saxon.om.Item
getLength, head, isStreamed, itemAt, iterate, reduce, subsequence
Methods inherited from interface net.sf.saxon.om.Sequence
makeRepeatable
-
Constructor Details
-
AbstractArrayItem
public AbstractArrayItem()
-
-
Method Details
-
getOperandRoles
Get the roles of the arguments, for the purposes of streaming- Specified by:
getOperandRoles
in interfaceFunction
- Returns:
- an array of OperandRole objects, one for each argument
-
isArray
public boolean isArray()Ask whether this function item is an array -
isMap
public boolean isMap()Ask whether this function item is a map -
atomize
Atomize the item.- Specified by:
atomize
in interfaceItem
- Returns:
- the result of atomization
- Throws:
XPathException
- if atomization is not allowed for this kind of item
-
getAnnotations
Get the function annotations (as defined in XQuery). Returns an empty list if there are no function annotations.- Specified by:
getAnnotations
in interfaceFunction
- Returns:
- the function annotations
-
getFunctionItemType
Get the item type of the function item- Specified by:
getFunctionItemType
in interfaceFunction
- Returns:
- the function item's type
-
getFunctionName
Get the name of the function, or null if it is anonymous- Specified by:
getFunctionName
in interfaceFunction
- Returns:
- the function name, or null for an anonymous function (which this one is)
-
getDescription
Get a description of this function for use in error messages. For named functions, the description is the function name (as a lexical QName). For others, it might be, for example, "inline function", or "partially-applied ends-with function".- Specified by:
getDescription
in interfaceFunction
- Returns:
- a description of the function for use in error messages
-
getArity
public int getArity()Get the arity of the function -
makeNewContext
Prepare an XPathContext object for evaluating the function- Specified by:
makeNewContext
in interfaceFunction
- Parameters:
callingContext
- the XPathContext of the function calling expressionoriginator
-- Returns:
- a suitable context for evaluating the function (which may or may not be the same as the caller's context)
-
call
Invoke the array in its role as a function- Specified by:
call
in interfaceCallable
- Specified by:
call
in interfaceFunction
- Parameters:
context
- the XPath dynamic evaluation contextargs
- the actual arguments to be supplied (a single integer, one-based)- Returns:
- the result of invoking the function
- Throws:
XPathException
- if the index is out of bounds
-
deepEquals
public boolean deepEquals(Function other, XPathContext context, AtomicComparer comparer, int flags) throws XPathException Test whether this array is deep-equal to another array, under the rules of the deep-equal function- Specified by:
deepEquals
in interfaceFunction
- Parameters:
other
- the other function itemcontext
- the dynamic evaluation contextcomparer
- the object to perform the comparisonflags
- options for how the comparison is performed- Returns:
- true if the two array items are deep-equal; false if they are not deep equal or if the other item is not an array
- Throws:
XPathException
- if the comparison cannot be performed
-
effectiveBooleanValue
Get the effective boolean value of this sequence- Specified by:
effectiveBooleanValue
in interfaceGroundedValue
- Returns:
- the effective boolean value
- Throws:
XPathException
- if the sequence has no effective boolean value (for example a sequence of two integers)
-
getStringValue
Get the value of the item as a string. For arrays, there is no string value, so an exception is thrown.- Specified by:
getStringValue
in interfaceGroundedValue
- Specified by:
getStringValue
in interfaceItem
- Returns:
- the string value of the item
- Throws:
UnsupportedOperationException
- if the item is an array (an unchecked exception is used here to avoid introducing exception handling to a large number of paths where it is not needed)- Since:
- 8.4
- See Also:
-
getStringValueCS
Get the value of the item as a CharSequence. For arrays, there is no string value, so an exception is thrown.- Specified by:
getStringValueCS
in interfaceGroundedValue
- Specified by:
getStringValueCS
in interfaceItem
- Returns:
- the string value of the item
- Throws:
UnsupportedOperationException
- if the item is an array (an unchecked exception is used here to avoid introducing exception handling to a large number of paths where it is not needed)- Since:
- 8.4
- See Also:
-
export
Output information about this function item to the diagnostic explain() output- Specified by:
export
in interfaceFunction
- Throws:
XPathException
-
isTrustedResultType
public boolean isTrustedResultType()Description copied from interface:Function
Check that result type is of the trusted system functions to return a result of the correct type- Specified by:
isTrustedResultType
in interfaceFunction
-
toString
Output a string representation of the array, suitable for diagnostics -
getMemberType
Get the lowest common item type of the members of the array- Specified by:
getMemberType
in interfaceArrayItem
- Returns:
- the most specific type to which all the members belong.
-