Package net.sf.saxon.pattern

Class LocalNameTest

java.lang.Object
net.sf.saxon.pattern.NodeTest
net.sf.saxon.pattern.LocalNameTest
All Implemented Interfaces:
QNameTest, ItemType, ItemType.WithSequenceTypeCache
public final class LocalNameTest extends NodeTest implements QNameTest
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:
Michael H. Kay

  • Constructor Details

    • LocalNameTest

      public LocalNameTest(NamePool pool, int nodeKind, String localName)

  • Method Details

    • getNodeKind

      public int getNodeKind()
      Get the node kind matched by this test
      Returns:
      the matching node kind

    • getUType

      public UType getUType()
      Get the corresponding UType. A UType is a union of primitive item types.
      Specified by:
      getUType in interface ItemType
      Returns:
      the smallest UType that subsumes this item type

    • getRequiredNodeNames

      public Optional<IntSet> getRequiredNodeNames()
      Get the set of node names allowed by this NodeTest. Return no result, because the set of names cannot be represented.
      Overrides:
      getRequiredNodeNames in class NodeTest
      Returns:
      the set of integer fingerprints of the node names that this node test can match; or absent if the set of names cannot be represented (for example, with the name tests *:xxx or xxx:*)

    • matches

      public boolean matches(int nodeKind, NodeName name, SchemaType annotation)
      Test whether this node test is satisfied by a given node. This method is only fully supported for a subset of NodeTests, because it doesn't provide all the information needed to evaluate all node tests. In particular (a) it can't be used to evaluate a node test of the form element(N,T) or schema-element(E) where it is necessary to know whether the node is nilled, and (b) it can't be used to evaluate a node test of the form document-node(element(X)). This in practice means that it is used (a) to evaluate the simple node tests found in the XPath 1.0 subset used in XML Schema, and (b) to evaluate node tests where the node kind is known to be an attribute.
      Specified by:
      matches in class NodeTest
      Parameters:
      nodeKind - The kind of node to be matched
      name - identifies the expanded name of the node to be matched. The value should be null for a node with no name.
      annotation - The actual content type of the node
      Returns:
      true if the node matches this node test

    • getMatcher

      public IntPredicate getMatcher(NodeVectorTree tree)
      Description copied from class: NodeTest
      Get a matching function that can be used to test whether numbered nodes in a TinyTree or DominoTree satisfy the node test. (Calling this matcher must give the same result as calling matchesNode(tree.getNode(nodeNr)), but it may well be faster).
      Overrides:
      getMatcher in class NodeTest
      Parameters:
      tree - the tree against which the returned function will operate
      Returns:
      an IntPredicate; the matches() method of this predicate takes a node number as input, and returns true if and only if the node identified by this node number matches the node test.

    • matchesNode

      public boolean matchesNode(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.
      Overrides:
      matchesNode in class NodeTest
      Parameters:
      node - the node to be matched
      Returns:
      true if the node test is satisfied by the supplied node, false otherwise

    • matches

      public boolean matches(StructuredQName qname)
      Test whether this QNameTest matches a given QName
      Specified by:
      matches in interface QNameTest
      Parameters:
      qname - the QName to be matched
      Returns:
      true if the name matches, false if not

    • 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
      Returns:
      the default priority for the pattern

    • getLocalName

      public String getLocalName()
      Get the local name used in this LocalNameTest
      Returns:
      the local name matched by the test

    • getPrimitiveType

      public int getPrimitiveType()
      Determine the types of nodes to which this pattern applies. Used for optimisation. For patterns that match nodes of several types, return Type.NODE
      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

    • toString

      public String toString()
      Specified by:
      toString in interface ItemType
      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

    • getNamePool

      public NamePool getNamePool()

    • generateJavaScriptNameTest

      public String generateJavaScriptNameTest(int targetVersion)
      Generate Javascript code to test if a name matches the test.
      Specified by:
      generateJavaScriptNameTest in interface QNameTest
      Parameters:
      targetVersion - the version of Saxon-JS being targeted
      Returns:
      JS code as a string. The generated code will be used as the body of a JS function in which the argument name "q" is an XdmQName object holding the name. The XdmQName object has properties uri and local.

    • generateJavaScriptItemTypeTest

      public String generateJavaScriptItemTypeTest(ItemType knownToBe, int targetVersion)
      Generate Javascript code to test whether an item conforms to this item type
      Specified by:
      generateJavaScriptItemTypeTest in interface ItemType
      Parameters:
      knownToBe - An item type that the supplied item is known to conform to; the generated code can assume that the item is an instance of this type.
      targetVersion - The version of Saxon-JS for which code is being generated. Currently either 1 or 2.
      Returns:
      a Javascript instruction or sequence of instructions, which can be used as the body of a Javascript function, and which returns a boolean indication whether the value of the variable "item" is an instance of this item type.

    • explainMismatch

      public Optional<String> explainMismatch(Item item, TypeHierarchy th)
      Get extra diagnostic information about why a supplied item does not conform to this item type, if available. If extra information is returned, it should be in the form of a complete sentence, minus the closing full stop. No information should be returned for obvious cases.
      Specified by:
      explainMismatch in interface ItemType
      Overrides:
      explainMismatch in class NodeTest
      Parameters:
      item - the item that doesn't match this type
      th - the type hierarchy cache
      Returns:
      optionally, a message explaining why the item does not match the type