net.sf.saxon.instruct
Class ResultDocument

java.lang.Object
  |
  +--net.sf.saxon.expr.ComputedExpression
        |
        +--net.sf.saxon.instruct.Instruction
              |
              +--net.sf.saxon.instruct.InstructionWithChildren
                    |
                    +--net.sf.saxon.instruct.ResultDocument
All Implemented Interfaces:
Container, Expression, InstructionInfoProvider, java.io.Serializable, javax.xml.transform.SourceLocator

public class ResultDocument
extends InstructionWithChildren

An xsl:result-document (formerly saxon:output) element in the stylesheet.
The xsl:result-document element takes an attribute href="filename". The filename will often contain parameters, e.g. {position()} to ensure that a different file is produced for each element instance.
There is a further attribute "format" which determines the format of the output file, it identifies the name of an xsl:output element containing the output format details.

See Also:
Serialized Form

Field Summary
 
Fields inherited from class net.sf.saxon.instruct.InstructionWithChildren
children
 
Fields inherited from class net.sf.saxon.expr.ComputedExpression
locationId, staticProperties
 
Fields inherited from interface net.sf.saxon.expr.Expression
EVALUATE_METHOD, ITERATE_METHOD, PROCESS_METHOD
 
Constructor Summary
ResultDocument(java.util.Properties outputProperties, Expression href, java.lang.String baseURI, int validationAction, SchemaType schemaType, java.util.HashMap serializationAttributes, NamespaceResolver nsResolver)
           
 
Method Summary
 void display(int level, NamePool pool, java.io.PrintStream out)
          Diagnostic print of expression structure.
 int getInstructionNameCode()
          Get the name of this instruction for diagnostic and tracing purposes (the string "xsl:result-document")
 ItemType getItemType()
          Get the item type of the items returned by evaluating this instruction
 java.util.Iterator iterateSubExpressions()
          Get all the XPath expressions associated with this instruction (in XSLT terms, the expression present on attributes of the instruction, as distinct from the child instructions in a sequence construction)
 TailCall processLeavingTail(XPathContext context)
          ProcessLeavingTail: called to do the real work of this instruction.
protected  void promoteInst(PromotionOffer offer)
          Handle promotion offers, that is, non-local tree rewrites.
static void setSerializationProperty(java.util.Properties details, int fp, java.lang.String value, NamePool pool, NamespaceResolver nsResolver)
          Validate a serialization property and add its value to a Properties collection
 
Methods inherited from class net.sf.saxon.instruct.InstructionWithChildren
analyze, displayChildren, getChildren, processChildren, processChildrenLeavingTail, setChildren, simplify
 
Methods inherited from class net.sf.saxon.instruct.Instruction
appendItem, assembleParams, assembleTunnelParams, computeCardinality, computeSpecialProperties, dynamicError, dynamicError, effectiveBooleanValue, evaluateAsString, evaluateItem, getImplementationMethod, getInstructionInfo, getSourceLocator, iterate, process, promote
 
Methods inherited from class net.sf.saxon.expr.ComputedExpression
adoptChildExpression, computeDependencies, computeStaticProperties, dynamicError, dynamicError, getCardinality, getColumnNumber, getConstructType, getDependencies, getExecutable, getIntrinsicDependencies, getLineNumber, getLocationId, getParentExpression, getPublicId, getSpecialProperties, getSystemId, markTailFunctionCalls, resetStaticProperties, setLocationId, setParentExpression, typeError
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface javax.xml.transform.SourceLocator
getColumnNumber, getLineNumber, getPublicId, getSystemId
 

Constructor Detail

ResultDocument

public ResultDocument(java.util.Properties outputProperties,
                      Expression href,
                      java.lang.String baseURI,
                      int validationAction,
                      SchemaType schemaType,
                      java.util.HashMap serializationAttributes,
                      NamespaceResolver nsResolver)
Method Detail

getInstructionNameCode

public int getInstructionNameCode()
Get the name of this instruction for diagnostic and tracing purposes (the string "xsl:result-document")

Overrides:
getInstructionNameCode in class Instruction

getItemType

public ItemType getItemType()
Get the item type of the items returned by evaluating this instruction

Specified by:
getItemType in interface Expression
Overrides:
getItemType in class Instruction
Returns:
the static item type of the instruction. This is empty: the result-document instruction returns nothing.

promoteInst

protected void promoteInst(PromotionOffer offer)
                    throws XPathException
Handle promotion offers, that is, non-local tree rewrites.

Overrides:
promoteInst in class InstructionWithChildren
Parameters:
offer - The type of rewrite being offered
Throws:
XPathException

iterateSubExpressions

public java.util.Iterator iterateSubExpressions()
Get all the XPath expressions associated with this instruction (in XSLT terms, the expression present on attributes of the instruction, as distinct from the child instructions in a sequence construction)

Specified by:
iterateSubExpressions in interface Expression
Overrides:
iterateSubExpressions in class InstructionWithChildren
Returns:
an iterator containing the sub-expressions of this expression

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 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.
XPathException

setSerializationProperty

public static void setSerializationProperty(java.util.Properties details,
                                            int fp,
                                            java.lang.String value,
                                            NamePool pool,
                                            NamespaceResolver nsResolver)
                                     throws XPathException
Validate a serialization property and add its value to a Properties collection

XPathException

display

public void display(int level,
                    NamePool pool,
                    java.io.PrintStream out)
Diagnostic print of expression structure. The expression is written to the System.err output stream

Parameters:
level - indentation level for this expression
out -
pool - NamePool used to expand any names appearing in the expression