net.sf.saxon.expr

Class CastableExpression

java.lang.Object

net.sf.saxon.expr.Expression

net.sf.saxon.expr.UnaryExpression

net.sf.saxon.expr.CastingExpression

net.sf.saxon.expr.CastableExpression

All Implemented Interfaces:

SourceLocator, IdentityComparable, InstructionInfo

public final class CastableExpression
extends CastingExpression

Castable Expression: implements "Expr castable as atomic-type?". The implementation simply wraps a cast expression with a try/catch.

Field Summary

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

converter, nsResolver

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

operand

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

EFFECTIVE_BOOLEAN_VALUE, EVALUATE_METHOD, ITEM_FEED_METHOD, ITERATE_METHOD, locationId, MAX_SEQUENCE_LENGTH, MAX_STRING_LENGTH, PROCESS_METHOD, staticProperties, UNBOUNDED_LOWER, UNBOUNDED_UPPER, WATCH_METHOD

Constructor Summary

Constructors

Constructor and Description
CastableExpression(Expression source, AtomicType target, boolean allowEmpty) Create a "castable" expression of the form "source castable as target"

Method Summary

Methods

Modifier and Type	Method and Description
int	computeCardinality() Determine the static cardinality.
Expression	copy() Copy an expression.
boolean	effectiveBooleanValue(XPathContext context) Get the effective boolean value of the expression.
boolean	equals(Object other) Is this expression the same as another expression?
BooleanValue	evaluateItem(XPathContext context) Evaluate the expression
void	explain(ExpressionPresenter out) Diagnostic print of expression structure.
ExpressionCompiler	getExpressionCompiler() Return the compiler of the Castable expression
ItemType	getItemType() Determine the data type of the result of the Castable expression /*@NotNull
int	hashCode() get HashCode for comparing two expressions.
Expression	optimize(ExpressionVisitor visitor, ContextItemStaticInfo contextItemType) Optimize the expression
protected Expression	preEvaluate()
String	toString() The toString() method for an expression attempts to give a representation of the expression in an XPath-like form, but there is no guarantee that the syntax will actually be true XPath.
Expression	typeCheck(ExpressionVisitor visitor, ContextItemStaticInfo contextInfo) Type-check the expression

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

allowsEmpty, computeSpecialProperties, getConverter, getNamespaceResolver, getOperandRole, getTargetPrimitiveType, getTargetType, isOperandIsStringLiteral, setAllowEmpty, setNamespaceResolver, setOperandIsStringLiteral, setTargetType, simplify

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

displayOperator, getBaseExpression, operands, promote, replaceOperand, toShortString

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

addToPathMap, adoptChildExpression, checkForUpdatingSubexpressions, checkPermittedContents, clearStreamabilityData, computeDependencies, computeStaticProperties, doPromotion, dynamicError, evaluateAsString, evaluatePendingUpdates, explain, getCardinality, getColumnNumber, getConfiguration, getConstructType, getContainer, getDependencies, getEvaluationMethod, getExpressionName, getHostLanguage, getImplementationMethod, getIntegerBounds, getIntrinsicDependencies, getLineNumber, getLocationId, getObjectName, getPosture, getProperties, getProperty, getPublicId, getSlotsUsed, getSpecialProperties, getStreamability, getStreamingAdjunct, getSweep, getSystemId, hasVariableBinding, identityHashCode, implementsStaticTypeCheck, isIdentical, isSubtreeExpression, isUpdatingExpression, isVacuousExpression, iterate, iterateEvents, makeStreamingAdjunct, markTailFunctionCalls, operandList, process, resetLocalStaticProperties, setContainer, setEvaluationMethod, setFiltered, setFlattened, setLocationId, setPostureAndSweep, staticTypeCheck, suppressValidation, toPattern, toStreamingPattern, typeError, unordered

Methods inherited from class java.lang.Object

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

Constructor Detail

CastableExpression

public CastableExpression(Expression source,
                  AtomicType target,
                  boolean allowEmpty)

Create a "castable" expression of the form "source castable as target"

Parameters:

source - The source expression

target - The type being tested against

allowEmpty - true if an empty sequence is acceptable, that is if the expression was written as "source castable as target?"

Method Detail

typeCheck

public Expression typeCheck(ExpressionVisitor visitor,
                   ContextItemStaticInfo contextInfo)
                     throws XPathException

Type-check the expression

Overrides:

typeCheck in class UnaryExpression

Parameters:

visitor - an expression visitor

contextInfo - Information available statically about the context item: whether it is (possibly) absent; its static type; its streaming posture.

Returns:

the original expression, rewritten to perform necessary run-time type checks, and to perform other type-related optimizations

Throws:

XPathException - if an error is discovered during this phase (typically a type error)

preEvaluate

protected Expression preEvaluate()
                          throws XPathException

Throws:

XPathException

optimize

public Expression optimize(ExpressionVisitor visitor,
                  ContextItemStaticInfo contextItemType)
                    throws XPathException

Optimize the expression

Overrides:

optimize in class UnaryExpression

Parameters:

visitor - an expression visitor

contextItemType - the static type of "." at the point where this expression is invoked. The parameter is set to null if it is known statically that the context item will be undefined. If the type of the context item is not known statically, the argument is set to Type.ITEM_TYPE

Returns:

the original expression, rewritten if appropriate to optimize execution

Throws:

XPathException - if an error is discovered during this phase (typically a type error)

equals

public boolean equals(Object other)

Is this expression the same as another expression?

Overrides:

equals in class UnaryExpression

hashCode

public int hashCode()

get HashCode for comparing two expressions. Note that this hashcode gives the same result for (A op B) and for (B op A), whether or not the operator is commutative.

Overrides:

hashCode in class UnaryExpression

getItemType

public ItemType getItemType()

Determine the data type of the result of the Castable expression

/*@NotNull

Overrides:

getItemType in class UnaryExpression

Returns:

the item type of the items in the result sequence, insofar as this is known statically.

computeCardinality

public int computeCardinality()

Description copied from class: UnaryExpression

Determine the static cardinality. Default implementation returns the cardinality of the operand

Overrides:

computeCardinality in class UnaryExpression

Returns:

the computed cardinality, as one of the values StaticProperty.ALLOWS_ZERO_OR_ONE, StaticProperty.EXACTLY_ONE, StaticProperty.ALLOWS_ONE_OR_MORE, StaticProperty.ALLOWS_ZERO_OR_MORE

copy

public Expression copy()

Description copied from class: Expression

Copy an expression. This makes a deep copy.

Specified by:

copy in class Expression

Returns:

the copy of the original expression

evaluateItem

public BooleanValue evaluateItem(XPathContext context)
                          throws XPathException

Evaluate the expression

Overrides:

evaluateItem in class Expression

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

effectiveBooleanValue

public boolean effectiveBooleanValue(XPathContext context)
                              throws XPathException

Description copied from class: Expression

Get the effective boolean value of the expression. This returns false if the value is the empty sequence, a zero-length string, a number equal to zero, or the boolean false. Otherwise it returns true.

Overrides:

effectiveBooleanValue in class Expression

Parameters:

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

Returns:

the effective boolean value

Throws:

XPathException - if any dynamic error occurs evaluating the expression

getExpressionCompiler

public ExpressionCompiler getExpressionCompiler()

Return the compiler of the Castable expression

Overrides:

getExpressionCompiler in class Expression

Returns:

the relevant ExpressionCompiler

toString

public String toString()

The toString() method for an expression attempts to give a representation of the expression in an XPath-like form, but there is no guarantee that the syntax will actually be true XPath. In the case of XSLT instructions, the toString() method gives an abstracted view of the syntax

Overrides:

toString in class UnaryExpression

Returns:

a representation of the expression as a string

explain

public void explain(ExpressionPresenter out)

Diagnostic print of expression structure. The abstract expression tree is written to the supplied output destination.

Overrides:

explain in class UnaryExpression

Parameters:

out - the expression presenter used to display the structure