Interface TupleType

  • All Superinterfaces:
    FunctionItemType, ItemType
    All Known Implementing Classes:
    TupleItemType

    public interface TupleType
    extends FunctionItemType
    An instance of this class represents a specific tuple item type, for example tuple(x: xs:double, y: element(employee)). Tuple types are a Saxon extension introduced in Saxon 9.8. The syntax for constructing a tuple type requires Saxon-PE or higher, but the supporting code is included in Saxon-HE for convenience.
    • Method Detail

      • getFieldNames

        Iterable<String> getFieldNames()
        Get the names of all the fields
        Returns:
        the names of the fields (in arbitrary order)
      • getFieldType

        SequenceType getFieldType​(String field)
        Get the type of a given field
        Parameters:
        field - the name of the field
        Returns:
        the type of the field if it is defined, or null otherwise
      • isOptional

        boolean isOptional​(String field)
        Ask whether a particular field is optional (that is, allowed to be absent from the map)
        Parameters:
        field - the name of the field
        Returns:
        true if the field is optional
      • isExtensible

        boolean isExtensible()
        Ask whether the tuple type is extensible, that is, whether fields other than those named are permitted
        Returns:
        true if fields other than the named fields are permitted to appear