net.sf.saxon.pattern

Class ContentTypeTest

public class ContentTypeTest extends NodeTest

NodeTest is an interface that enables a test of whether a node matches particular conditions. ContentTypeTest tests for an element or attribute node with a particular type annotation.

Author: Michael H. Kay

Constructor Summary
ContentTypeTest(int nodeKind, SchemaType schemaType, Configuration config)
Create a ContentTypeTest
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)
SchemaTypegetContentType()
Get the content type allowed by this NodeTest (that is, the type annotation of the matched nodes).
doublegetDefaultPriority()
Determine the default priority of this node test when used on its own as a Pattern
intgetNodeKindMask()
Get a mask indicating which kinds of nodes this NodeTest can match.
intgetPrimitiveType()
Determine the types of nodes to which this pattern applies.
SchemaTypegetSchemaType()
ItemTypegetSuperType(TypeHierarchy th)
inthashCode()
Returns a hash code value for the object.
booleanisNillable()
The test is nillable if a question mark was specified as the occurrence indicator
booleanmatches(int nodeKind, 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.
booleanmatchesDTDTypes()
Test whether DTD-derived content types should be matched (the default is false)
voidsetMatchDTDTypes(boolean matched)
Indicate whether DTD-derived content types should be matched (the default is false)
voidsetNillable(boolean nillable)
Indicate whether nilled elements should be matched (the default is false)
StringtoString()

Constructor Detail

ContentTypeTest

public ContentTypeTest(int nodeKind, SchemaType schemaType, Configuration config)
Create a ContentTypeTest

Parameters: nodeKind the kind of nodes to be matched: always elements or attributes schemaType the required type annotation, as a simple or complex schema type config the Configuration, supplied because this KindTest needs access to schema information

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)

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 final double getDefaultPriority()
Determine the default priority of this node test when used on its own as a Pattern

getNodeKindMask

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

getPrimitiveType

public int getPrimitiveType()
Determine the types of nodes to which this pattern applies. Used for optimisation.

Returns: the type of node matched by this pattern. e.g. Type.ELEMENT or Type.TEXT

getSchemaType

public SchemaType getSchemaType()

getSuperType

public ItemType getSuperType(TypeHierarchy th)

hashCode

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

isNillable

public boolean isNillable()
The test is nillable if a question mark was specified as the occurrence indicator

Returns: true if the test is nillable

matches

public boolean matches(int nodeKind, int fingerprint, int annotation)
Test whether this node test is satisfied by a given node

Parameters: nodeKind The type of node to be matched fingerprint identifies the expanded name of the node to be matched annotation The actual content type of the node

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

matchesDTDTypes

public boolean matchesDTDTypes()
Test whether DTD-derived content types should be matched (the default is false)

Returns: true if DTD-derived types should be matched. If false, DTD-derived types are treated as untypedAtomic

setMatchDTDTypes

public void setMatchDTDTypes(boolean matched)
Indicate whether DTD-derived content types should be matched (the default is false)

Parameters: matched true if DTD-derived types should be matched. If false, DTD-derived types are treated as untypedAtomic

setNillable

public void setNillable(boolean nillable)
Indicate whether nilled elements should be matched (the default is false)

Parameters: nillable true if nilled elements should be matched

toString

public String toString()