net.sf.saxon.pattern
Class CombinedNodeTest
- ItemType, Serializable
public class CombinedNodeTest
A CombinedNodeTest combines two nodetests using one of the operators
union (=or), intersect (=and), difference (= "and not"). This arises
when optimizing a union (etc) of two path expressions using the same axis.
A CombinedNodeTest is also used to support constructs such as element(N,T),
which can be expressed as (element(N,*) AND element(*,T))
boolean | equals(Object other) - Indicates whether some other object is "equal to" this one.
|
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)
|
NodeTest[] | getComponentNodeTests() - Get the two parts of the combined node test
|
SchemaType | getContentType() - Get the content type allowed by this NodeTest (that is, the type annotation of the matched nodes).
|
double | getDefaultPriority() - get the default priority of this nodeTest when used as a pattern
|
int | getFingerprint() - Get the name of the nodes matched by this nodetest, if it matches a specific name.
|
int | getNodeKindMask() - Get a mask indicating which kinds of nodes this NodeTest can match.
|
int | getOperator() - Get the operator used to combine the two node tests: one of
Token.UNION ,
Token.INTERSECT , Token.EXCEPT ,
|
int | getPrimitiveType() - Get the basic kind of object that this ItemType matches: for a NodeTest, this is the kind of node,
or Type.Node if it matches different kinds of nodes.
|
IntHashSet | getRequiredNodeNames() - Get the set of node names allowed by this NodeTest.
|
ItemType | getSuperType(TypeHierarchy th) - Get the supertype of this type.
|
int | hashCode() - Returns a hash code value for the object.
|
boolean | isNillable() - Determine whether the content type (if present) is nillable
|
boolean | matches(int nodeType, int fingerprint, int annotation) - Test whether this node test is satisfied by a given node.
|
boolean | matches(NodeInfo node) - Test whether this node test is satisfied by a given node.
|
boolean | matches(TinyTree tree, int nodeNr) - Test whether this node test is satisfied by a given node on a TinyTree.
|
void | setGlobalComponentTest(boolean global) - Indicate whether this CombinedNodeTest actually represents a SequenceType of the form
schema-element(X) or schema-attribute(X).
|
String | toString()
|
String | toString(NamePool pool) - Display the type descriptor for diagnostics
|
getAtomizedItemType , getContentType , getDefaultPriority , getFingerprint , getNodeKindMask , getPrimitiveItemType , getPrimitiveType , getRequiredNodeNames , getSuperType , isAtomicType , isNillable , matches , matches , matches , matchesItem , toString |
CombinedNodeTest
public CombinedNodeTest(NodeTest nt1,
int operator,
NodeTest nt2)
Create a NodeTest that combines two other node tests
nt1
- the first operandoperator
- one of Token.UNION, Token.INTERSECT, Token.EXCEPTnt2
- the second operand
equals
public boolean equals(Object other)
Indicates whether some other object is "equal to" this one.
getComponentNodeTests
public NodeTest[] getComponentNodeTests()
Get the two parts of the combined node test
getContentType
public SchemaType getContentType()
Get the content type allowed by this NodeTest (that is, the type annotation of the matched nodes).
Return AnyType if there are no restrictions. The default implementation returns AnyType.
- getContentType in interface NodeTest
getDefaultPriority
public double getDefaultPriority()
get the default priority of this nodeTest when used as a pattern
- getDefaultPriority in interface NodeTest
getFingerprint
public int getFingerprint()
Get the name of the nodes matched by this nodetest, if it matches a specific name.
Return -1 if the node test matches nodes of more than one name
- getFingerprint in interface NodeTest
getNodeKindMask
public int getNodeKindMask()
Get a mask indicating which kinds of nodes this NodeTest can match. This is a combination
of bits: 1<<Type.ELEMENT for element nodes, 1<<Type.TEXT for text nodes, and so on.
- getNodeKindMask in interface NodeTest
getOperator
public int getOperator()
getPrimitiveType
public int getPrimitiveType()
Get the basic kind of object that this ItemType matches: for a NodeTest, this is the kind of node,
or Type.Node if it matches different kinds of nodes.
- getPrimitiveType in interface ItemType
- getPrimitiveType in interface NodeTest
- the node kind matched by this node test
getRequiredNodeNames
public IntHashSet getRequiredNodeNames()
Get the set of node names allowed by this NodeTest. This is returned as a set of Integer fingerprints.
A null value indicates that all names are permitted (i.e. that there are no constraints on the node name.
The default implementation returns null.
- getRequiredNodeNames in interface NodeTest
hashCode
public int hashCode()
Returns a hash code value for the object.
isNillable
public boolean isNillable()
Determine whether the content type (if present) is nillable
- isNillable in interface NodeTest
- true if the content test (when present) can match nodes that are nilled
matches
public boolean matches(int nodeType,
int fingerprint,
int annotation)
Test whether this node test is satisfied by a given node.
- matches in interface NodeTest
nodeType
- The type of node to be matchedfingerprint
- identifies the expanded name of the node to be matched.
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.
- matches in interface NodeTest
node
- the node to be matched
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.
- matches in interface NodeTest
tree
- the TinyTree containing the nodenodeNr
- the number of the node within the TinyTree
- true if the node matches the NodeTest, otherwise false
setGlobalComponentTest
public void setGlobalComponentTest(boolean global)
Indicate whether this CombinedNodeTest actually represents a SequenceType of the form
schema-element(X) or schema-attribute(X). This information is used only when reconstructing a
string representation of the NodeTest for diagnostics.
global
- true if this test represents a schema-element or schema-attribute test
toString
public String toString()