net.sf.saxon.functions

Class BooleanFn

java.lang.Object

net.sf.saxon.expr.Expression

net.sf.saxon.expr.FunctionCall

net.sf.saxon.functions.SystemFunctionCall

net.sf.saxon.functions.BooleanFn

All Implemented Interfaces:

SourceLocator, Callable, Negatable, IdentityComparable, InstructionInfo

public class BooleanFn
extends SystemFunctionCall
implements Negatable, Callable

This class supports the XPath function boolean()

Field Summary

Fields inherited from class net.sf.saxon.functions.SystemFunctionCall

operation

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

argument

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

Method Summary

Methods

Modifier and Type	Method and Description
BooleanValue	call(XPathContext c, Sequence[] arguments) Call the Callable.
void	checkArguments(ExpressionVisitor visitor) Static analysis: prevent sorting of the argument
boolean	effectiveBooleanValue(XPathContext c) Evaluate the effective boolean value
BooleanValue	evaluateItem(XPathContext context) Evaluate the function
ExpressionCompiler	getExpressionCompiler() Return the compiler of the BooleanFn expression
BooleanFnAdjunct	getStreamingAdjunct() Get a class that supports streamed evaluation of this expression
boolean	isNegatable(ExpressionVisitor visitor) Check whether this specific instance of the expression is negatable
Expression	negate() Create an expression that returns the negation of this expression
Expression	optimize(ExpressionVisitor visitor, ContextItemStaticInfo contextItemType) Perform optimisation of an expression and its subexpressions.
static Expression	rewriteEffectiveBooleanValue(Expression exp, ExpressionVisitor visitor, ContextItemStaticInfo contextItemType) Optimize an expression whose effective boolean value is required.

Methods inherited from class net.sf.saxon.functions.SystemFunctionCall

addContextDocumentArgument, addDocToPathMap, bindStaticContext, computeCardinality, computeSpecialProperties, copy, equalOrNull, equals, getContextNode, getConvertingCallable, getDefaultArgumentNode, getDetails, getErrorCodeForTypeErrors, getFunctionItemType, getImplementationMethod, getItemType, getOperation, getRequiredType, makeSystemFunction, operands, setDetails, toShortString, useContextItemAsDefault

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

addExternalFunctionCallToPathMap, checkArgumentCount, explain, getArguments, getDisplayName, getExpressionName, getFunctionName, getNumberOfArguments, hashCode, preEvaluate, promote, replaceOperand, setArguments, setFunctionName, simplifyArguments, toString, typeCheck

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, getHostLanguage, 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

BooleanFn

public BooleanFn()

Method Detail

checkArguments

public void checkArguments(ExpressionVisitor visitor)
                    throws XPathException

Static analysis: prevent sorting of the argument

Overrides:

checkArguments in class SystemFunctionCall

Parameters:

visitor - the expression visitor

Throws:

XPathException - if the arguments are incorrect

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 SystemFunctionCall

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)

isNegatable

public boolean isNegatable(ExpressionVisitor visitor)

Check whether this specific instance of the expression is negatable

Specified by:

isNegatable in interface Negatable

Returns:

true if it is

negate

public Expression negate()

Create an expression that returns the negation of this expression

Specified by:

negate in interface Negatable

Returns:

the negated expression

rewriteEffectiveBooleanValue

public static Expression rewriteEffectiveBooleanValue(Expression exp,
                                      ExpressionVisitor visitor,
                                      ContextItemStaticInfo contextItemType)
                                               throws XPathException

Optimize an expression whose effective boolean value is required. It is appropriate to apply this rewrite to any expression whose value will be obtained by calling the Expression.effectiveBooleanValue() method (and not otherwise)

Parameters:

exp - the expression whose EBV is to be evaluated

visitor - an expression visitor

contextItemType - the type of the context item for this expression

Returns:

an expression that returns the EBV of exp, or null if no optimization was possible

Throws:

XPathException - if static errors are found

evaluateItem

public BooleanValue evaluateItem(XPathContext context)
                          throws XPathException

Evaluate the function

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 c)
                              throws XPathException

Evaluate the effective boolean value

Overrides:

effectiveBooleanValue in class Expression

Parameters:

c - 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

call

public BooleanValue call(XPathContext c,
                Sequence[] arguments)
                  throws XPathException

Description copied from interface: Callable

Call the Callable.

Specified by:

call in interface Callable

Parameters:

c - the dynamic evaluation context

arguments - the values of the arguments, supplied as Sequences.

Generally it is advisable, if calling iterate() to process a supplied sequence, to call it only once; if the value is required more than once, it should first be converted to a GroundedValue by calling the utility methd SequenceTool.toGroundedValue().

If the expected value is a single item, the item should be obtained by calling Sequence.head(): it cannot be assumed that the item will be passed as an instance of Item or AtomicValue.

It is the caller's responsibility to perform any type conversions required to convert arguments to the type expected by the callee. An exception is where this Callable is explicitly an argument-converting wrapper around the original Callable.

Returns:

the result of the evaluation, in the form of a Sequence. It is the responsibility of the callee to ensure that the type of result conforms to the expected result type.

Throws:

XPathException - if a dynamic error occurs during the evaluation of the expression

getExpressionCompiler

public ExpressionCompiler getExpressionCompiler()

Return the compiler of the BooleanFn expression

Overrides:

getExpressionCompiler in class Expression

Returns:

the relevant ExpressionCompiler

getStreamingAdjunct

public BooleanFnAdjunct 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