net.sf.saxon.expr.instruct

Class Message

java.lang.Object

net.sf.saxon.expr.Expression

net.sf.saxon.expr.instruct.Instruction

net.sf.saxon.expr.instruct.Message

All Implemented Interfaces:

ExportAgent, TailCallReturner, IdentityComparable

public class Message
extends Instruction

An xsl:message element in the stylesheet.

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
Message(Expression select, Expression terminate, Expression errorCode) Create an xsl:message instruction

Method Summary

Modifier and Type	Method and Description
Expression	copy(RebindingMap rebindings) Copy an expression.
void	export(ExpressionPresenter out) Diagnostic print of expression structure.
int	getCardinality() Get the static cardinality.
Expression	getErrorCode()
int	getInstructionNameCode() Get the name of this instruction for diagnostic and tracing purposes
ItemType	getItemType() Get the item type.
Expression	getSelect()
Expression	getTerminate()
boolean	mayCreateNewNodes() Determine whether this instruction creates new nodes.
java.lang.Iterable<Operand>	operands() Get the immediate sub-expressions of this expression, with information about the relationship of each expression to its parent expression.
TailCall	processLeavingTail(XPathContext context) ProcessLeavingTail: called to do the real work of this instruction.
void	setErrorCode(Expression errorCode)
void	setIsAssert(boolean isAssert) Say whether this instruction is implementing xsl:message or xsl:assert
void	setSelect(Expression select)
void	setTerminate(Expression terminate)

Methods inherited from class net.sf.saxon.expr.instruct.Instruction

alwaysCreatesNewNodes, assembleParams, assembleTunnelParams, computeCardinality, computeSpecialProperties, dynamicError, evaluateAsString, evaluateItem, getConstructType, getExpressionName, getImplementationMethod, getInstructionName, getNetCost, getSourceLocator, isInstruction, isXSLT, iterate, process, someOperandCreatesNewNodes

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

addToPathMap, adoptChildExpression, allowExtractingCommonSubexpressions, checkedOperands, checkForUpdatingSubexpressions, checkPermittedContents, computeDependencies, computeHashCode, computeStaticProperties, dynamicError, effectiveBooleanValue, evaluatePendingUpdates, explain, getConfiguration, getCost, getDependencies, getEvaluationMethod, getExtraProperty, getIntegerBounds, getInterpretedExpression, getIntrinsicDependencies, getLocalRetainedStaticContext, getLocation, getObjectName, getPackageData, getParentExpression, getProperties, getProperty, getRetainedStaticContext, getScopingExpression, getSlotsUsed, getSpecialProperties, getStaticBaseURI, getStaticBaseURIString, getStaticType, getStaticUType, getStreamerName, hasCompatibleStaticContext, hashCode, hasVariableBinding, identityHashCode, implementsStaticTypeCheck, isCallOn, isCallOnSystemFunction, isIdentical, isLiftable, isMultiThreaded, isSameExpression, isStaticPropertiesKnown, isSubtreeExpression, isUpdatingExpression, isVacuousExpression, markTailFunctionCalls, operandList, operandSparseList, optimize, optimizeChildren, resetLocalStaticProperties, restoreParentPointers, setEvaluationMethod, setExtraProperty, setFiltered, setFlattened, setLocation, setParentExpression, setRetainedStaticContext, setRetainedStaticContextLocally, setRetainedStaticContextThoroughly, setStaticProperty, simplify, simplifyChildren, staticTypeCheck, suppressValidation, toPattern, toShortString, toString, typeCheck, typeCheckChildren, typeError, unordered, verifyParentPointers, verifyParentPointers

Methods inherited from class java.lang.Object

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

Constructor Detail

Message

public Message(Expression select,
               Expression terminate,
               Expression errorCode)

Create an xsl:message instruction

Parameters:

select - the expression that constructs the message (composite of the select attribute and the contained sequence constructor)

terminate - expression that calculates terminate = yes or no.

errorCode - expression used to compute the error code

Method Detail

getSelect

public Expression getSelect()

setSelect

public void setSelect(Expression select)

getTerminate

public Expression getTerminate()

setTerminate

public void setTerminate(Expression terminate)

getErrorCode

public Expression getErrorCode()

setErrorCode

public void setErrorCode(Expression errorCode)

operands

public java.lang.Iterable<Operand> operands()

Description copied from class: Expression

Get the immediate sub-expressions of this expression, with information about the relationship of each expression to its parent expression. Default implementation works off the results of iterateSubExpressions()

If the expression is a Callable, then it is required that the order of the operands returned by this function is the same as the order of arguments supplied to the corresponding call() method.

Specified by:

operands in class Instruction

Returns:

an iterator containing the sub-expressions of this expression

setIsAssert

public void setIsAssert(boolean isAssert)

Say whether this instruction is implementing xsl:message or xsl:assert

Parameters:

isAssert - true if this is xsl:assert; false if it is xsl:message

copy

public Expression copy(RebindingMap rebindings)

Copy an expression. This makes a deep copy.

Specified by:

copy in class Expression

Parameters:

rebindings -

Returns:

the copy of the original expression

getInstructionNameCode

public int getInstructionNameCode()

Get the name of this instruction for diagnostic and tracing purposes

Overrides:

getInstructionNameCode in class Instruction

Returns:

a code identifying the instruction: typically but not always the fingerprint of a name in the XSLT namespace

getItemType

public ItemType getItemType()

Get the item type. To avoid spurious compile-time type errors, we falsely declare that the instruction can return anything

Overrides:

getItemType in class Instruction

Returns:

AnyItemType

getCardinality

public int getCardinality()

Get the static cardinality. To avoid spurious compile-time type errors, we falsely declare that the instruction returns zero or one items - this is always acceptable

Overrides:

getCardinality in class Expression

Returns:

zero or one

mayCreateNewNodes

public final boolean mayCreateNewNodes()

Determine whether this instruction creates new nodes. This implementation returns true.

Overrides:

mayCreateNewNodes in class Instruction

Returns:

true if the instruction creates new nodes under some input conditions (or if it can't be proved that it doesn't)

processLeavingTail

public TailCall processLeavingTail(XPathContext context)
                            throws XPathException

Description copied from class: Instruction

ProcessLeavingTail: called to do the real work of this instruction. This method must be implemented in each subclass. The results of the instruction are written to the current Receiver, which can be obtained via the Controller.

Specified by:

processLeavingTail in interface TailCallReturner

Specified by:

processLeavingTail in class Instruction

Parameters:

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

Returns:

null if the instruction has completed execution; or a TailCall indicating a function call or template call that is delegated to the caller, to be made after the stack has been unwound so as to save stack space.

Throws:

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

export

public void export(ExpressionPresenter out)
            throws XPathException

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

Specified by:

export in interface ExportAgent

Specified by:

export in class Expression

Parameters:

out - the expression presenter used to display the structure

Throws:

XPathException - if the export fails, for example if an expression is found that won't work in the target environment.