Package net.sf.saxon.pattern

Class LocalNameTest

java.lang.Object

net.sf.saxon.pattern.NodeTest

net.sf.saxon.pattern.LocalNameTest

All Implemented Interfaces:

NodePredicate, QNameTest, ItemType, ItemTypeWithSequenceTypeCache

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.

Constructor Summary

Constructors

Constructor	Description
LocalNameTest(NamePool pool, int nodeKind, java.lang.String localName)

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object other)	Indicates whether some other object is "equal to" this one.
java.util.Optional<java.lang.String>	explainMismatch(Item item, TypeHierarchy th)	Get extra diagnostic information about why a supplied item does not conform to this item type, if available.
java.lang.String	exportQNameTest()	Export the QNameTest as a string for use in a SEF file (typically in a catch clause).
double	getDefaultPriority()	Determine the default priority of this node test when used on its own as a Pattern
java.lang.String	getFullAlphaCode()	Get the full alpha code for this item type.
java.lang.String	getLocalName()	Get the local name used in this LocalNameTest
IntPredicateProxy	getMatcher(NodeVectorTree tree)	Get a matching function that can be used to test whether numbered nodes in a TinyTree or DominoTree satisfy the node test.
NamePool	getNamePool()
int	getNodeKind()	Get the node kind matched by this test
int	getPrimitiveType()	Determine the types of nodes to which this pattern applies.
java.util.Optional<IntSet>	getRequiredNodeNames()	Get the set of node names allowed by this NodeTest.
UType	getUType()	Get the corresponding UType.
int	hashCode()	Returns a hash code value for the object.
boolean	matches(int nodeKind, NodeName name, SchemaType annotation)	Test whether this node test is satisfied by a given node.
boolean	matches(StructuredQName qname)	Test whether this QNameTest matches a given QName
boolean	matchesFingerprint(NamePool namePool, int fp)	Test whether the QNameTest matches a given fingerprint
boolean	test(NodeInfo node)	Test whether this node test is satisfied by a given node.
java.lang.String	toString()

Methods inherited from class net.sf.saxon.pattern.NodeTest

copy, getAtomizedItemType, getBasicAlphaCode, getContentType, getFingerprint, getGenre, getMatchingNodeName, getPrimitiveItemType, isAtomicType, isAtomizable, isNillable, isPlainType, matches, one, oneOrMore, toShortString, zeroOrMore, zeroOrOne

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.sf.saxon.type.ItemType

getNormalizedDefaultPriority, toExportString

Constructor Detail

LocalNameTest

public LocalNameTest(NamePool pool,
                     int nodeKind,
                     java.lang.String localName)

Method Detail

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 java.util.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:*)

getFullAlphaCode

public java.lang.String getFullAlphaCode()

Description copied from interface: ItemType

Get the full alpha code for this item type. As well as the basic alpha code, this contains additional information, for example element(EFG) has a basic alpha code of NE, but the full alpha code of NE nQ{}EFG.

Specified by:

getFullAlphaCode in interface ItemType

Returns:

the alpha code for the type

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 IntPredicateProxy 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.

test

public boolean test(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:

test in interface NodePredicate

Overrides:

test 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

matchesFingerprint

public boolean matchesFingerprint(NamePool namePool,
                                  int fp)

Test whether the QNameTest matches a given fingerprint

Specified by:

matchesFingerprint in interface QNameTest

Parameters:

namePool - the name pool

fp - the fingerprint of 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 interface ItemType

Specified by:

getDefaultPriority in class NodeTest

Returns:

the default priority for the pattern

getLocalName

public java.lang.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 java.lang.String toString()

Overrides:

toString in class java.lang.Object

hashCode

public int hashCode()

Returns a hash code value for the object.

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object other)

Indicates whether some other object is "equal to" this one.

Overrides:

equals in class java.lang.Object

getNamePool

public NamePool getNamePool()

exportQNameTest

public java.lang.String exportQNameTest()

Export the QNameTest as a string for use in a SEF file (typically in a catch clause).

Specified by:

exportQNameTest in interface QNameTest

Returns:

a string representation of the QNameTest, suitable for use in export files. The format is a sequence of alternatives separated by vertical bars, where each alternative is one of '*', '*:localname', 'Q{uri}*', or 'Q{uri}local'.

explainMismatch

public java.util.Optional<java.lang.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