Class PrincipalOutputGatekeeper

  • All Implemented Interfaces:
    javax.xml.transform.Result, Receiver

    public class PrincipalOutputGatekeeper
    extends ProxyReceiver
    This class is added to the output pipeline for the principal result destination for a transformation if the transformation uses xsl:result-document instructions. It is there to deal with the possibility that an xsl:result-document instruction will use the same output URI (or no output URI) in which case it is defined to write to the principal output destination, but potentially with different serialization parameters.

    If actual output is produced to the principal result destination, then this PrincipalOutputGatekeeper will be marked as being "used by primary", which will cause any attempt to open a secondary result destination on the same URI (either explicitly, or by omitting the href attribute, or by setting href to a zero length string) as an error. Apart from this marker, the PrincipalOutputGatekeeper acts as a pass-through filter for the output events.

    If a secondary result destination is opened using the principal output URI (either explicitly or implicitly), then the PrincipalOutputGatekeeper is marked as being "used by secondary", which will cause any attempts to write events to the PrincipalOutputGatekeeper to fail. Secondary result output is not actually directed through the gatekeeper; the gatekeeper is merely notified of its existence.

    • Constructor Detail

    • Method Detail

      • startElement

        public void startElement​(NodeName elemName,
                                 SchemaType type,
                                 AttributeMap attributes,
                                 NamespaceMap namespaces,
                                 Location location,
                                 int properties)
                          throws XPathException
        Description copied from class: ProxyReceiver
        Notify the start of an element
        Specified by:
        startElement in interface Receiver
        Overrides:
        startElement in class ProxyReceiver
        Parameters:
        elemName - the name of the element.
        type - the type annotation of the element.
        attributes - the attributes of this element
        namespaces - the in-scope namespaces of this element: generally this is all the in-scope namespaces, without relying on inheriting namespaces from parent elements
        location - an object providing information about the module, line, and column where the node originated
        properties - bit-significant properties of the element node. If there are no relevant properties, zero is supplied. The definitions of the bits are in class ReceiverOption
        Throws:
        XPathException - if an error occurs
      • characters

        public void characters​(java.lang.CharSequence chars,
                               Location locationId,
                               int properties)
                        throws XPathException
        Description copied from class: ProxyReceiver
        Character data
        Specified by:
        characters in interface Receiver
        Overrides:
        characters in class ProxyReceiver
        Parameters:
        chars - The characters
        locationId - provides information such as line number and system ID.
        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 - if an error occurs
      • processingInstruction

        public void processingInstruction​(java.lang.String target,
                                          java.lang.CharSequence data,
                                          Location locationId,
                                          int properties)
                                   throws XPathException
        Description copied from class: ProxyReceiver
        Processing Instruction
        Specified by:
        processingInstruction in interface Receiver
        Overrides:
        processingInstruction in class ProxyReceiver
        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
      • comment

        public void comment​(java.lang.CharSequence chars,
                            Location locationId,
                            int properties)
                     throws XPathException
        Description copied from class: ProxyReceiver
        Output a comment
        Specified by:
        comment in interface Receiver
        Overrides:
        comment in class ProxyReceiver
        Parameters:
        chars - 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
      • append

        public void append​(Item item,
                           Location locationId,
                           int copyNamespaces)
                    throws XPathException
        Description copied from class: ProxyReceiver
        Append an arbitrary item (node or atomic value) to the output
        Specified by:
        append in interface Receiver
        Overrides:
        append in class ProxyReceiver
        Parameters:
        item - the item to be appended
        locationId - the location of the calling instruction, for diagnostics
        copyNamespaces - if the item is an element node, this indicates whether its namespaces need to be copied. Values are ReceiverOption.ALL_NAMESPACES; the default (0) means
        Throws:
        XPathException - if an error occurs