Class AbstractArrayItem

    • Constructor Detail

      • AbstractArrayItem

        public AbstractArrayItem()
    • Method Detail

      • getOperandRoles

        public OperandRole[] getOperandRoles()
        Get the roles of the arguments, for the purposes of streaming
        an array of OperandRole objects, one for each argument
      • getAnnotations

        public AnnotationList getAnnotations()
        Get the function annotations (as defined in XQuery). Returns an empty list if there are no function annotations.
        the function annotations
      • getFunctionItemType

        public FunctionItemType getFunctionItemType()
        Get the item type of the function item
        the function item's type
      • getFunctionName

        public StructuredQName getFunctionName()
        Get the name of the function, or null if it is anonymous
        the function name, or null for an anonymous function (which this one is)
      • getDescription

        public java.lang.String 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".
        a description of the function for use in error messages
      • getArity

        public int getArity()
        Get the arity of the function
        the number of arguments in the function signature (in this case, 1 (one))
      • makeNewContext

        public XPathContext makeNewContext​(XPathContext callingContext,
                                           ContextOriginator originator)
        Prepare an XPathContext object for evaluating the function
        callingContext - the XPathContext of the function calling expression
        originator - identifies the location of the caller for diagnostics
        a suitable context for evaluating the function (which may or may not be the same as the caller's context)
      • call

        public GroundedValue call​(XPathContext context,
                                  Sequence[] args)
                           throws XPathException
        Invoke the array in its role as a function
        context - the XPath dynamic evaluation context
        args - the actual arguments to be supplied (a single integer)
        the result of invoking the function
        XPathException - if a dynamic error occurs within the function
      • deepEquals

        public boolean deepEquals​(FunctionItem 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
        other - the other function item
        context - the dynamic evaluation context
        comparer - the object to perform the comparison
        flags - options for how the comparison is performed
        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
        XPathException - if the comparison cannot be performed
      • effectiveBooleanValue

        public boolean effectiveBooleanValue()
                                      throws XPathException
        Get the effective boolean value of this sequence
        the effective boolean value
        XPathException - if the sequence has no effective boolean value (for example a sequence of two integers)
      • getUnicodeStringValue

        public UnicodeString getUnicodeStringValue()
        Get the value of the item as a string. For arrays, there is no string value, so an exception is thrown.
        the string value of the item
        UncheckedXPathException - 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)
      • export

        public void export​(ExpressionPresenter out)
                    throws XPathException
        Output information about this function item to the diagnostic explain() output
        out - the destination for the information
        XPathException - if things go wrong
      • isTrustedResultType

        public boolean isTrustedResultType()
        Description copied from interface: FunctionItem
        Ask if the function can be trusted to return a result of the correct type
        true if the implementation can be trusted
      • toString

        public java.lang.String toString()
        Output a string representation of the array, suitable for diagnostics
        toString in class java.lang.Object
      • getMemberType

        public SequenceType getMemberType​(TypeHierarchy th)
        Get the lowest common item type of the members of the array
        Specified by:
        getMemberType in class ArrayItem
        th - the type hierarchy
        the most specific type to which all the members belong.