Class IdrefTest

java.lang.Object
net.sf.saxon.pattern.NodeTest
net.sf.saxon.pattern.IdrefTest
All Implemented Interfaces:
Serializable, ItemType
public class IdrefTest extends NodeTest
NodeTest is an interface that enables a test of whether a node matches particular conditions. IdrefTest is a test that cannot be represented directly in XPath or XSLT patterns, but which is used internally for matching IDREF nodes: it tests whether the node has the is-idref property

Beware: The TypeHierarchy.computeRelationship() method does not work with this kind of ItemType.

Author:
Michael H. Kay
See Also:

  • Constructor Details

    • IdrefTest

      public IdrefTest(int nodeKind)
      Create a IdrefTest
      Parameters:
      nodeKind - the kind of nodes to be matched: always elements or attributes

  • Method Details

    • getSuperType

      public ItemType getSuperType(TypeHierarchy th)
      Description copied from class: NodeTest
      Get the type from which this item type is derived by restriction. This is the supertype in the XPath type heirarchy, as distinct from the Schema base type: this means that the supertype of xs:boolean is xdt:anyAtomicType, whose supertype is item() (rather than xs:anySimpleType).

      In fact the concept of "supertype" is not really well-defined, because the types form a lattice rather than a hierarchy. The only real requirement on this function is that it returns a type that strictly subsumes this type, ideally as narrowly as possible.

      Specified by:
      getSuperType in interface ItemType
      Overrides:
      getSuperType in class NodeTest
      Parameters:
      th -
      Returns:
      the supertype, or null if this type is item()

    • 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 (never an attribute)
      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

    • getAtomizedItemType

      public AtomicType getAtomizedItemType()
      Get the item type of the atomic values that will be produced when an item of this type is atomized (assuming that atomization succeeds)
      Specified by:
      getAtomizedItemType in interface ItemType
      Overrides:
      getAtomizedItemType in class NodeTest

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • 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