net.sf.saxon.expr
Class CardinalityChecker

java.lang.Object
  net.sf.saxon.expr.ComputedExpression
      net.sf.saxon.expr.UnaryExpression
          net.sf.saxon.expr.CardinalityChecker

All Implemented Interfaces:

Container, Expression, InstructionInfoProvider, java.io.Serializable, javax.xml.transform.SourceLocator

public final class CardinalityChecker

extends UnaryExpression

A CardinalityChecker implements the cardinality checking of "treat as": that is, it returns the supplied sequence, checking that its cardinality is correct

See Also:

Serialized Form

Field Summary

Fields inherited from class net.sf.saxon.expr.UnaryExpression

operand

Fields inherited from class net.sf.saxon.expr.ComputedExpression

locationId, staticProperties

Fields inherited from interface net.sf.saxon.expr.Expression

EVALUATE_METHOD, ITERATE_METHOD, PROCESS_METHOD

Method Summary

int	computeCardinality() Determine the static cardinality of the expression
int	computeSpecialProperties() Get the static properties of this expression (other than its type).
java.lang.String	displayOperator(NamePool pool) Diagnostic print of expression structure
boolean	equals(java.lang.Object other) Is this expression the same as another expression?
Item	evaluateItem(XPathContext context) Evaluate as an Item.
int	getImplementationMethod() An implementation of Expression must provide at least one of the methods evaluateItem(), iterate(), or process().
ItemType	getItemType() Determine the data type of the items returned by the expression, if possible
int	getRequiredCardinality() Get the required cardinality
SequenceIterator	iterate(XPathContext context) Iterate over the sequence of values
static ComputedExpression	makeCardinalityChecker(Expression sequence, int cardinality, RoleLocator role) Factory method to construct a CardinalityChecker.
void	process(XPathContext context) Process the instruction, without returning any tail calls
void	setErrorCode(java.lang.String code) Set the error code to be returned (this is used when evaluating the functions such as exactly-one() which have their own error codes)
Expression	typeCheck(StaticContext env, ItemType contextItemType) Type-check the expression

Methods inherited from class net.sf.saxon.expr.UnaryExpression

display, getBaseExpression, hashCode, iterateSubExpressions, optimize, promote, simplify

Methods inherited from class net.sf.saxon.expr.ComputedExpression

adoptChildExpression, checkPermittedContents, computeDependencies, computeStaticProperties, doPromotion, dynamicError, dynamicError, effectiveBooleanValue, evaluateAsString, getCardinality, getColumnNumber, getConstructType, getDependencies, getExecutable, getInstructionInfo, getIntrinsicDependencies, getLineNumber, getLocationId, getLocationProvider, getParentExpression, getPublicId, getSlotsUsed, getSpecialProperties, getSystemId, hasBadParentPointer, markTailFunctionCalls, resetStaticProperties, setLocationId, setParentExpression, typeError, typeError

Methods inherited from class java.lang.Object

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

Method Detail

makeCardinalityChecker

public static ComputedExpression makeCardinalityChecker(Expression sequence,
                                                        int cardinality,
                                                        RoleLocator role)

Factory method to construct a CardinalityChecker. The method may create an expression that combines the cardinality checking with the functionality of the underlying expression class

Parameters:

sequence -

cardinality -

role -

Returns:

getRequiredCardinality

public int getRequiredCardinality()

Get the required cardinality

typeCheck

public Expression typeCheck(StaticContext env,
                            ItemType contextItemType)
                     throws XPathException

Type-check the expression

Specified by:

typeCheck in interface Expression

Overrides:

typeCheck in class UnaryExpression

Throws:

XPathException

setErrorCode

public void setErrorCode(java.lang.String code)

Set the error code to be returned (this is used when evaluating the functions such as exactly-one() which have their own error codes)

getImplementationMethod

public int getImplementationMethod()

An implementation of Expression must provide at least one of the methods evaluateItem(), iterate(), or process(). This method indicates which of these methods is provided. This implementation provides both iterate() and process() methods natively.

Specified by:

getImplementationMethod in interface Expression

Overrides:

getImplementationMethod in class ComputedExpression

iterate

public SequenceIterator iterate(XPathContext context)
                         throws XPathException

Iterate over the sequence of values

Specified by:

iterate in interface Expression

Overrides:

iterate in class ComputedExpression

Parameters:

context - supplies the context for evaluation

Returns:

a SequenceIterator that can be used to iterate over the result of the expression

Throws:

XPathException - if any dynamic error occurs evaluating the expression

evaluateItem

public Item evaluateItem(XPathContext context)
                  throws XPathException

Evaluate as an Item.

Specified by:

evaluateItem in interface Expression

Overrides:

evaluateItem in class ComputedExpression

Parameters:

context - The context in which the expression is to be evaluated

Returns:

the node or atomic value that results from evaluating the expression; or null to indicate that the result is an empty sequence

Throws:

XPathException - if any dynamic error occurs evaluating the expression

process

public void process(XPathContext context)
             throws XPathException

Process the instruction, without returning any tail calls

Specified by:

process in interface Expression

Overrides:

process in class ComputedExpression

Parameters:

context - The dynamic context, giving access to the current node, the current variables, etc.

Throws:

XPathException

getItemType

public ItemType getItemType()

Determine the data type of the items returned by the expression, if possible

Specified by:

getItemType in interface Expression

Overrides:

getItemType in class UnaryExpression

Returns:

a value such as Type.STRING, Type.BOOLEAN, Type.NUMBER, Type.NODE, or Type.ITEM (meaning not known in advance)

computeCardinality

public int computeCardinality()

Determine the static cardinality of the expression

Overrides:

computeCardinality in class UnaryExpression

computeSpecialProperties

public int computeSpecialProperties()

Get the static properties of this expression (other than its type). The result is bit-signficant. These properties are used for optimizations. In general, if property bit is set, it is true, but if it is unset, the value is unknown.

Overrides:

computeSpecialProperties in class UnaryExpression

equals

public boolean equals(java.lang.Object other)

Is this expression the same as another expression?

Overrides:

equals in class UnaryExpression

displayOperator

public java.lang.String displayOperator(NamePool pool)

Diagnostic print of expression structure

Specified by:

displayOperator in class UnaryExpression

Returns:

the operator, as a string