net.sf.saxon.pattern
Class CombinedNodeTest
public
class
CombinedNodeTest
extends NodeTest
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))
Author: Michael H. Kay
Method Summary |
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() |
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 | isAtomizable()
Ask whether values of this type are atomizable |
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(TinyTree tree, int nodeNr)
Test whether this node test is satisfied by a given node on a TinyTree. |
boolean | matches(NodeInfo node)
Test whether this node test is satisfied by a given node. |
void | setGlobalComponentTest(boolean global)
Indicate whether this CombinedNodeTest actually represents a SequenceType of the form
schema-element(X) or schema-attribute(X). |
String | toString(NamePool pool) |
String | toString() |
Create a NodeTest that combines two other node tests
Parameters: nt1 the first operand operator one of Token.UNION, Token.INTERSECT, Token.EXCEPT nt2 the second operand
public boolean equals(Object other)
Indicates whether some other object is "equal to" this one.
Get the item type of the atomic values that will be produced when an item
of this type is atomized (assuming that atomization succeeds)
public
NodeTest[] getComponentNodeTests()
Get the two parts of the combined node test
Returns: the two operands
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.
public double getDefaultPriority()
get the default priority of this nodeTest when used as a pattern
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
public int getNodeKindMask()
Get a mask indicating which kinds of nodes this NodeTest can match. This is a combination
of bits: 1<
public int getOperator()
Get the operator used to combine the two node tests: one of
UNION,
INTERSECT,
EXCEPT,
Returns: the operator
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.
Returns: the node kind matched by this node test
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.
Get the supertype of this type. This isn't actually a well-defined concept: the types
form a lattice rather than a strict hierarchy.
Parameters: th the type hierarchy cache
public int hashCode()
Returns a hash code value for the object.
public boolean isAtomizable()
Ask whether values of this type are atomizable
Returns: true unless it is known that these items will be elements with element-only
content, in which case return false
public boolean isNillable()
Determine whether the content type (if present) is nillable
Returns: true if the content test (when present) can match nodes that are nilled
public boolean matches(int nodeType, int fingerprint, int annotation)
Test whether this node test is satisfied by a given node.
Parameters: nodeType The type of node to be matched fingerprint identifies the expanded name of the node to be matched.
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.
Parameters: tree the TinyTree containing the node nodeNr the number of the node within the TinyTree
Returns: true if the node matches the NodeTest, otherwise false
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.
Parameters: node the node to be matched
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.
Parameters: global true if this test represents a schema-element or schema-attribute test
public String toString()