Package net.sf.saxon.s9api

Class ItemTypeFactory

  • public class ItemTypeFactory
extends java.lang.Object
    This class is used for creating ItemType objects.

    The ItemTypeFactory class is thread-safe.

    • Constructor Detail

      • ItemTypeFactory

        public ItemTypeFactory​(Processor processor)
        Create an ItemTypeFactory
        Parameters:
        processor - the processor used by this ItemTypeFactory. This must be supplied in the case of user-defined types or types that reference element or attribute names; for built-in types it can be omitted.

    • Method Detail

      • parseItemType

        public ItemType parseItemType​(java.lang.String typeDesignation)
                       throws SaxonApiException
        Parse an item type in XPath syntax.

        Saxon extensions such as union types and tuple types are enabled.

        Parameters:
        typeDesignation - the lexical representation of the item type in XPath syntax, for example map(xs:string, node()*). The namespace prefix xs is recognized; any other namespaced names should be written using Q{uri}local notation.
        Returns:
        the ItemType
        Throws:
        SaxonApiException - if the syntax is invalid
        Since:
        12.0

      • getAtomicType

        public ItemType getAtomicType​(QName name)
                       throws SaxonApiException
        Get an item type representing an atomic type. This may be a built-in type in the XML Schema namespace, or a user-defined atomic type. The resulting type will use the conversion rules configured for the supplied Processor.

        It is undefined whether two calls supplying the same QName will return the same ItemType object.

        Parameters:
        name - the name of the built-in or user-defined atomic type required
        Returns:
        an ItemType object representing this built-in or user-defined atomic type
        Throws:
        SaxonApiException - if the type name is not known, or if the type identified by the name is not an atomic type.

      • getNodeKindTest

        public ItemType getNodeKindTest​(XdmNodeKind kind)
        Get an item type that matches any node of a specified kind.

        This corresponds to the XPath syntactic forms element(), attribute(), document-node(), text(), comment(), processing-instruction(). It also provides an option, not available in the XPath syntax, that matches namespace nodes.

        It is undefined whether two calls supplying the same argument value will return the same ItemType object.

        Parameters:
        kind - the kind of node for which a NodeTest is required
        Returns:
        an item type corresponding to the specified kind of node

      • getItemType

        public ItemType getItemType​(XdmNodeKind kind,
                            QName name)
        Get an item type that matches nodes of a specified kind with a specified name.

        This corresponds to the XPath syntactic forms element(name), attribute(name), and processing-instruction(name). In the case of processing-instruction, the supplied QName must have no namespace.

        It is undefined whether two calls supplying the same argument values will return the same ItemType object.

        Parameters:
        kind - the kind of nodes that match
        name - the name of the nodes that match
        Returns:
        an ItemType that matches nodes of a given node kind with a given name
        Throws:
        java.lang.IllegalArgumentException - if the node kind is other than element, attribute, or processing instruction, or if the node kind is processing instruction and the name is in a namespace.

      • getSchemaElementTest

        public ItemType getSchemaElementTest​(QName name)
                              throws SaxonApiException
        Make an ItemType representing an element declaration in the schema. This is the equivalent of the XPath syntax schema-element(element-name)

        It is undefined whether two calls supplying the same argument values will return the same ItemType object.

        Parameters:
        name - the element name
        Returns:
        the ItemType
        Throws:
        SaxonApiException - if the schema does not contain a global element declaration for the given name, or if the element declaration contains dangling references to other schema components

      • getElementTest

        public ItemType getElementTest​(QName name,
                               QName schemaType,
                               boolean nillable)
                        throws SaxonApiException
        Make an ItemType that tests an element name and/or schema type. This is the equivalent of the XPath syntax element(element-name, type)

        It is undefined whether two calls supplying the same argument values will return the same ItemType object.

        Parameters:
        name - the element name, or null if there is no constraint on the name (equivalent to specifying element(*, type))
        schemaType - the name of the required schema type, or null if there is no constraint on the type (equivalent to specifying element(name))
        nillable - if a nilled element is allowed to match the type (equivalent to specifying "?" after the type name). The value is ignored if schemaType is null.
        Returns:
        the constructed ItemType
        Throws:
        SaxonApiException - if the schema does not contain a global element declaration for the given name

      • getSchemaAttributeTest

        public ItemType getSchemaAttributeTest​(QName name)
                                throws SaxonApiException
        Get an ItemType representing an attribute declaration in the schema. This is the equivalent of the XPath syntax schema-attribute(attribute-name)

        It is undefined whether two calls supplying the same argument values will return the same ItemType object.

        Parameters:
        name - the attribute name
        Returns:
        the ItemType
        Throws:
        SaxonApiException - if the schema does not contain a global attribute declaration for the given name, or if the attribute declaration contains dangling references to other schema components

      • getAttributeTest

        public ItemType getAttributeTest​(QName name,
                                 QName schemaType)
                          throws SaxonApiException
        Get an ItemType that tests an attribute name and/or schema type. This is the equivalent of the XPath syntax element(element-name, type)

        It is undefined whether two calls supplying the same argument values will return the same ItemType object.

        Parameters:
        name - the element name, or null if there is no constraint on the name (equivalent to specifying element(*, type))
        schemaType - the name of the required schema type, or null of there is no constraint on the type (equivalent to specifying element(name))
        Returns:
        the constructed ItemType
        Throws:
        SaxonApiException - if the schema does not contain a global element declaration for the given name

      • getDocumentTest

        public ItemType getDocumentTest​(ItemType elementTest)
        Make an ItemType representing a document-node() test with an embedded element test. This reflects the XPath syntax document-node(element(N, T)) or document-node(schema-element(N)).

        It is undefined whether two calls supplying the same argument values will return the same ItemType object.

        Parameters:
        elementTest - the elementTest. An IllegalArgumentException is thrown if the supplied ItemTest is not an elementTest or schemaElementTest.
        Returns:
        a new ItemType representing the document test

      • getExternalObjectType

        public ItemType getExternalObjectType​(java.lang.Class externalClass)
        Get an ItemType representing the type of a Java object when used as an external object for use in conjunction with calls on extension/external functions.
        Parameters:
        externalClass - a Java class
        Returns:
        the ItemType representing the type of external objects of this class

      • getExternalObject

        public XdmItem getExternalObject​(java.lang.Object object)
        Factory method to construct an "external object". This is an XDM value that wraps a Java object. Such values can be passed as parameters to stylesheets or queries, for use in conjunction with external (extension) functions.

        Changed in Saxon 9.5 to return XdmItem rather than XdmAtomicValue, since wrapped external objects are now modelled as a separate type of item, rather than as an atomic value.

        Parameters:
        object - the value to be wrapped as an external object. Must not be null.
        Returns:
        the object, wrapped as an XdmItem

      • getMapType

        public ItemType getMapType​(ItemType keyType,
                           SequenceType valueType)
        Obtain a map type, that is a type for XDM maps with a given key type and value type
        Parameters:
        keyType - the type of the keys in the map
        valueType - the type of the values in the map
        Returns:
        the required map type

      • getFunctionType

        public ItemType getFunctionType​(SequenceType returnType,
                                SequenceType... argumentTypes)
        Obtain a function type, that is a type for XDM functions with given argument types and a given result type.
        Parameters:
        returnType - the type of the function's result
        argumentTypes - the types of the argument values
        Returns:
        the required function type

      • getArrayType

        public ItemType getArrayType​(SequenceType memberType)
        Obtain an array type, that is a type for XDM arrays with a given member type
        Parameters:
        memberType - the type of the members in the array
        Returns:
        the required array type

      • newMap

        @Deprecated
