Package net.sf.saxon.expr.instruct

Class ResultDocument

java.lang.Object
net.sf.saxon.expr.Expression
net.sf.saxon.expr.instruct.Instruction
net.sf.saxon.expr.instruct.ResultDocument
All Implemented Interfaces:
Serializable, SourceLocator, LocationProvider, SaxonLocator, DivisibleInstruction, TailCallReturner, ValidatingInstruction, InstructionInfo, Locator
public class ResultDocument extends Instruction implements DivisibleInstruction, ValidatingInstruction
The compiled form of an xsl:result-document 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. In addition, individual serialization properties may be specified as attributes. These are attribute value templates, so they may need to be computed at run-time.

See Also:

  • Constructor Details

    • ResultDocument

      public ResultDocument(Properties globalProperties, Properties localProperties, Expression href, Expression formatExpression, String baseURI, int validationAction, SchemaType schemaType, IntHashMap<Expression> serializationAttributes, NamespaceResolver nsResolver)
      Create a result-document instruction
      Parameters:
      globalProperties - properties defined on static xsl:output
      localProperties - non-AVT properties defined on result-document element
      href - href attribute of instruction
      formatExpression - format attribute of instruction
      baseURI - base URI of the instruction
      validationAction - for example Validation.STRICT
      schemaType - schema type against which output is to be validated
      serializationAttributes - computed local properties
      nsResolver - namespace resolver

  • Method Details

    • setContentExpression

      public void setContentExpression(Expression content)
      Set the expression that constructs the content
      Parameters:
      content - the expression defining the content of the result document

    • getContentExpression

      public Expression getContentExpression()
      Get the expression that constructs the content
      Specified by:
      getContentExpression in interface DivisibleInstruction
      Returns:
      the content expression

    • setDynamicOutputElement

      public void setDynamicOutputElement(Expression exp)
      Set an expression that evaluates to a run-time xsl:output element, used in the saxon:result-document() extension function designed for use in XQuery
      Parameters:
      exp - the expression whose result should be an xsl:output element

    • setUseStaticBaseUri

      public void setUseStaticBaseUri(boolean staticBase)
      Set whether the the instruction should resolve the href relative URI against the static base URI (rather than the dynamic base output URI)
      Parameters:
      staticBase - set to true by fn:put(), to resolve against the static base URI of the query. Default is false, which causes resolution against the base output URI obtained dynamically from the Controller

    • simplify

      public Expression simplify(ExpressionVisitor visitor) throws XPathException
      Simplify an expression. This performs any static optimization (by rewriting the expression as a different expression). The default implementation does nothing.
      Specified by:
      simplify in class Instruction
      Parameters:
      visitor - an expression visitor
      Returns:
      the simplified expression
      Throws:
      XPathException - if an error is discovered during expression rewriting

    • typeCheck

      public Expression typeCheck(ExpressionVisitor visitor, ExpressionVisitor.ContextItemType contextItemType) throws XPathException
      Description copied from class: Expression
      Perform type checking of an expression and its subexpressions. This is the second phase of static optimization.

      This checks statically that the operands of the expression have the correct type; if necessary it generates code to do run-time type checking or type conversion. A static type error is reported only if execution cannot possibly succeed, that is, if a run-time type error is inevitable. The call may return a modified form of the expression.

      This method is called after all references to functions and variables have been resolved to the declaration of the function or variable. However, the types of such functions and variables may not be accurately known if they have not been explicitly declared.

      If the implementation returns a value other than "this", then it is required to ensure that the location information in the returned expression have been set up correctly. It should not rely on the caller to do this, although for historical reasons many callers do so.

      Overrides:
      typeCheck in class Expression
      Parameters:
      visitor - an expression visitor
      contextItemType - the static type of "." at the point where this expression is invoked. The parameter is set to null if it is known statically that the context item will be undefined. If the type of the context item is not known statically, the argument is set to Type.ITEM_TYPE
      Returns:
      the original expression, rewritten to perform necessary run-time type checks, and to perform other type-related optimizations
      Throws:
      XPathException - if an error is discovered during this phase (typically a type error)

    • optimize

      public Expression optimize(ExpressionVisitor visitor, ExpressionVisitor.ContextItemType contextItemType) throws XPathException
      Description copied from class: Expression
      Perform optimisation of an expression and its subexpressions. This is the third and final phase of static optimization.

      This method is called after all references to functions and variables have been resolved to the declaration of the function or variable, and after all type checking has been done.

      Overrides:
      optimize in class Expression
      Parameters:
      visitor - an expression visitor
      contextItemType - the static type of "." at the point where this expression is invoked. The parameter is set to null if it is known statically that the context item will be undefined. If the type of the context item is not known statically, the argument is set to Type.ITEM_TYPE
      Returns:
      the original expression, rewritten if appropriate to optimize execution
      Throws:
      XPathException - if an error is discovered during this phase (typically a type error)

    • getIntrinsicDependencies

      public int getIntrinsicDependencies()
      Description copied from class: Expression
      Determine the intrinsic dependencies of an expression, that is, those which are not derived from the dependencies of its subexpressions. For example, position() has an intrinsic dependency on the context position, while (position()+1) does not. The default implementation of the method returns 0, indicating "no dependencies".
      Overrides:
      getIntrinsicDependencies in class Expression
      Returns:
      a set of bit-significant flags identifying the "intrinsic" dependencies. The flags are documented in class net.sf.saxon.value.StaticProperty

    • 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

    • promoteInst

      protected void promoteInst(PromotionOffer offer) throws XPathException
      Handle promotion offers, that is, non-local tree rewrites.
      Overrides:
      promoteInst in class Instruction
      Parameters:
      offer - The type of rewrite being offered
      Throws:
      XPathException

    • 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
      Returns:
      a code identifying the instruction: typically but not always the fingerprint of a name in the XSLT namespace

    • getItemType

      public ItemType getItemType(TypeHierarchy th)
      Get the item type of the items returned by evaluating this instruction
      Overrides:
      getItemType in class Instruction
      Parameters:
      th - the type hierarchy cache
      Returns:
      the static item type of the instruction. This is empty: the result-document instruction returns nothing.

    • getSchemaType

      public SchemaType getSchemaType()
      Specified by:
      getSchemaType in interface ValidatingInstruction

    • getValidationAction

      public int getValidationAction()
      Specified by:
      getValidationAction in interface ValidatingInstruction

    • iterateSubExpressions

      public Iterator<Expression> 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)
      Overrides:
      iterateSubExpressions in class Expression
      Returns:
      an iterator containing the sub-expressions of this expression

    • replaceSubExpression

      public boolean replaceSubExpression(Expression original, Expression replacement)
      Replace one subexpression by a replacement subexpression
      Overrides:
      replaceSubExpression in class Expression
      Parameters:
      original - the original subexpression
      replacement - the replacement subexpression
      Returns:
      true if the original subexpression is found

    • 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

    • process

      public void process(Expression content, XPathContext context) throws XPathException
      Evaluation method designed for calling from compiled bytecode.
      Parameters:
      content - The content expression. When called from bytecode, this will be the compiled version of the interpreted content expression
      context - dynamic evaluation context
      Throws:
      XPathException - if a dynamic error occurs

    • processLeft

      public void processLeft(Stack<XPathContext> contextStack, Stack<Object> state) throws XPathException
      In streaming mode, process the first half of the instruction (for example, to start a new document or element)
      Specified by:
      processLeft in interface DivisibleInstruction
      Parameters:
      contextStack - Stack of XPathContext objects. The instruction should use the one at the top of the stack. Some instructions (such as xsl:result-document) create a new context object and add it to the stack, removing it in the corresponding processRight() action.
      state - a stack on which the instruction can save state information during the call on processLeft()
      Throws:
      XPathException - if a dynamic error occurs

    • processRight

      public void processRight(Stack<XPathContext> contextStack, Stack<Object> state) throws XPathException
      In streaming mode, process the right half of the instruction (for example, to end a new document or element)
      Specified by:
      processRight in interface DivisibleInstruction
      Parameters:
      contextStack - the stack of dynamic context objects
      state - a stack on which the instruction can save state information during the call on processLeft()
      Throws:
      XPathException - if a dynamic error occurs

    • setSerializationProperty

      public static void setSerializationProperty(Properties details, String uri, String lname, String value, NamespaceResolver nsResolver, boolean prevalidated, Configuration config) throws XPathException
      Validate a serialization property and add its value to a Properties collection
      Parameters:
      details - the properties to be updated
      uri - the uri of the property name
      lname - the local part of the property name
      value - the value of the serialization property. In the case of QName-valued values, this will use lexical QNames if prevalidated is false and a NamespaceResolver is supplied; otherwise they will use Clark-format names
      nsResolver - resolver for lexical QNames; not needed if prevalidated, or if QNames are supplied in Clark format
      prevalidated - true if values are already known to be valid and lexical QNames have been expanded into Clark notation
      config - the Saxon configuration
      Throws:
      XPathException - if any serialization property has an invalid value

    • 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

    • processXslOutputElement

      public static void processXslOutputElement(NodeInfo element, Properties props, XPathContext c) throws XPathException
      Construct a set of output properties from an xsl:output element supplied at run-time
      Parameters:
      element - an xsl:output element
      props - Properties object to which will be added the values of those serialization properties that were specified
      c - the XPath dynamic context
      Throws:
      XPathException - if a dynamic error occurs