net.sf.saxon.pattern
Class LocalNameTest

java.lang.Object
  extended by net.sf.saxon.pattern.Pattern
      extended by net.sf.saxon.pattern.NodeTest
          extended by net.sf.saxon.pattern.LocalNameTest
All Implemented Interfaces:
Serializable, ItemType

public final class LocalNameTest
extends NodeTest

NodeTest is an interface that enables a test of whether a node has a particular name and type. A LocalNameTest matches the node type and the local name, it represents an XPath 2.0 test of the form *:name.

Author:
Serialized Form

Field Summary
 
Fields inherited from class net.sf.saxon.pattern.Pattern
originalText
 
Constructor Summary
LocalNameTest(NamePool pool, int nodeType, String localName)
           
 
Method Summary
 boolean allowsTextNodes()
          Indicate whether this NodeTest is capable of matching text nodes
 double getDefaultPriority()
          Determine the default priority of this node test when used on its own as a Pattern
 int getNodeKind()
          Determine the types of nodes to which this pattern applies.
 boolean matches(int nodeType, int fingerprint, int annotation)
          Test whether this node test is satisfied by a given node
 String toString()
          Get the original pattern text
 
Methods inherited from class net.sf.saxon.pattern.NodeTest
getNodeTest, getPrimitiveType, getSuperType, isSameType, matches, matchesItem
 
Methods inherited from class net.sf.saxon.pattern.Pattern
getFingerprint, getLineNumber, getSystemId, internalMatches, make, setLineNumber, setOriginalText, setSystemId, simplify, typeCheck
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

LocalNameTest

public LocalNameTest(NamePool pool,
                     int nodeType,
                     String localName)
Method Detail

matches

public boolean matches(int nodeType,
                       int fingerprint,
                       int annotation)
Test whether this node test is satisfied by a given node

Specified by:
matches in class NodeTest
Parameters:
nodeType - 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

getDefaultPriority

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

Overrides:
getDefaultPriority in class Pattern

getNodeKind

public int getNodeKind()
Determine the types of nodes to which this pattern applies. Used for optimisation. For patterns that match nodes of several types, return Type.NODE

Overrides:
getNodeKind in class Pattern
Returns:
the type of node matched by this pattern. e.g. Type.ELEMENT or Type.TEXT

allowsTextNodes

public boolean allowsTextNodes()
Indicate whether this NodeTest is capable of matching text nodes

Specified by:
allowsTextNodes in class NodeTest

toString

public String toString()
Description copied from class: Pattern
Get the original pattern text

Specified by:
toString in interface ItemType
Overrides:
toString in class Pattern