Class NodeKindTest

java.lang.Object
net.sf.saxon.pattern.NodeTest
net.sf.saxon.pattern.NodeKindTest
All Implemented Interfaces:
Serializable, ItemType

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
See Also:
  • Field Details

  • Method Details

    • 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
      Specified by:
      matches in class NodeTest
      Parameters:
      nodeKind - The type of node to be matched
      fingerprint - identifies the expanded name of the node to be matched
      annotation - The actual content type of the node
    • 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.
      Specified by:
      matches in class 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
    • 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.
      Specified by:
      matches in class NodeTest
      Parameters:
      node - the node to be matched
    • getDefaultPriority

      public final double getDefaultPriority()
      Determine the default priority of this node test when used on its own as a Pattern
      Specified by:
      getDefaultPriority in class 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 class NodeTest
      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.
      Specified by:
      getNodeKindMask in class 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 class NodeTest
    • 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 class NodeTest
    • toString

      public String toString()
      Overrides:
      toString in class Object
    • toString

      public static String toString(int kind)
    • hashCode

      public int hashCode()
      Returns a hash code value for the object.
      Overrides:
      hashCode in class Object
    • equals

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