com.saxonica.xslt3.instruct

Class WherePopulated

java.lang.Object

net.sf.saxon.expr.Expression

net.sf.saxon.expr.UnaryExpression

com.saxonica.xslt3.instruct.WherePopulated

All Implemented Interfaces:

ItemMappingFunction<Item,Item>, IdentityComparable

public class WherePopulated
extends UnaryExpression
implements ItemMappingFunction<Item,Item>

A compiled xsl:where-populated instruction (formerly xsl:conditional-content).

Field Summary

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

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

Constructor Summary

Constructors

Constructor and Description
WherePopulated(Expression base) Create the instruction

Method Summary

Methods

Modifier and Type	Method and Description
int	computeCardinality() Determine the static cardinality.
Expression	copy() Copy an expression.
void	export(ExpressionPresenter out) Diagnostic print of expression structure.
ExpressionCompiler	getExpressionCompiler() Return the compiler of the ConditionalContent expression
int	getImplementationMethod() An implementation of Expression must provide at least one of the methods evaluateItem(), iterate(), or process().
protected OperandRole	getOperandRole() Get the usage (in terms of streamability analysis) of the single operand
WherePopulatedAdjunct	getStreamingAdjunct() Get a class that supports streamed evaluation of this expression
static boolean	isDeemedEmpty(Item item) Test whether an item is empty according to the definition in the spec for xsl:conditional-content
SequenceIterator	iterate(XPathContext context) Return an Iterator to iterate over the values of a sequence.
Item	mapItem(Item item) Map one item to another item.

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

computeSpecialProperties, displayOperator, equals, getBaseExpression, getItemType, getOperand, hashCode, operands, optimize, setBaseExpression, toShortString, toString, typeCheck

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

addToPathMap, adoptChildExpression, checkedOperands, checkForUpdatingSubexpressions, checkPermittedContents, clearStreamabilityData, computeDependencies, computeStaticProperties, doPromotion, dynamicError, effectiveBooleanValue, evaluateAsString, evaluateItem, evaluatePendingUpdates, explain, getCardinality, getConfiguration, getConstructType, getCost, getDependencies, getEvaluationMethod, getExpressionName, getHostLanguage, getIntegerBounds, getIntrinsicDependencies, getLocation, getNetCost, getObjectName, getPackageData, getParentExpression, getPosture, getPostureAndSweepIfKnown, getProperties, getProperty, getRetainedStaticContext, getSlotsUsed, getSpecialProperties, getStaticBaseURI, getStaticBaseURIString, getStreamability, getSweep, getSystemId, hasVariableBinding, identityHashCode, implementsStaticTypeCheck, isCallOn, isCallOnSystemFunction, isIdentical, isSubtreeExpression, isUpdatingExpression, isVacuousExpression, iterateEvents, makeStreamingAdjunct, markTailFunctionCalls, operandList, operandSparseList, optimizeChildren, optimizeForType, process, promote, promoteChildren, resetLocalStaticProperties, restoreParentPointers, setEvaluationMethod, setFiltered, setFlattened, setLocation, setParentExpression, setPostureAndSweep, setRetainedStaticContext, setRetainedStaticContextLocally, setStaticProperty, simplify, simplifyChildren, staticTypeCheck, suppressValidation, toPattern, toStreamingPattern, typeCheckChildren, typeError, unordered

Methods inherited from class java.lang.Object

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

Constructor Detail

WherePopulated

public WherePopulated(Expression base)

Create the instruction

Method Detail

getOperandRole

protected OperandRole getOperandRole()

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

Specified by:

getOperandRole in class UnaryExpression

Returns:

the operand usage

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

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 directly. The other methods will always be available indirectly, using an implementation that relies on one of the other methods.

Specified by:

getImplementationMethod in class Expression

Returns:

the implementation method, for example Expression.ITERATE_METHOD or Expression.EVALUATE_METHOD or Expression.PROCESS_METHOD

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

iterate

public SequenceIterator iterate(XPathContext context)
                         throws XPathException

Return an Iterator to iterate over the values of a sequence. The value of every expression can be regarded as a sequence, so this method is supported for all expressions.

Overrides:

iterate in class Expression

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

mapItem

public Item mapItem(Item item)
             throws XPathException

Map one item to another item.

Specified by:

mapItem in interface ItemMappingFunction<Item,Item>

Parameters:

item - The input item to be mapped.

Returns:

either the output item, or null.

Throws:

XPathException - if a dynamic error occurs

isDeemedEmpty

public static boolean isDeemedEmpty(Item item)

Test whether an item is empty according to the definition in the spec for xsl:conditional-content

Parameters:

item - the item to be tested

Returns:

true if it is "empty", for example, an element without children

getExpressionCompiler

public ExpressionCompiler getExpressionCompiler()

Return the compiler of the ConditionalContent expression

Overrides:

getExpressionCompiler in class Expression

Returns:

the relevant ExpressionCompiler

export

public void export(ExpressionPresenter out)

Description copied from class: UnaryExpression

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

Overrides:

export in class UnaryExpression

Parameters:

out - the expression presenter used to display the structure

getStreamingAdjunct

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