Class XSLResultDocument

  • All Implemented Interfaces:
    javax.xml.transform.Source, javax.xml.transform.SourceLocator, LocationProvider, SaxonLocator, Container, FingerprintedNode, Item, NodeInfo, ValueRepresentation, InstructionInfo, org.xml.sax.Locator

    public class XSLResultDocument
    extends StyleElement
    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 "name" which determines the format of the output file, it identifies the name of an xsl:output element containing the output format details.
    • Constructor Detail

      • XSLResultDocument

        public XSLResultDocument()
    • Method Detail

      • isInstruction

        public boolean isInstruction()
        Determine whether this node is an instruction.
        Overrides:
        isInstruction in class StyleElement
        Returns:
        true - it is an instruction
      • mayContainSequenceConstructor

        public boolean mayContainSequenceConstructor()
        Determine whether this type of element is allowed to contain a template-body
        Overrides:
        mayContainSequenceConstructor in class StyleElement
        Returns:
        true: yes, it may contain a template-body
      • getReturnedItemType

        protected ItemType getReturnedItemType()
        Determine the type of item returned by this instruction (only relevant if it is an instruction). Default implementation returns Type.ITEM, indicating that we don't know, it might be anything. Returns null in the case of an element such as xsl:sort or xsl:variable that can appear in a sequence constructor but contributes nothing to the result sequence.
        Overrides:
        getReturnedItemType in class StyleElement
        Returns:
        the item type returned
      • prepareAttributes

        public void prepareAttributes()
                               throws XPathException
        Description copied from class: StyleElement
        Set the attribute list for the element. This is called to process the attributes (note the distinction from processAttributes in the superclass). Must be supplied in a subclass
        Specified by:
        prepareAttributes in class StyleElement
        Throws:
        XPathException
      • validate

        public void validate()
                      throws XPathException
        Description copied from class: StyleElement
        Check that the stylesheet element is valid. This is called once for each element, after the entire tree has been built. As well as validation, it can perform first-time initialisation. The default implementation does nothing; it is normally overriden in subclasses.
        Overrides:
        validate in class StyleElement
        Throws:
        XPathException
      • compile

        public Expression compile​(Executable exec)
                           throws XPathException
        Description copied from class: StyleElement
        Compile the instruction on the stylesheet tree into an executable instruction for use at run-time.
        Specified by:
        compile in class StyleElement
        Returns:
        either a ComputedExpression, or null. The value null is returned when compiling an instruction that returns a no-op, or when compiling a top-level object such as an xsl:template that compiles into something other than an instruction.
        Throws:
        XPathException