Class AbstractFunction

    • Constructor Detail

      • AbstractFunction

        public AbstractFunction()
    • 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
      • getOperandRoles

        public OperandRole[] getOperandRoles()
        Get the roles of the arguments, for the purposes of streaming
        Specified by:
        getOperandRoles in interface Function
        an array of OperandRole objects, one for each argument
      • isArray

        public boolean isArray()
        Ask whether this function is an array
        Specified by:
        isArray in interface Function
        true if this function item is an array, otherwise false
      • isMap

        public boolean isMap()
        Ask whether this function is a map
        Specified by:
        isMap in interface Function
        true if this function item is a map, otherwise false
      • getUnicodeStringValue

        public UnicodeString getUnicodeStringValue()
        Get the string value of the function
        Specified by:
        getUnicodeStringValue in interface GroundedValue
        Specified by:
        getUnicodeStringValue in interface Item
        nothing; this method always throws an exception
        java.lang.UnsupportedOperationException - (the string value of a function is not defined)
      • getAnnotations

        public AnnotationList getAnnotations()
        Description copied from interface: Function
        Get the function annotations (as defined in XQuery). Returns an empty list if there are no function annotations.
        Specified by:
        getAnnotations in interface Function
        the function annotations
      • typeCheck

        public void typeCheck​(ExpressionVisitor visitor,
                              ContextItemStaticInfo contextItemType)
                       throws XPathException
        Type check the function (may modify it by adding code for converting the arguments)
        visitor - the expression visitor, supplies context information
        contextItemType - the context item type at the point where the function definition appears
        XPathException - if any failure (e.g. a type checking failure) occurs
      • makeNewContext

        public XPathContext makeNewContext​(XPathContext callingContext,
                                           ContextOriginator originator)
        Prepare an XPathContext object for evaluating the function
        Specified by:
        makeNewContext in interface Function
        callingContext - the XPathContext of the function calling expression
        originator - the originator of the new context
        a suitable context for evaluating the function (which may or may not be the same as the caller's context)
      • deepEquals

        public boolean deepEquals​(Function other,
                                  XPathContext context,
                                  AtomicComparer comparer,
                                  int flags)
                           throws XPathException
        Test whether this FunctionItem is deep-equal to another function item, under the rules of the deep-equal function
        Specified by:
        deepEquals in interface 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 function items are deep-equal
        XPathException - if the comparison cannot be performed
      • isTrustedResultType

        public boolean isTrustedResultType()
        Check that result type is SystemFunction or AtomicConstructorFunction
        Specified by:
        isTrustedResultType in interface Function
        true if the implementation can be trusted
      • toShortString

        public java.lang.String toShortString()
        Description copied from interface: Function
        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
        a depiction of the item suitable for use in error messages