public abstract class NodeTest extends java.lang.Object implements ItemType.WithSequenceTypeCache
As well as being used to support XSLT pattern matching, NodeTests act as predicates in axis steps, and also act as item types for type matching.
For use in user-written application calling NodeInfo.iterateAxis(byte, NodeTest)
,
it is possible to write a user-defined subclass of NodeTest
that implements
a single method, matches(int, NodeName, SchemaType)
ItemType.WithSequenceTypeCache
Constructor and Description |
---|
NodeTest() |
Modifier and Type | Method and Description |
---|---|
NodeTest |
copy()
Copy a NodeTest.
|
java.lang.String |
generateJavaScriptItemTypeAcceptor(java.lang.String errorCode,
int targetVersion)
Generate Javascript code to convert a supplied Javascript value to this item type,
if conversion is possible, or throw an error otherwise.
|
AtomicType |
getAtomizedItemType()
Get the item type of the atomic values that will be produced when an item
of this type is atomized (assuming that atomization succeeds)
|
SchemaType |
getContentType()
Get the content type allowed by this NodeTest (that is, the type annotation of the matched nodes).
|
abstract double |
getDefaultPriority()
Determine the default priority to use if this node-test appears as a match pattern
for a template with no explicit priority attribute.
|
int |
getFingerprint()
Get the name of the nodes matched by this nodetest, if it matches a specific name.
|
IntPredicate |
getMatcher(NodeVectorTree tree)
Get a matching function that can be used to test whether numbered nodes in a TinyTree
or DominoTree satisfy the node test.
|
StructuredQName |
getMatchingNodeName()
Get the name of the nodes matched by this nodetest, if it matches a specific name.
|
int |
getNodeKindMask()
Get a mask indicating which kinds of nodes this NodeTest can match.
|
ItemType |
getPrimitiveItemType()
Get the primitive item type corresponding to this item type.
|
int |
getPrimitiveType()
Get the basic kind of object that this ItemType matches: for a NodeTest, this is the kind of node,
or Type.Node if it matches different kinds of nodes.
|
IntSet |
getRequiredNodeNames()
Get the set of node names allowed by this NodeTest.
|
boolean |
isAtomicType()
Determine whether this item type is an atomic type
|
boolean |
isAtomizable()
Ask whether values of this type are atomizable
|
boolean |
isNillable()
Determine whether the content type (if present) is nillable
|
boolean |
isPlainType()
Determine whether this item type is atomic (that is, whether it can ONLY match
atomic values)
|
abstract boolean |
matches(int nodeKind,
NodeName name,
SchemaType annotation)
Test whether this node test is satisfied by a given node.
|
boolean |
matches(Item item,
TypeHierarchy th)
Test whether a given item conforms to this type
|
boolean |
matchesNode(NodeInfo node)
Test whether this node test is satisfied by a given node.
|
SequenceType |
one()
Get a sequence type representing exactly one instance of this atomic type
|
SequenceType |
oneOrMore()
Get a sequence type representing one or more instances of this atomic type
|
java.lang.String |
toExportString()
Return a string representation of this SequenceType suitable for use in export (SEF) files.
|
void |
visitNamedSchemaComponents(SchemaComponentVisitor visitor)
Visit all the schema components used in this ItemType definition
|
SequenceType |
zeroOrMore()
Get a sequence type representing one or more instances of this atomic type
|
SequenceType |
zeroOrOne()
Get a sequence type representing zero or one instances of this atomic type
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
generateJavaScriptItemTypeTest, getUType, toString
public abstract double getDefaultPriority()
public boolean matches(Item item, TypeHierarchy th)
ItemType
public ItemType getPrimitiveItemType()
getPrimitiveItemType
in interface ItemType
public int getPrimitiveType()
getPrimitiveType
in interface ItemType
public int getFingerprint()
public StructuredQName getMatchingNodeName()
public boolean isAtomicType()
isAtomicType
in interface ItemType
public boolean isPlainType()
isPlainType
in interface ItemType
public AtomicType getAtomizedItemType()
getAtomizedItemType
in interface ItemType
public boolean isAtomizable()
isAtomizable
in interface ItemType
public java.lang.String toExportString()
toExportString
in interface ItemType
public IntPredicate getMatcher(NodeVectorTree tree)
matchesNode(tree.getNode(nodeNr))
, but it may well be faster).tree
- the tree against which the returned function will operatepublic abstract boolean matches(int nodeKind, NodeName name, SchemaType annotation)
nodeKind
- The kind of node to be matchedname
- identifies the expanded name of the node to be matched.
The value should be null for a node with no name.annotation
- The actual content type of the node. Null means no constraint.public boolean matchesNode(NodeInfo node)
matches(int, NodeName, SchemaType)
node
- the node to be matchedpublic int getNodeKindMask()
public SchemaType getContentType()
public IntSet getRequiredNodeNames()
public boolean isNillable()
public void visitNamedSchemaComponents(SchemaComponentVisitor visitor) throws XPathException
visitNamedSchemaComponents
in interface ItemType
visitor
- the visitor class to be called when each component is visitedXPathException
- if an error occurspublic NodeTest copy()
public java.lang.String generateJavaScriptItemTypeAcceptor(java.lang.String errorCode, int targetVersion) throws XPathException
generateJavaScriptItemTypeAcceptor
in interface ItemType
errorCode
- the error to be thrown if conversion is not possibletargetVersion
- XPathException
public SequenceType one()
one
in interface ItemType.WithSequenceTypeCache
public SequenceType zeroOrOne()
zeroOrOne
in interface ItemType.WithSequenceTypeCache
public SequenceType oneOrMore()
oneOrMore
in interface ItemType.WithSequenceTypeCache
public SequenceType zeroOrMore()
zeroOrMore
in interface ItemType.WithSequenceTypeCache
Copyright (c) 2004-2018 Saxonica Limited. All rights reserved.