public XdmMap newMap​(java.util.Map<?,​?> map)
              throws SaxonApiException
        Deprecated.
        since 12.0 - use XdmMap.makeMap(java.util.Map<K, V>) instead
        Factory method to construct a map item from a Java map

        Note: this is merely a wrapper around XdmMap.makeMap(java.util.Map<K, V>), which is probably more convenient to use.

        Parameters:
        map - the input map. The contents of this map are shallow-copied, so subsequent changes to the Java map do not affect the XDM map. The keys in the map must be convertible to atomic values, and the values in the map must be convertible to XDM values.
        Returns:
        an XDM item representing the contents of the map. This is of type function item because XDM maps are functions (from the key to the value).
        Throws:
        SaxonApiException - if there are values that cannot be converted.
        Since:
        9.6

      • getItemType

        public ItemType getItemType​(XdmItem item)
        Get an ItemType representing the type of a supplied XdmItem.

        Note that the results are to some extent arbitrary, since an item may conform to many different item types, and none of them is necessarily more specific than all the others.

        If the supplied item is an atomic value, the returned ItemType will reflect the most specific atomic type of the item.

        If the supplied item is a node, the returned item type will reflect the node kind, and if the node has a name, then its name. It will not reflect the type annotation.

        For a map, the result is simply ItemType.ANY_MAP. For an array, the result is simply ItemType.ANY_ARRAY. For any other function, it is an instance of XdmFunctionItem that reflects the signature of the function.

        If the item is an external object, a suitable item type object is constructed.

        Future versions of Saxon may return a more precise type.

        Parameters:
        item - the supplied item whose type is required
        Returns:
        the type of the supplied item

      • exposeItemType

        public ItemType exposeItemType​(ItemType it)
        Obtain a s9api ItemType corresponding to an underlying instance of ItemType
        Parameters:
        it - the supplied instance of ItemType
        Returns:
        a corresponding instance of ItemType
        Since:
        10.0