Package net.sf.saxon.ma.map

Class RecordTest

  • All Implemented Interfaces:
    TupleType, FunctionItemType, ItemType
    public class RecordTest
extends AnyFunctionType
implements TupleType
    An instance of this class represents a specific record item type, for example record(x as xs:double, y as element(employee)). Record types are a proposed extension for XPath 4.0. They were previously introduced as a Saxon extension in Saxon 9.8, under the name "tuple types". The syntax for constructing a record type requires Saxon-PE or higher, but the supporting code is included in Saxon-HE for convenience. Extended in 10.0 to distinguish extensible vs non-extensible record types. Extensible record types permit fields other than those listed to appear; non-extensible record types do not. An extensible record type is denoted by record(... ,*).

    • Constructor Detail

      • RecordTest

        public RecordTest()
        Construct a dummy RecordTest, details to be supplied later

      • RecordTest

        public RecordTest​(java.util.List<java.lang.String> names,
                  java.util.List<SequenceType> types,
                  java.util.Collection<java.lang.String> optionalFieldNames,
                  boolean extensible)
        Construct a RecordTest
        Parameters:
        names - the names of the fields
        types - the types of the fields
        optionalFieldNames - a list of the names of the fields that are declared optional
        extensible - indicates whether the RecordTest is extensible (allows fields other than those declared)

    • Method Detail

      • setDetails

        public void setDetails​(java.util.List<java.lang.String> names,
                       java.util.List<SequenceType> types,
                       java.util.Collection<java.lang.String> optionalFieldNames,
                       boolean extensible)
        Supply the details of the RecordTest. This method is only to be used during initialisation, it is needed so that a RecordTest can refer to itself. Apart from this, the RecordTest is immutable.
        Parameters:
        names - the names of the fields
        types - the types of the fields
        optionalFieldNames - a list of the names of the fields that are declared optional
        extensible - indicates whether the RecordTest is extensible (allows fields other than those declared)

      • 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

      • getFieldNames

        public java.lang.Iterable<java.lang.String> getFieldNames()
        Get the names of all the fields
        Specified by:
        getFieldNames in interface TupleType
        Returns:
        the names of the fields (in arbitrary order)

      • getFieldType

        public SequenceType getFieldType​(java.lang.String field)
        Get the type of a given field
        Specified by:
        getFieldType in interface TupleType
        Parameters:
        field - the name of the field
        Returns:
        the type of the field if it is defined, or null otherwise

      • isOptionalField

        public boolean isOptionalField​(java.lang.String field)
        Ask whether a given field is optional
        Specified by:
        isOptionalField in interface TupleType
        Parameters:
        field - the name of the field
        Returns:
        true if the field is defined as an optional field

      • isExtensible

        public boolean isExtensible()
        Ask whether the record type is extensible, that is, whether fields other than those named are permitted
        Specified by:
        isExtensible in interface TupleType
        Returns:
        true if fields other than the named fields are permitted to appear

      • matches

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

      • 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 java.lang.String toString()
        Produce a representation of this type name for use in error messages.
        Overrides:
        toString in class AnyFunctionType
        Returns:
        a string representation of the type, in notation resembling but not necessarily identical to XPath syntax

      • toExportString

        public java.lang.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 record types.
        Specified by:
        toExportString in interface ItemType
        Returns:
        the string representation as an instance of the XPath ItemType construct

      • 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
        Overrides:
        getBasicAlphaCode in class AnyFunctionType
        Returns:
        the alphacode for the nearest containing built-in type

      • equals

        public boolean equals​(java.lang.Object other)
        Test whether this function type equals another function type
        Overrides:
        equals in class java.lang.Object

      • hashCode

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

      • explainMismatch

        public java.util.Optional<java.lang.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.
        Specified by:
        explainMismatch in interface ItemType
        Parameters:
        item - the item being matched
        th - the type hierarchy cache
        Returns:
        optionally, a message explaining why the item does not match the type