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

Constructor Summary
CombinedNodeTest(NodeTest nt1, int operator, NodeTest nt2)
Create a NodeTest that combines two other node tests
Method Summary
booleanequals(Object other)
Indicates whether some other object is "equal to" this one.
AtomicTypegetAtomizedItemType()
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
SchemaTypegetContentType()
Get the content type allowed by this NodeTest (that is, the type annotation of the matched nodes).
doublegetDefaultPriority()
get the default priority of this nodeTest when used as a pattern
intgetFingerprint()
Get the name of the nodes matched by this nodetest, if it matches a specific name.
intgetNodeKindMask()
Get a mask indicating which kinds of nodes this NodeTest can match.
intgetOperator()
Get the operator used to combine the two node tests: one of UNION, INTERSECT, EXCEPT,
intgetPrimitiveType()
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.
IntHashSetgetRequiredNodeNames()
Get the set of node names allowed by this NodeTest.
ItemTypegetSuperType(TypeHierarchy th)
Get the supertype of this type.
inthashCode()
Returns a hash code value for the object.
booleanisAtomizable()
Ask whether values of this type are atomizable
booleanisNillable()
Determine whether the content type (if present) is nillable
booleanmatches(int nodeType, int fingerprint, int annotation)
Test whether this node test is satisfied by a given node.
booleanmatches(TinyTree tree, int nodeNr)
Test whether this node test is satisfied by a given node on a TinyTree.
booleanmatches(NodeInfo node)
Test whether this node test is satisfied by a given node.
voidsetGlobalComponentTest(boolean global)
Indicate whether this CombinedNodeTest actually represents a SequenceType of the form schema-element(X) or schema-attribute(X).
StringtoString(NamePool pool)
StringtoString()

Constructor Detail

CombinedNodeTest

public CombinedNodeTest(NodeTest nt1, int operator, NodeTest nt2)
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

Method Detail

equals

public boolean equals(Object other)
Indicates whether some other object is "equal to" this one.

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)

getComponentNodeTests

public NodeTest[] getComponentNodeTests()
Get the two parts of the combined node test

Returns: the two operands

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.

getDefaultPriority

public double getDefaultPriority()
get the default priority of this nodeTest when used as a pattern

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

getNodeKindMask

public int getNodeKindMask()
Get a mask indicating which kinds of nodes this NodeTest can match. This is a combination of bits: 1<

getOperator

public int getOperator()
Get the operator used to combine the two node tests: one of UNION, INTERSECT, EXCEPT,

Returns: the operator

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.

Returns: 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.

getSuperType

public ItemType getSuperType(TypeHierarchy th)
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

hashCode

public int hashCode()
Returns a hash code value for the object.

isAtomizable

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

isNillable

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

matches

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.

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.

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

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.

Parameters: node the node to be matched

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.

Parameters: global true if this test represents a schema-element or schema-attribute test

toString

public String toString(NamePool pool)

toString

public String toString()