net.sf.saxon.pattern

Class NodeKindTest

Implemented Interfaces:
ItemType, Serializable

public class NodeKindTest
extends NodeTest

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

Field Summary

static NodeKindTest
ATTRIBUTE
static NodeKindTest
COMMENT
static NodeKindTest
DOCUMENT
static NodeKindTest
ELEMENT
static NodeKindTest
NAMESPACE
static NodeKindTest
PROCESSING_INSTRUCTION
static NodeKindTest
TEXT

Method Summary

boolean
equals(Object other)
Indicates whether some other object is "equal to" this one.
AtomicType
getAtomizedItemType()
Get the content type allowed by this NodeTest (that is, the type annotation).
SchemaType
getContentType()
Get the content type allowed by this NodeTest (that is, the type of content allowed).
double
getDefaultPriority()
Determine the default priority of this node test when used on its own as a Pattern
int
getNodeKindMask()
Get a mask indicating which kinds of nodes this NodeTest can match.
int
getPrimitiveType()
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 node
boolean
matches(int nodeKind, int fingerprint, int annotation)
Test whether this node test is satisfied by a given node
boolean
matches(NodeInfo node)
Test whether this node test is satisfied by a given node.
boolean
matches(TinyTree tree, int nodeNr)
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 kind
String
toString()
static String
toString(int kind)

Methods inherited from class net.sf.saxon.pattern.NodeTest

getAtomizedItemType, getContentType, getDefaultPriority, getFingerprint, getNodeKindMask, getPrimitiveItemType, getPrimitiveType, getRequiredNodeNames, getSuperType, isAtomicType, isNillable, matches, matches, matches, matchesItem, toString

Field Details

ATTRIBUTE

public static final NodeKindTest ATTRIBUTE

COMMENT

public static final NodeKindTest COMMENT

DOCUMENT

public static final NodeKindTest DOCUMENT

ELEMENT

public static final NodeKindTest ELEMENT

NAMESPACE

public static final NodeKindTest NAMESPACE

PROCESSING_INSTRUCTION

public static final NodeKindTest PROCESSING_INSTRUCTION

TEXT

public static final NodeKindTest TEXT

Method Details

equals

public boolean equals(Object other)
Indicates whether some other object is "equal to" this one.

getAtomizedItemType

public AtomicType 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 interface ItemType
Overrides:
getAtomizedItemType in interface NodeTest

getContentType

public SchemaType 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 interface NodeTest

getDefaultPriority

public final double getDefaultPriority()
Determine the default priority of this node test when used on its own as a Pattern
Overrides:
getDefaultPriority in interface NodeTest

getNodeKindMask

public int getNodeKindMask()
Get a mask indicating which kinds of nodes this NodeTest can match. This is a combination of bits: 1<<Type.ELEMENT for element nodes, 1<<Type.TEXT for text nodes, and so on.
Overrides:
getNodeKindMask in interface NodeTest

getPrimitiveType

public int getPrimitiveType()
Determine the types of nodes to which this pattern applies. Used for optimisation.
Specified by:
getPrimitiveType in interface ItemType
Overrides:
getPrimitiveType in interface NodeTest
Returns:
the type of node matched by this pattern. e.g. Type.ELEMENT or Type.TEXT

hashCode

public int hashCode()
Returns a hash code value for the object.

makeNodeKindTest

public static NodeTest makeNodeKindTest(int kind)
Make a test for a given kind of node

matches

public boolean matches(int nodeKind,
                       int fingerprint,
                       int annotation)
Test whether this node test is satisfied by a given node
Overrides:
matches in interface NodeTest
Parameters:
nodeKind - The type of node to be matched
fingerprint - identifies the expanded name of the node to be matched

matches

public boolean matches(NodeInfo node)
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.
Overrides:
matches in interface NodeTest
Parameters:
node - the node to be matched

matches

public boolean matches(TinyTree tree,
                       int nodeNr)
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.
Overrides:
matches in interface NodeTest
Parameters:
tree - the TinyTree containing the node
nodeNr - the number of the node within the TinyTree
Returns:
true if the node matches the NodeTest, otherwise false

nodeKindName

public static String nodeKindName(int kind)
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"

toString

public String toString()

toString

public static String toString(int kind)