Package net.sf.saxon.pattern
Class NodeKindTest
java.lang.Object
net.sf.saxon.pattern.NodeTest
net.sf.saxon.pattern.NodeKindTest
- All Implemented Interfaces:
Serializable
,ItemType
NodeTest is an interface that enables a test of whether a node has a particular
name and kind. A NodeKindTest matches the node kind only.
- Author:
- Michael H. Kay
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final NodeKindTest
static final NodeKindTest
static final NodeKindTest
static final NodeKindTest
static final NodeKindTest
static final NodeKindTest
static final NodeKindTest
-
Method Summary
Modifier and TypeMethodDescriptionboolean
Indicates whether some other object is "equal to" this one.Get the content type allowed by this NodeTest (that is, the type annotation).Get the content type allowed by this NodeTest (that is, the type of content allowed).final double
Determine the default priority of this node test when used on its own as a Patternint
Get a mask indicating which kinds of nodes this NodeTest can match.int
Determine the types of nodes to which this pattern applies.int
hashCode()
Returns a hash code value for the object.static NodeTest
makeNodeKindTest
(int kind) Make a test for a given kind of nodeboolean
Test whether this node test is satisfied by a given node.boolean
Test whether this node test is satisfied by a given node.boolean
Test whether this node test is satisfied by a given node on a TinyTree.static String
nodeKindName
(int kind) Get the name of a node kindtoString()
static String
toString
(int kind) Methods inherited from class net.sf.saxon.pattern.NodeTest
getFingerprint, getPrimitiveItemType, getRequiredNodeNames, getSuperType, isAtomicType, isAtomizable, isNillable, isPlainType, matches, matchesItem, toString, visitNamedSchemaComponents
-
Field Details
-
DOCUMENT
-
ELEMENT
-
ATTRIBUTE
-
TEXT
-
COMMENT
-
PROCESSING_INSTRUCTION
-
NAMESPACE
-
-
Method Details
-
makeNodeKindTest
Make a test for a given kind of node -
matches
Test whether this node test is satisfied by a given node. This method is only fully supported for a subset of NodeTests, because it doesn't provide all the information needed to evaluate all node tests. In particular (a) it can't be used to evaluate a node test of the form element(N,T) or schema-element(E) where it is necessary to know whether the node is nilled, and (b) it can't be used to evaluate a node test of the form document-node(element(X)). This in practice means that it is used (a) to evaluate the simple node tests found in the XPath 1.0 subset used in XML Schema, and (b) to evaluate node tests where the node kind is known to be an attribute. -
matches
Test whether this node test is satisfied by a given node on a TinyTree. The node must be a document, element, text, comment, or processing instruction node. This method is provided so that when navigating a TinyTree a node can be rejected without actually instantiating a NodeInfo object. -
matches
Test whether this node test is satisfied by a given node. This alternative method is used in the case of nodes where calculating the fingerprint is expensive, for example DOM or JDOM nodes. -
getDefaultPriority
public final double getDefaultPriority()Determine the default priority of this node test when used on its own as a Pattern- Returns:
- the default priority
-
getPrimitiveType
public int getPrimitiveType()Determine the types of nodes to which this pattern applies. Used for optimisation.- Specified by:
getPrimitiveType
in interfaceItemType
- Overrides:
getPrimitiveType
in classNodeTest
- Returns:
- the type of node matched by this pattern. e.g. Type.ELEMENT or Type.TEXT
-
getNodeKindMask
public int getNodeKindMask()Get a mask indicating which kinds of nodes this NodeTest can match. This is a combination of bits: 1invalid input: '<'invalid input: '<'Type.ELEMENT for element nodes, 1invalid input: '<'invalid input: '<'Type.TEXT for text nodes, and so on.- Overrides:
getNodeKindMask
in classNodeTest
- Returns:
- a combination of bits: 1invalid input: '<'invalid input: '<'Type.ELEMENT for element nodes, 1invalid input: '<'invalid input: '<'Type.TEXT for text nodes, and so on
-
getContentType
Get the content type allowed by this NodeTest (that is, the type of content allowed). Return AnyType if there are no restrictions.- Overrides:
getContentType
in classNodeTest
- Returns:
- the type annotation that all nodes matching this NodeTest must satisfy
-
getAtomizedItemType
Get the content type allowed by this NodeTest (that is, the type annotation). Return AnyType if there are no restrictions. The default implementation returns AnyType.- Specified by:
getAtomizedItemType
in interfaceItemType
- Overrides:
getAtomizedItemType
in classNodeTest
- Returns:
- the best available item type of the atomic values that will be produced when an item of this type is atomized
-
toString
-
toString
-
nodeKindName
Get the name of a node kind- Parameters:
kind
- the node kind, for example Type.ELEMENT or Type.ATTRIBUTE- Returns:
- the name of the node kind, for example "element" or "attribute"
-
hashCode
public int hashCode()Returns a hash code value for the object. -
equals
Indicates whether some other object is "equal to" this one.
-