net.sf.saxon.pattern

Class NodeKindTest

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 NodeKindTestATTRIBUTE
static NodeKindTestCOMMENT
static NodeKindTestDOCUMENT
static NodeKindTestELEMENT
static NodeKindTestNAMESPACE
static NodeKindTestPROCESSING_INSTRUCTION
static NodeKindTestTEXT
Method Summary
booleanequals(Object other)
Indicates whether some other object is "equal to" this one.
AtomicTypegetAtomizedItemType()
Get the content type allowed by this NodeTest (that is, the type annotation).
SchemaTypegetContentType()
Get the content type allowed by this NodeTest (that is, the type of content allowed).
doublegetDefaultPriority()
Determine the default priority of this node test when used on its own as a Pattern
intgetNodeKindMask()
Get a mask indicating which kinds of nodes this NodeTest can match.
intgetPrimitiveType()
Determine the types of nodes to which this pattern applies.
inthashCode()
Returns a hash code value for the object.
static NodeTestmakeNodeKindTest(int kind)
Make a test for a given kind of node
booleanmatches(int nodeKind, int fingerprint, int annotation)
Test whether this node test is satisfied by a given node
booleanmatches(TinyTree tree, int nodeNr)
Test whether this node test is satisfied by a given node on a TinyTree.
booleanmatches(NodeInfo node)
Test whether this node test is satisfied by a given node.
StringtoString()
static StringtoString(int kind)

Field Detail

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 Detail

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.

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.

getDefaultPriority

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

getNodeKindMask

public int getNodeKindMask()
Get a mask indicating which kinds of nodes this NodeTest can match. This is a combination of bits: 1<

getPrimitiveType

public int getPrimitiveType()
Determine the types of nodes to which this pattern applies. Used for optimisation.

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

Parameters: nodeKind The type of node to be matched fingerprint identifies the expanded name of 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.

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

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.

Parameters: node the node to be matched

toString

public String toString()

toString

public static String toString(int kind)