net.sf.saxon.instruct
Class Text

java.lang.Object
  |
  +--net.sf.saxon.instruct.Instruction
        |
        +--net.sf.saxon.instruct.ExprInstruction
              |
              +--net.sf.saxon.instruct.SimpleNodeConstructor
                    |
                    +--net.sf.saxon.instruct.Text
All Implemented Interfaces:
Expression, Instr, Locatable, java.io.Serializable, javax.xml.transform.SourceLocator

public class Text
extends SimpleNodeConstructor

Handler for xsl:text elements (and simple text nodes) in the stylesheet.

See Also:
Serialized Form

Field Summary
 
Fields inherited from class net.sf.saxon.instruct.SimpleNodeConstructor
select, separator
 
Fields inherited from class net.sf.saxon.instruct.Instruction
children
 
Constructor Summary
Text(boolean disable)
          Create an xsl:text instruction
 
Method Summary
 int getCardinality()
          Determine the static cardinality of the expression.
 java.lang.String getInstructionName()
          Get the name of this instruction for diagnostic and tracing purposes
 ItemType getItemType()
          Determine the data type of the expression, if possible.
 TailCall processLeavingTail(XPathContext context)
          Process this instruction, that is, produce a processing-instruction node in the result sequence.
 void promoteInst(PromotionOffer offer)
          Offer promotion for subexpressions.
 void typeCheck(StaticContext env)
           
 
Methods inherited from class net.sf.saxon.instruct.SimpleNodeConstructor
analyze, display, evaluateItem, evaluateNameCode, expandChildren, getXPathExpressions, setSelect, setSeparator
 
Methods inherited from class net.sf.saxon.instruct.ExprInstruction
effectiveBooleanValue, evaluateAsString, getDependencies, getSpecialProperties, getSubExpressions, iterate, promote, simplify
 
Methods inherited from class net.sf.saxon.instruct.Instruction
assembleParams, assembleTunnelParams, displayChildren, dynamicError, dynamicError, getChildren, getColumnNumber, getExecutable, getInstructionNamespace, getLineNumber, getPublicId, getSourceLocator, getSystemId, process, processChildren, processChildrenLeavingTail, recoverableError, setChildren, setExecutable, setSourceLocation
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Text

public Text(boolean disable)
Create an xsl:text instruction

Parameters:
disable - set to true if output escaping is to be disabled
Method Detail

getInstructionName

public java.lang.String getInstructionName()
Get the name of this instruction for diagnostic and tracing purposes

Specified by:
getInstructionName in class Instruction

getItemType

public ItemType getItemType()
Description copied from interface: Expression
Determine the data type of the expression, if possible. All expression return sequences, in general; this method determines the type of the items within the sequence, assuming that (a) this is known in advance, and (b) it is the same for all items in the sequence.

This method should always return a result, though it may be the best approximation that is available at the time.

Specified by:
getItemType in interface Expression
Overrides:
getItemType in class Instruction
Returns:
a value such as Type.STRING, Type.BOOLEAN, Type.NUMBER, Type.NODE, or Type.ITEM (meaning not known at compile time)

getCardinality

public int getCardinality()
Description copied from interface: 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.

This method should always return a result, though it may be the best approximation that is available at the time.

Specified by:
getCardinality in interface Expression
Overrides:
getCardinality in class Instruction
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).

processLeavingTail

public TailCall processLeavingTail(XPathContext context)
                            throws javax.xml.transform.TransformerException
Process this instruction, that is, produce a processing-instruction node in the result sequence.

Specified by:
processLeavingTail in interface Instr
Specified by:
processLeavingTail in class Instruction
Parameters:
context - the dynamic context of this transformation
Returns:
always returns null in this implementation
Throws:
javax.xml.transform.TransformerException - if any non-recoverable dynamic error occurs

promoteInst

public void promoteInst(PromotionOffer offer)
Description copied from class: SimpleNodeConstructor
Offer promotion for subexpressions. The offer will be accepted if the subexpression is not dependent on the factors (e.g. the context item) identified in the PromotionOffer. By default the offer is not accepted - this is appropriate in the case of simple expressions such as constant values and variable references where promotion would give no performance advantage. This method is always called at compile time.

Overrides:
promoteInst in class SimpleNodeConstructor
Parameters:
offer - details of the offer, for example the offer to move expressions that don't depend on the context to an outer level in the containing expression

typeCheck

public void typeCheck(StaticContext env)
Specified by:
typeCheck in class SimpleNodeConstructor