net.sf.saxon.s9api
public class ItemTypeFactory extends Object
The ItemTypeFactory
class is thread-safe.
Constructor Summary | |
---|---|
ItemTypeFactory(Processor processor)
Create an ItemTypeFactory |
Method Summary | |
---|---|
ItemType | getAtomicType(QName name)
Get an item type representing an atomic type. |
ItemType | getAttributeTest(QName name, QName schemaType)
Get an ItemType that tests an element name and/or schema type. |
ItemType | getDocumentTest(ItemType elementTest)
Make an ItemType representing a document-node() test with an embedded element test.
|
ItemType | getElementTest(QName name, QName schemaType, boolean nillable)
Make an ItemType that tests an element name and/or schema type. |
XdmAtomicValue | getExternalObject(Object object)
Factory method to construct an "external object". |
ItemType | getExternalObjectType(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. |
ItemType | getItemType(XdmNodeKind kind, QName name)
Get an item type that matches nodes of a specified kind with a specified name.
|
ItemType | getItemType(XdmItem item)
Get an ItemType representing the type of a supplied XdmItem. |
ItemType | getNodeKindTest(XdmNodeKind kind)
Get an item type that matches any node of a specified kind.
|
ItemType | getSchemaAttributeTest(QName name)
Get an ItemType representing an attribute declaration in the schema. |
ItemType | getSchemaElementTest(QName name)
Make an ItemType representing an element declaration in the schema. |
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.
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.
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
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
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
Each call on this method will return a distinct XdmAtomicValue
object.
Parameters: object the value to be wrapped as an external object
Returns: the object, wrapped as an XdmAtomicValue
Parameters: externalClass a Java class
Returns: the ItemType representing the type of external objects of this class
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: 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.
Parameters: item the supplied item whose type is required
Returns: the type of the supplied item
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
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
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