Package com.saxonica.ee.stream.feed

Class ComplexNodeEventFeed

  • All Implemented Interfaces:
    javax.xml.transform.Result, Receiver
    Direct Known Subclasses:
    DocumentInstrAdjunct.DocumentInstrFeed, ElementCreatorFeed, ResultDocumentAdjunct.ResultDocumentFeed
    public abstract class ComplexNodeEventFeed
extends ItemFeed
    This event feed supports instructions that create a document or element node. The events representing the start and end of the element or document are written to the destination receiver during the open() and close() calls. Between these two calls, the child instruction representing the content of the document or element pushes its output to the same destination receiver.

    The instruction-dependent code is contained in the processLeft() and processRight() methods

    • Method Detail

      • open

        public void open​(Terminator terminator)
          throws XPathException
        Description copied from class: ItemFeed
        Start evaluating the expression. The default implementation does nothing.
        Overrides:
        open in class ItemFeed
        Parameters:
        terminator - used to achieve early exit
        Throws:
        XPathException - if a dynamic error occurs

      • startSelectedParentNode

        public Receiver startSelectedParentNode​(FleetingParentNode node,
                                        Location locationId)
                                 throws XPathException
        Description copied from class: ItemFeed
        Signal that an element or document node has been found that matches the selection that this Watch is looking for. This method is called by the WatchManager while processing the startElement or startDocument event that matches the selection.
        Overrides:
        startSelectedParentNode in class ItemFeed
        Parameters:
        node - the element or document node whose start event has been matched
        locationId - the location associated with the element or document node (may be the location of the instruction that created it)
        Returns:
        a Receiver to be notified of all events starting with the startElement/startDocument event for the matched element, and ending with the endElement event for that element; or null if this feature is not required.
        Throws:
        XPathException - May be raised if a dynamic error occurs

      • append

        public void append​(Item item)
            throws XPathException
        Description copied from class: ItemFeed
        Supply one item towards the streamed input of the expression
        Specified by:
        append in interface Receiver
        Specified by:
        append in class ItemFeed
        Parameters:
        item - the item to be supplied
        Throws:
        XPathException - if the operation fails

      • endSelectedParentNode

        public void endSelectedParentNode​(Location locationId)
                           throws XPathException
        Description copied from class: ItemFeed
        Signal that the endElement event has occurred for the element whose startElement event caused the Watch to be activated.
        Overrides:
        endSelectedParentNode in class ItemFeed
        Parameters:
        locationId - the location of the element
        Throws:
        XPathException - May be raised if a constraint implemented by this Watch is violated

      • processLeft

        protected abstract void processLeft​(XPathContext context)
                             throws XPathException
        In streaming mode, process the first half of the instruction (for example, to start a new document or element)
        Parameters:
        context - The dynamic context
        Throws:
        XPathException - if a dynamic error occurs

      • processRight

        protected abstract void processRight​(XPathContext context)
                              throws XPathException
        In streaming mode, process the right half of the instruction (for example, to end a new document or element)
        Parameters:
        context - The dynamic context
        Throws:
        XPathException - if a dynamic error occurs

      • startElement

        public void startElement​(NodeName elemName,
                         SchemaType typeCode,
                         Location location,
                         int properties)
                  throws XPathException
        Description copied from class: ProxyOutputter
        Notify the start of an element
        Overrides:
        startElement in class ProxyOutputter
        Parameters:
        elemName - the name of the element.
        typeCode - the type annotation of the element.
        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

      • startElement

        public void startElement​(NodeName elemName,
                         SchemaType type,
                         AttributeMap attributes,
                         NamespaceMap namespaces,
                         Location location,
                         int properties)
                  throws XPathException
        Description copied from class: ProxyOutputter
        Notify the start of an element, supplying all attributes and namespaces
        Specified by:
        startElement in interface Receiver
        Overrides:
        startElement in class ProxyOutputter
        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

      • namespace

        public void namespace​(java.lang.String prefix,
                      java.lang.String namespaceUri,
                      int properties)
               throws XPathException
        Description copied from class: ProxyOutputter
        Notify a namespace binding. This method is called at some point after startElement(). The semantics are similar to the xsl:namespace instruction in XSLT, or the namespace node constructor in XQuery. A namespace must not conflict with any namespaces already used for element or attribute names.
        Overrides:
        namespace in class ProxyOutputter
        Parameters:
        prefix - The namespace prefix; zero-length string for the default namespace
        namespaceUri - The namespace URI. In some cases a zero-length string may be used to indicate a namespace undeclaration.
        properties - The REJECT_DUPLICATES property: if 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 an error occurs

      • attribute

        public void attribute​(NodeName attName,
                      SimpleType typeCode,
                      java.lang.String value,
                      Location location,
                      int properties)
               throws XPathException
        Description copied from class: ProxyOutputter
        Notify an attribute. Attributes are notified after the startElement event, and before any children. Namespaces and attributes may be intermingled.
        Overrides:
        attribute in class ProxyOutputter
        Parameters:
        attName - The name of the attribute
        typeCode - The type annotation of the attribute
        value - the string value of the attribute
        location - provides information such as line number and system ID.
        properties - Bit significant value. The following bits are defined:
        DISABLE_ESCAPING
        Disable escaping for this attribute
        NO_SPECIAL_CHARACTERS
        Attribute value contains no special characters
        Throws:
        XPathException - if an error occurs

      • startContent

        public void startContent()
                  throws XPathException
        Description copied from class: ProxyOutputter
        Notify the start of the content, that is, the completion of all attributes and namespaces. Note that the initial Outputter of output from XSLT instructions will not receive this event, it has to detect it itself. Note that this event is reported for every element even if it has no attributes, no namespaces, and no content.
        Overrides:
        startContent in class ProxyOutputter
        Throws:
        XPathException - if an error occurs

      • characters

        public void characters​(UnicodeString chars,
                       Location location,
                       int properties)
                throws XPathException
        Description copied from class: ProxyOutputter
        Notify character data. Note that some receivers may require the character data to be sent in a single event, but in general this is not a requirement.
        Specified by:
        characters in interface Receiver
        Overrides:
        characters in class ProxyOutputter
        Parameters:
        chars - The characters
        location - 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 name,
                                  UnicodeString data,
                                  Location location,
                                  int properties)
                           throws XPathException
        Description copied from class: ProxyOutputter
        Output a processing instruction
        Specified by:
        processingInstruction in interface Receiver
        Overrides:
        processingInstruction in class ProxyOutputter
        Parameters:
        name - The PI name. This must be a legal name (it will not be checked).
        data - The data portion of the processing instruction
        location - 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​(UnicodeString content,
                    Location location,
                    int properties)
             throws XPathException
        Description copied from class: ProxyOutputter
        Notify a comment. Comments are only notified if they are outside the DTD.
        Specified by:
        comment in interface Receiver
        Overrides:
        comment in class ProxyOutputter
        Parameters:
        content - The content of the comment
        location - provides information such as line number and system ID.
        properties - Additional information about the comment.
        Throws:
        XPathException - if an error occurs