net.sf.saxon.expr

Class InstanceOfExpression

java.lang.Object

net.sf.saxon.expr.Expression

net.sf.saxon.expr.UnaryExpression

net.sf.saxon.expr.InstanceOfExpression

All Implemented Interfaces:

SourceLocator, IdentityComparable, InstructionInfo

public final class InstanceOfExpression
extends UnaryExpression

InstanceOf Expression: implements "Expr instance of data-type"

Field Summary

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
InstanceOfExpression(Expression source, SequenceType target) Construct an "instance of" expression in the form "source instance of target"

Method Summary

Methods

Modifier and Type	Method and Description
int	computeCardinality() Determine the cardinality
Expression	copy() Copy an expression.
boolean	effectiveBooleanValue(XPathContext context) Evaluate the expression as a boolean
boolean	equals(Object other) Is this expression the same as another expression?
BooleanValue	evaluateItem(XPathContext context) Evaluate the expression
void	explain(ExpressionPresenter destination) Diagnostic print of expression structure.
ExpressionCompiler	getExpressionCompiler() Return the compiler of the InstanceOf expression
ItemType	getItemType() Determine the data type of the result of the InstanceOf expression /*@NotNull
protected OperandRole	getOperandRole() Get the usage (in terms of streamability analysis) of the single operand
int	getRequiredCardinality() Get the cardinality that we are testing for membership of
ItemType	getRequiredItemType() Get the item type that we are testing for membership of
InstanceOfAdjunct	getStreamingAdjunct() Get a class that supports streamed evaluation of this expression
int	hashCode() get HashCode for comparing two expressions.
Expression	optimize(ExpressionVisitor visitor, ContextItemStaticInfo contextItemType) Perform optimisation of an expression and its subexpressions.
String	toShortString() Produce a short string identifying the expression for use in error messages
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.UnaryExpression

computeSpecialProperties, displayOperator, getBaseExpression, operands, promote, replaceOperand

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, getSweep, getSystemId, hasVariableBinding, identityHashCode, implementsStaticTypeCheck, isIdentical, isSubtreeExpression, isUpdatingExpression, isVacuousExpression, iterate, iterateEvents, makeStreamingAdjunct, markTailFunctionCalls, operandList, process, resetLocalStaticProperties, setContainer, setEvaluationMethod, setFiltered, setFlattened, setLocationId, setPostureAndSweep, simplify, staticTypeCheck, suppressValidation, toPattern, toStreamingPattern, typeError, unordered

Methods inherited from class java.lang.Object

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

Constructor Detail

InstanceOfExpression

public InstanceOfExpression(Expression source,
                    SequenceType target)

Construct an "instance of" expression in the form "source instance of target"

Parameters:

source - the expression whose type is to be tested

target - the type against which it is tested

Method Detail

getOperandRole

protected OperandRole getOperandRole()

Description copied from class: UnaryExpression

Get the usage (in terms of streamability analysis) of the single operand

Specified by:

getOperandRole in class UnaryExpression

Returns:

the operand usage

getRequiredItemType

public ItemType getRequiredItemType()

Get the item type that we are testing for membership of

Returns:

the item type

getRequiredCardinality

public int getRequiredCardinality()

Get the cardinality that we are testing for membership of

Returns:

the required cardinality

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 checked expression

Throws:

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

optimize

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

Perform optimisation of an expression and its subexpressions.

This method is called after all references to functions and variables have been resolved to the declaration of the function or variable, and after all type checking has been done.

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

computeCardinality

public int computeCardinality()

Determine the cardinality

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()

Copy an expression. This makes a deep copy.

Specified by:

copy in class Expression

Returns:

the copy of the original expression

getItemType

public ItemType getItemType()

Determine the data type of the result of the InstanceOf expression

/*@NotNull

Overrides:

getItemType in class UnaryExpression

Returns:

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

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

Evaluate the expression as a boolean

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 InstanceOf expression

Overrides:

getExpressionCompiler in class Expression

Returns:

the relevant ExpressionCompiler

explain

public void explain(ExpressionPresenter destination)

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

Overrides:

explain in class UnaryExpression

Parameters:

destination - the expression presenter used to display the structure

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

toShortString

public String toShortString()

Produce a short string identifying the expression for use in error messages

Overrides:

toShortString in class UnaryExpression

Returns:

a short string, sufficient to identify the expression

getStreamingAdjunct

public InstanceOfAdjunct getStreamingAdjunct()

Get a class that supports streamed evaluation of this expression

Overrides:

getStreamingAdjunct in class Expression

Returns:

the relevant StreamingAdjunct, or null if none is available