Package net.sf.saxon.ma.arrays

Class ArrayItemType

  • All Implemented Interfaces:
    FunctionItemType, ItemType
    public class ArrayItemType
extends AnyFunctionType
    An instance of this class represents a specific array item type, for example function(xs:int) as xs:boolean

    • Constructor Detail

      • ArrayItemType

        public ArrayItemType​(SequenceType memberType)

    • Method Detail

      • getGenre

        public Genre getGenre()
        Determine the Genre (top-level classification) of this type
        Returns:
        the Genre to which this type belongs, specifically Genre.ARRAY

      • getMemberType

        public SequenceType getMemberType()
        Get the type of the members of the array
        Returns:
        the type to which all members of the array must conform

      • 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
        Overrides:
        isMapType in class AnyFunctionType
        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
        Overrides:
        isArrayType in class AnyFunctionType
        Returns:
        true if this FunctionItemType is an array type

      • getAlphaCode

        public String getAlphaCode()
        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:
        getAlphaCode in interface ItemType
        Overrides:
        getAlphaCode in class AnyFunctionType
        Returns:
        the alphacode for the nearest containing built-in type

      • isAtomizable

        public boolean isAtomizable​(TypeHierarchy th)
        Ask whether values of this type are atomizable
        Specified by:
        isAtomizable in interface ItemType
        Overrides:
        isAtomizable in class AnyFunctionType
        Parameters:
        th - The type hierarchy cache
        Returns:
        true unless it is known that these items will be elements with element-only content, in which case return false

      • 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
        Overrides:
        getAtomizedItemType in class AnyFunctionType
        Returns:
        the item type of the atomic values that will be produced when an item of this type is atomized

      • getArity

        public int getArity()
        Get the arity (number of arguments) of this function type
        Returns:
        the number of argument types in the function signature

      • toString

        public String toString()
        Produce a representation of this type name for use in error messages.
        Specified by:
        toString in interface ItemType
        Overrides:
        toString in class AnyFunctionType
        Returns:
        a string representation of the type, in notation resembling but not necessarily identical to XPath syntax

      • toExportString

        public String toExportString()
        Return a string representation of this ItemType suitable for use in stylesheet export files. This differs from the result of toString() in that it will not contain any references to anonymous types. Note that it may also use the Saxon extended syntax for union types and tuple types. The default implementation returns the result of calling toString().
        Returns:
        the string representation as an instance of the XPath SequenceType construct

      • equals

        public boolean equals​(Object other)
        Test whether this array type equals another array type
        Overrides:
        equals in class Object

      • hashCode

        public int hashCode()
        Returns a hash code value for the object.
        Overrides:
        hashCode in class Object

      • explainMismatch

        public Optional<String> explainMismatch​(Item item,
                                        TypeHierarchy th)
        Get extra diagnostic information about why a supplied item does not conform to this item type, if available. If extra information is returned, it should be in the form of a complete sentence, minus the closing full stop. No information should be returned for obvious cases.
        Parameters:
        item - the item that doesn't match this type
        th - the type hierarchy cache
        Returns:
        optionally, a message explaining why the item does not match the type

      • generateJavaScriptItemTypeTest

        public String generateJavaScriptItemTypeTest​(ItemType knownToBe,
                                             int targetVersion)
                                      throws XPathException
        Generate Javascript code to test whether an item conforms to this item type
        Specified by:
        generateJavaScriptItemTypeTest in interface ItemType
        Overrides:
        generateJavaScriptItemTypeTest in class AnyFunctionType
        Parameters:
        knownToBe - a type that this item is known to conform to
        targetVersion - the version of Saxon-JS SEF format
        Returns:
        a Javascript instruction or sequence of instructions, which can be used as the body of a Javascript function, and which returns a boolean indication whether the value of the variable "item" is an instance of this item type.
        Throws:
        XPathException - if JS code cannot be generated for this item type, for example because the test is schema-aware.