net.sf.saxon.expr.instruct

Class Comment

java.lang.Object

net.sf.saxon.expr.Expression

net.sf.saxon.expr.instruct.Instruction

net.sf.saxon.expr.instruct.SimpleNodeConstructor

net.sf.saxon.expr.instruct.Comment

All Implemented Interfaces:

SourceLocator, TailCallReturner, IdentityComparable, InstructionInfo

public final class Comment
extends SimpleNodeConstructor

An instruction representing an xsl:comment element in the stylesheet.

Field Summary

Fields inherited from class net.sf.saxon.expr.instruct.SimpleNodeConstructor

select

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
Comment() Construct the instruction

Method Summary

Methods

Modifier and Type	Method and Description
protected String	checkContent(String comment, XPathContext context) Check the content of the node, and adjust it if necessary
static String	checkContentXQuery(String comment) Check the content of the comment according to the XQuery rules (which throw an error if it is wrong)
static String	checkContentXSLT(String comment) Check the content of the comment according to the XSLT rules (which fix it if it is wrong)
Expression	copy() Copy an expression.
void	explain(ExpressionPresenter out) Diagnostic print of expression structure.
int	getCardinality() Determine the static cardinality of the expression.
ExpressionCompiler	getExpressionCompiler() Return the compiler of the Comment expression
int	getInstructionNameCode() Get the instruction name, for diagnostics and tracing return the string "xsl:comment"
ItemType	getItemType() Get the item type of the items returned by evaluating this instruction
void	localTypeCheck(ExpressionVisitor visitor, ContextItemStaticInfo contextItemType) Method to perform type-checking specific to the kind of instruction
void	processValue(CharSequence value, XPathContext context) Process the value of the node, to create the new node.

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

computeCardinality, computeSpecialProperties, createsNewNodes, evaluateItem, evaluateNodeName, getContentExpression, getStreamingAdjunct, iterate, operands, optimize, processLeavingTail, promoteInst, replaceOperand, setSelect, typeCheck

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

assembleParams, assembleTunnelParams, dynamicError, evaluateAsString, getConstructType, getExpressionName, getImplementationMethod, getInstructionName, getIteratorFromProcessMethod, getSourceLocator, isXSLT, process, promote, toStreamingPattern

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

addToPathMap, adoptChildExpression, checkForUpdatingSubexpressions, checkPermittedContents, clearStreamabilityData, computeDependencies, computeStaticProperties, doPromotion, dynamicError, effectiveBooleanValue, evaluatePendingUpdates, explain, getColumnNumber, getConfiguration, 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, iterateEvents, makeStreamingAdjunct, markTailFunctionCalls, operandList, resetLocalStaticProperties, setContainer, setEvaluationMethod, setFiltered, setFlattened, setLocationId, setPostureAndSweep, simplify, staticTypeCheck, suppressValidation, toPattern, toShortString, toString, typeError, unordered

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.xml.transform.SourceLocator

getColumnNumber, getLineNumber, getPublicId, getSystemId

Constructor Detail

Comment

public Comment()

Construct the instruction

Method Detail

getInstructionNameCode

public int getInstructionNameCode()

Get the instruction name, for diagnostics and tracing return the string "xsl:comment"

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

Description copied from class: Instruction

Get the item type of the items returned by evaluating this instruction

Overrides:

getItemType in class Instruction

Returns:

the static item type of the instruction

getCardinality

public int getCardinality()

Description copied from class: Expression

Determine the static cardinality of the expression. This establishes how many items there will be in the result of the expression, at compile time (i.e., without actually evaluating the result.

Overrides:

getCardinality in class Expression

Returns:

one of the values Cardinality.ONE_OR_MORE, Cardinality.ZERO_OR_MORE, Cardinality.EXACTLY_ONE, Cardinality.ZERO_OR_ONE, Cardinality.EMPTY. This default implementation returns ZERO_OR_MORE (which effectively gives no information).

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

localTypeCheck

public void localTypeCheck(ExpressionVisitor visitor,
                  ContextItemStaticInfo contextItemType)
                    throws XPathException

Description copied from class: SimpleNodeConstructor

Method to perform type-checking specific to the kind of instruction

Specified by:

localTypeCheck in class SimpleNodeConstructor

Parameters:

visitor - an expression visitor

contextItemType - the static type of the context item

Throws:

XPathException - if a type error is detected

processValue

public void processValue(CharSequence value,
                XPathContext context)
                  throws XPathException

Process the value of the node, to create the new node.

Specified by:

processValue in class SimpleNodeConstructor

Parameters:

value - the string value of the new node

context - the dynamic evaluation context

Throws:

XPathException

getExpressionCompiler

public ExpressionCompiler getExpressionCompiler()

Return the compiler of the Comment expression

Overrides:

getExpressionCompiler in class Expression

Returns:

the relevant ExpressionCompiler

checkContent

protected String checkContent(String comment,
                  XPathContext context)
                       throws XPathException

Check the content of the node, and adjust it if necessary

Overrides:

checkContent in class SimpleNodeConstructor

Parameters:

comment - the supplied content

context - the dynamic context

Returns:

the original content, unless adjustments are needed

Throws:

XPathException - if the content is invalid

checkContentXSLT

public static String checkContentXSLT(String comment)

Check the content of the comment according to the XSLT rules (which fix it if it is wrong)

Parameters:

comment - the proposed text of the comment

Returns:

the adjusted text of the comment

checkContentXQuery

public static String checkContentXQuery(String comment)
                                 throws XPathException

Check the content of the comment according to the XQuery rules (which throw an error if it is wrong)

Parameters:

comment - the proposed text of the comment

Returns:

the adjusted text of the comment (always the same as the original if there is no error)

Throws:

XPathException - if the content is invalid

explain

public void explain(ExpressionPresenter out)

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

Specified by:

explain in class Expression

Parameters:

out - the expression presenter used to display the structure