net.sf.saxon.pattern
Class SubstitutionGroupTest

java.lang.Object
  extended bynet.sf.saxon.pattern.Pattern
      extended bynet.sf.saxon.pattern.NodeTest
          extended bynet.sf.saxon.pattern.SubstitutionGroupTest
All Implemented Interfaces:
ItemType, java.io.Serializable

public class SubstitutionGroupTest
extends NodeTest

NodeTest is an interface that enables a test of whether a node has a particular name and type. A SubstitutionGroupTest matches element nodes whose name is one of a given set of names: it is used for KindTests of the form element(N) where all elements in a substitution group are to be matched.

Author:
Serialized Form

Field Summary
 
Fields inherited from class net.sf.saxon.pattern.Pattern
originalText
 
Constructor Summary
SubstitutionGroupTest(java.util.Set group)
          Constructor
 
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 getFingerprint()
          Get the fingerprint required
 int getNodeKind()
          Determine the types of nodes to which this pattern applies.
 boolean matches(int nodeType, int nameCode, int annotation)
          Test whether this node test is satisfied by a given node
 java.lang.String toString()
          Produce a representation of this type name for use in error messages.
 
Methods inherited from class net.sf.saxon.pattern.NodeTest
getNodeTest, getPrimitiveType, getSuperType, isSameType, matches, matchesItem
 
Methods inherited from class net.sf.saxon.pattern.Pattern
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

SubstitutionGroupTest

public SubstitutionGroupTest(java.util.Set group)
Constructor

Parameters:
group - A HashSet containing Integer values representing the fingerprints of element names included in the substitution group
Method Detail

matches

public boolean matches(int nodeType,
                       int nameCode,
                       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
nameCode - 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

getFingerprint

public int getFingerprint()
Get the fingerprint required

Overrides:
getFingerprint in class Pattern
Returns:
A fingerprint that the nodes must match, or -1 if it can match multiple fingerprints

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 java.lang.String toString()
Description copied from interface: ItemType
Produce a representation of this type name for use in error messages. Where this is a QName, it will use conventional prefixes

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