Class AnyFunctionType

    • Constructor Detail

      • AnyFunctionType

        public AnyFunctionType()
    • Method Detail

      • getInstance

        public static AnyFunctionType getInstance()
        Get the singular instance of this type (Note however that subtypes of this type may have any number of instances)
        Returns:
        the singular instance of this type
      • getUType

        public UType getUType()
        Get the corresponding UType. A UType is a union of primitive item types.
        Specified by:
        getUType in interface ItemType
        Returns:
        the smallest UType that subsumes this item type
      • isAtomicType

        public boolean isAtomicType()
        Determine whether this item type is an atomic type
        Specified by:
        isAtomicType in interface ItemType
        Returns:
        true if this is ANY_ATOMIC_TYPE or a subtype thereof
      • isPlainType

        public boolean isPlainType()
        Determine whether this item type is atomic (that is, whether it can ONLY match atomic values)
        Specified by:
        isPlainType in interface ItemType
        Returns:
        true if this is ANY_ATOMIC_TYPE or a subtype thereof
      • isMapType

        public boolean isMapType()
        Ask whether this function item type is a map type. In this case function coercion (to the map type) will never succeed.
        Specified by:
        isMapType in interface FunctionItemType
        Returns:
        true if this FunctionItemType is a map type
      • isArrayType

        public boolean isArrayType()
        Ask whether this function item type is an array type. In this case function coercion (to the array type) will never succeed.
        Specified by:
        isArrayType in interface FunctionItemType
        Returns:
        true if this FunctionItemType is an array type
      • getDefaultPriority

        public double getDefaultPriority()
        Get the default priority when this ItemType is used as an XSLT pattern
        Specified by:
        getDefaultPriority in interface ItemType
        Returns:
        the default priority
      • getBasicAlphaCode

        public java.lang.String getBasicAlphaCode()
        Get an alphabetic code representing the type, or at any rate, the nearest built-in type from which this type is derived. The codes are designed so that for any two built-in types A and B, alphaCode(A) is a prefix of alphaCode(B) if and only if A is a supertype of B.
        Specified by:
        getBasicAlphaCode in interface ItemType
        Returns:
        the alphacode for the nearest containing built-in type
      • getArgumentTypes

        public SequenceType[] getArgumentTypes()
        Get the argument types of the function
        Specified by:
        getArgumentTypes in interface FunctionItemType
        Returns:
        the argument types, as an array of SequenceTypes, or null if this is the generic function type function(*)
      • getAnnotationAssertions

        public AnnotationList getAnnotationAssertions()
        Get the list of annotation assertions defined on this function item type.
        Specified by:
        getAnnotationAssertions in interface FunctionItemType
        Returns:
        the list of annotation assertions, or an empty list if there are none
      • matches

        public boolean matches​(Item item,
                               TypeHierarchy th)
        Test whether a given item conforms to this type
        Specified by:
        matches in interface ItemType
        Parameters:
        item - The item to be tested
        th - The type hierarchy cache
        Returns:
        true if the item is an instance of this type; false otherwise
      • getPrimitiveItemType

        public final ItemType getPrimitiveItemType()
        Get the primitive item type corresponding to this item type. For item(), this is Type.ITEM. For node(), it is Type.NODE. For specific node kinds, it is the value representing the node kind, for example Type.ELEMENT. For anyAtomicValue it is Type.ATOMIC_VALUE. For numeric it is Type.NUMBER. For other atomic types it is the primitive type as defined in XML Schema, except that integer, xs:dayTimeDuration, and xs:yearMonthDuration are considered to be primitive types. For function items it is the singular instance FunctionItemType.getInstance().
        Specified by:
        getPrimitiveItemType in interface ItemType
        Returns:
        the corresponding primitive type
      • getPrimitiveType

        public final int getPrimitiveType()
        Get the primitive type corresponding to this item type. For item(), this is Type.ITEM. For node(), it is Type.NODE. For specific node kinds, it is the value representing the node kind, for example Type.ELEMENT. For anyAtomicValue it is Type.ATOMIC_VALUE. For numeric it is Type.NUMBER. For other atomic types it is the primitive type as defined in XML Schema, except that INTEGER is considered to be a primitive type.
        Specified by:
        getPrimitiveType in interface ItemType
        Returns:
        the integer fingerprint of the corresponding primitive type
      • toString

        public java.lang.String toString()
        Produce a representation of this type name for use in error messages.
        Overrides:
        toString in class java.lang.Object
        Returns:
        a string representation of the type, in notation resembling but not necessarily identical to XPath syntax
      • getAtomizedItemType

        public PlainType getAtomizedItemType()
        Get the item type of the atomic values that will be produced when an item of this type is atomized
        Specified by:
        getAtomizedItemType in interface ItemType
        Returns:
        the item type of the atomic values that will be produced when an item of this type is atomized
      • isAtomizable

        public boolean isAtomizable​(TypeHierarchy th)
        Ask whether values of this type are atomizable
        Specified by:
        isAtomizable in interface ItemType
        Parameters:
        th - The type hierarchy cache
        Returns:
        true if some or all instances of this type can be successfully atomized; false * if no instances of this type can be atomized
      • makeFunctionSequenceCoercer

        public Expression makeFunctionSequenceCoercer​(Expression exp,
                                                      RoleDiagnostic role)
                                               throws XPathException
        Create an expression whose effect is to apply function coercion to coerce a function from this type to another type
        Specified by:
        makeFunctionSequenceCoercer in interface FunctionItemType
        Parameters:
        exp - the expression that delivers the supplied sequence of function items (the ones in need of coercion)
        role - information for use in diagnostics
        Returns:
        the sequence of coerced functions, each on a function that calls the corresponding original function after checking the parameters
        Throws:
        XPathException - if an error is detected