net.sf.saxon.instruct
Class ProcessingInstruction

java.lang.Object
  extended bynet.sf.saxon.instruct.Instruction
      extended bynet.sf.saxon.instruct.ExprInstruction
          extended bynet.sf.saxon.instruct.SimpleNodeConstructor
              extended bynet.sf.saxon.instruct.ProcessingInstruction
All Implemented Interfaces:
Expression, Serializable, SourceLocator

public class ProcessingInstruction
extends SimpleNodeConstructor

An xsl:processing-instruction element 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
ProcessingInstruction(Expression name)
          Create an xsl:processing-instruction instruction
 
Method Summary
 void display(int level, NamePool pool)
          Display this instruction as an expression, for diagnostics
protected  int evaluateNameCode(XPathContext context)
           
 int getDependencies()
          Determine which aspects of the context the expression depends on.
 SequenceType getResultType()
          Get the static type of the value returned by the instruction
 void getXPathExpressions(List list)
           
 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 setInstructionDetails(Controller controller, NamePool namePool, InstructionDetails details)
          Get the name of this instruction for diagnostic and tracing purposes
 void typeCheck(StaticContext env)
           
 
Methods inherited from class net.sf.saxon.instruct.SimpleNodeConstructor
analyze, evaluateItem, expandChildren, setSelect, setSeparator
 
Methods inherited from class net.sf.saxon.instruct.ExprInstruction
effectiveBooleanValue, evaluateAsString, getCardinality, getItemType, getSpecialProperties, getSubExpressions, iterate, promote, simplify
 
Methods inherited from class net.sf.saxon.instruct.Instruction
assembleParams, assembleTunnelParams, getChildren, getColumnNumber, getInstructionDetails, getInstructionName, getLineNumber, getPublicId, getSystemId, getSystemId, process, processChildren, processChildrenLeavingTail, recoverableError, setChildren, setSourceLocation, styleError, styleError
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ProcessingInstruction

public ProcessingInstruction(Expression name)
Create an xsl:processing-instruction instruction

Parameters:
name - the expression used to compute the name of the generated processing-instruction
Method Detail

setInstructionDetails

public void setInstructionDetails(Controller controller,
                                  NamePool namePool,
                                  InstructionDetails details)
Get the name of this instruction for diagnostic and tracing purposes

Specified by:
setInstructionDetails in class Instruction
Returns:
the string "xsl:processing-instruction"

getResultType

public SequenceType getResultType()
Description copied from class: Instruction
Get the static type of the value returned by the instruction

Overrides:
getResultType in class Instruction
Returns:
the SequenceType that the returned value will conform to.

typeCheck

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

getDependencies

public int getDependencies()
Description copied from interface: Expression
Determine which aspects of the context the expression depends on. The result is a bitwise-or'ed value composed from constants such as XPathContext.VARIABLES and XPathContext.CURRENT_NODE. The default implementation combines the intrinsic dependencies of this expression with the dependencies of the subexpressions, computed recursively. This is overridden for expressions such as FilterExpression where a subexpression's dependencies are not necessarily inherited by the parent expression.

Specified by:
getDependencies in interface Expression
Overrides:
getDependencies in class ExprInstruction

getXPathExpressions

public void getXPathExpressions(List list)
Overrides:
getXPathExpressions in class SimpleNodeConstructor

promoteInst

public void promoteInst(PromotionOffer offer)
                 throws XPathException
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.

Specified by:
promoteInst in class ExprInstruction
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
Throws:
XPathException - if any error is detected

processLeavingTail

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

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

evaluateNameCode

protected int evaluateNameCode(XPathContext context)
                        throws XPathException
Overrides:
evaluateNameCode in class SimpleNodeConstructor
Throws:
XPathException

display

public void display(int level,
                    NamePool pool)
Description copied from class: SimpleNodeConstructor
Display this instruction as an expression, for diagnostics

Specified by:
display in interface Expression
Overrides:
display in class SimpleNodeConstructor