Package net.sf.saxon.event

Class ComplexContentOutputter

  • All Implemented Interfaces:
    Result, Receiver
    public final class ComplexContentOutputter
extends SequenceReceiver
    This class is used for generating complex content, that is, the content of an element or document node. It enforces the rules on the order of events within complex content (attributes and namespaces must come first), and it implements part of the namespace fixup rules, in particular, it ensures that there is a namespace node for the namespace used in the element name and in each attribute name.

    The same ComplexContentOutputter may be used for generating an entire XML document; it is not necessary to create a new outputter for each element node.

    From Saxon 9.9, the ComplexContentOutputter does not combine top-level events. Unless nested within a startDocument/endDocument or startElement/endElement pair, items such as atomic values, text nodes, attribute nodes, maps and arrays are passed through unchanged to the output. It is typically the responsibility of the Destination object to decide how to combine top-level events (whether to build a single document, whether to insert item separators, etc).

    • Constructor Detail

      • ComplexContentOutputter

        public ComplexContentOutputter​(Receiver next)
        Create a ComplexContentOutputter
        Parameters:
        next - the next receiver in the pipeline

    • Method Detail

      • makeComplexContentReceiver

        public static Receiver makeComplexContentReceiver​(Receiver receiver,
                                                  ParseOptions options)
        Static factory method to create an push pipeline containing a ComplexContentOutputter
        Parameters:
        receiver - the destination to which the constructed complex content will be written
        options - options for validating the output stream; may be null

      • setHostLanguage

        public void setHostLanguage​(int language)
        Set the host language
        Parameters:
        language - the host language, for example Configuration.XQUERY

      • setReceiver

        public void setReceiver​(Receiver receiver)
        Set the receiver (to handle the next stage in the pipeline) directly
        Parameters:
        receiver - the receiver to handle the next stage in the pipeline

      • getReceiver

        public Receiver getReceiver()
        Get the next receiver in the processing pipeline
        Returns:
        the receiver which this ComplexContentOutputter writes to

      • startDocument

        public void startDocument​(int properties)
                   throws XPathException
        Start of a document node.
        Parameters:
        properties - bit-significant integer indicating properties of the document node. The definitions of the bits are in class ReceiverOptions
        Throws:
        XPathException - if an error occurs

      • endDocument

        public void endDocument()
                 throws XPathException
        Notify the end of a document node
        Throws:
        XPathException - if an error occurs

      • characters

        public void characters​(CharSequence s,
                       Location locationId,
                       int properties)
                throws XPathException
        Produce text content output.
        Special characters are escaped using XML/HTML conventions if the output format requires it.
        Parameters:
        s - The String to be output
        locationId - the location of the node in the source, or of the instruction that created it
        properties - Bit significant value. The following bits are defined:
        DISABLE_ESCAPING
        Disable escaping for this text node
        USE_CDATA
        Output as a CDATA section
        Throws:
        XPathException - for any failure

      • startElement

        public void startElement​(NodeName elemName,
                         SchemaType typeCode,
                         Location location,
                         int properties)
                  throws XPathException
        Output an element start tag.
        The actual output of the tag is deferred until all attributes have been output using attribute().
        Parameters:
        elemName - The element name
        location - the location of the element node (or the instruction that created it)
        typeCode - the type annotation of the element.
        properties - bit-significant properties of the element node. If there are no revelant properties, zero is supplied. The definitions of the bits are in class ReceiverOptions
        Throws:
        XPathException - if an error occurs

      • namespace

        public void namespace​(NamespaceBindingSet nsBindings,
                      int properties)
               throws XPathException
        Output one or more namespace declarations.
        This is added to a list of pending namespaces for the current start tag. If there is already another declaration of the same prefix, this one is ignored, unless the REJECT_DUPLICATES flag is set, in which case this is an error. Note that unlike SAX2 startPrefixMapping(), this call is made AFTER writing the start tag.
        Parameters:
        nsBindings - The namespace bindings
        properties - The most important property is REJECT_DUPLICATES. If this property is set, the namespace declaration will be rejected if it conflicts with a previous declaration of the same prefix. If the property is not set, the namespace declaration will be ignored if it conflicts with a previous declaration. This reflects the fact that when copying a tree, namespaces for child elements are emitted before the namespaces of their parent element. Unfortunately this conflicts with the XSLT rule for complex content construction, where the recovery action in the event of conflicts is to take the namespace that comes last. XSLT therefore doesn't recover from this error:
        Throws:
        XPathException - if there is no start tag to write to (created using writeStartTag), or if character content has been written since the start tag was written.

      • attribute

        public void attribute​(NodeName attName,
                      SimpleType typeCode,
                      CharSequence value,
                      Location locationId,
                      int properties)
               throws XPathException
        Output an attribute value.
        This is added to a list of pending attributes for the current start tag, overwriting any previous attribute with the same name.
        This method should NOT be used to output namespace declarations.
        Parameters:
        attName - The name of the attribute
        value - The value of the attribute
        locationId - the location of the node in the source, or of the instruction that created it
        properties - Bit fields containing properties of the attribute to be written @throws XPathException if there is no start tag to write to (created using writeStartTag), or if character content has been written since the start tag was written.
        typeCode - The type annotation of the attribute
        Throws:
        XPathException - if an error occurs

      • comment

        public void comment​(CharSequence comment,
                    Location locationId,
                    int properties)
             throws XPathException
        Write a comment
        Parameters:
        comment - The content of the comment
        locationId - provides information such as line number and system ID.
        properties - Additional information about the comment.
        Throws:
        XPathException - if an error occurs

      • processingInstruction

        public void processingInstruction​(String target,
                                  CharSequence data,
                                  Location locationId,
                                  int properties)
                           throws XPathException
        Write a processing instruction
        Parameters:
        target - The PI name. This must be a legal name (it will not be checked).
        data - The data portion of the processing instruction
        locationId - provides information such as line number and system ID.
        properties - Additional information about the PI.
        Throws:
        XPathException - if an error occurs

      • usesTypeAnnotations

        public boolean usesTypeAnnotations()
        Ask whether this Receiver (or the downstream pipeline) makes any use of the type annotations supplied on element and attribute events
        Returns:
        true if the Receiver makes any use of this information. If false, the caller may supply untyped nodes instead of supplying the type annotation

      • isReadyForGrafting

        public boolean isReadyForGrafting()

      • isReadyForBulkCopy

        public boolean isReadyForBulkCopy()