Package net.sf.saxon.event

Class EventSource

  • All Implemented Interfaces:
    javax.xml.transform.Source, ActiveSource
    public abstract class EventSource
extends java.lang.Object
implements ActiveSource
    An implementation of the JAXP Source class that supplies a document in the form of a stream of push events sent to a Receiver
    Since:
    9.1

    • Constructor Summary

      Constructors 
      Constructor Description
      EventSource()  

    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      abstract void deliver​(Receiver out, ParseOptions options)
      Supply events to a Receiver.
      java.lang.String getSystemId()
      Get the system identifier that was set with setSystemId.
      void setSystemId​(java.lang.String systemId)
      Set the system identifier for this Source.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

      • Methods inherited from interface javax.xml.transform.Source

        isEmpty

    • Constructor Detail

      • EventSource

        public EventSource()

    • Method Detail

      • setSystemId

        public void setSystemId​(java.lang.String systemId)
        Set the system identifier for this Source.

        The system identifier is optional if the source does not get its data from a URL, but it may still be useful to provide one. The application can use a system identifier, for example, to resolve relative URIs and to include in error messages and warnings.

        Specified by:
        setSystemId in interface javax.xml.transform.Source
        Parameters:
        systemId - The system identifier as a URL string.

      • getSystemId

        public java.lang.String getSystemId()
        Get the system identifier that was set with setSystemId.
        Specified by:
        getSystemId in interface javax.xml.transform.Source
        Returns:
        The system identifier that was set with setSystemId, or null if setSystemId was not called.

      • deliver

        public abstract void deliver​(Receiver out,
                             ParseOptions options)
                      throws XPathException
        Supply events to a Receiver.
        Specified by:
        deliver in interface ActiveSource
        Parameters:
        out - the Receiver to which events will be sent. It is the caller's responsibility to initialize the receiver with a PipelineConfiguration, and to call the open() and close() methods on the receiver before and after calling this send() method.
        options - options for parsing XML input
        Throws:
        XPathException - if any error occurs