Package com.saxonica.ee.validate

Class AbstractReceiver

java.lang.Object
com.saxonica.ee.validate.AbstractReceiver
All Implemented Interfaces:
Result, Receiver
Direct Known Subclasses:
FieldChecker, StringValueGatherer
public abstract class AbstractReceiver extends Object implements Receiver
An abstract implementation of Receiver in which all events are (by default) ignored

  • Constructor Details

    • AbstractReceiver

      public AbstractReceiver()

  • Method Details

    • characters

      public void characters(UnicodeString chars, Location locationId, int properties) throws XPathException
      Description copied from interface: Receiver
      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
      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

    • close

      public void close() throws XPathException
      Description copied from interface: Receiver
      Notify the end of the event stream
      Specified by:
      close in interface Receiver
      Throws:
      XPathException - if an error occurs

    • comment

      public void comment(UnicodeString content, Location locationId, int properties) throws XPathException
      Description copied from interface: Receiver
      Notify a comment. Comments are only notified if they are outside the DTD.
      Specified by:
      comment in interface Receiver
      Parameters:
      content - 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

    • endDocument

      public void endDocument() throws XPathException
      Description copied from interface: Receiver
      Notify the end of a document node
      Specified by:
      endDocument in interface Receiver
      Throws:
      XPathException - if an error occurs

    • endElement

      public void endElement() throws XPathException
      Description copied from interface: Receiver
      Notify the end of an element. The receiver must maintain a stack if it needs to know which element is ending.
      Specified by:
      endElement in interface Receiver
      Throws:
      XPathException - if an error occurs

    • getConfiguration

      public Configuration getConfiguration()

    • getPipelineConfiguration

      public PipelineConfiguration getPipelineConfiguration()
      Description copied from interface: Receiver
      Get the pipeline configuration
      Specified by:
      getPipelineConfiguration in interface Receiver
      Returns:
      the pipeline configuration

    • open

      public void open() throws XPathException
      Description copied from interface: Receiver
      Notify the start of the event stream
      Specified by:
      open in interface Receiver
      Throws:
      XPathException - if an error occurs

    • processingInstruction

      public void processingInstruction(String name, UnicodeString data, Location locationId, int properties) throws XPathException
      Description copied from interface: Receiver
      Output a processing instruction
      Specified by:
      processingInstruction in interface Receiver
      Parameters:
      name - 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

    • setPipelineConfiguration

      public void setPipelineConfiguration(PipelineConfiguration config)
      Description copied from interface: Receiver
      Set the pipeline configuration
      Specified by:
      setPipelineConfiguration in interface Receiver
      Parameters:
      config - the pipeline configuration

    • setSystemId

      public void setSystemId(String systemId)
      Specified by:
      setSystemId in interface Result

    • setUnparsedEntity

      public void setUnparsedEntity(String name, String systemID, String publicID) throws XPathException
      Description copied from interface: Receiver
      Notify an unparsed entity URI.
      Specified by:
      setUnparsedEntity in interface Receiver
      Parameters:
      name - The name of the unparsed entity
      systemID - The system identifier of the unparsed entity
      publicID - The identifier of the unparsed entity
      Throws:
      XPathException - if an error occurs

    • startDocument

      public void startDocument(int properties) throws XPathException
      Description copied from interface: Receiver
      Notify the start of a document node
      Specified by:
      startDocument in interface Receiver
      Parameters:
      properties - bit-significant integer indicating properties of the document node. The definitions of the bits are in class ReceiverOption
      Throws:
      XPathException - if an error occurs

    • startElement

      public void startElement(NodeName nameCode, SchemaType typeCode, AttributeMap attributes, NamespaceMap namespaces, Location location, int properties) throws XPathException
      Description copied from interface: Receiver
      Notify the start of an element
      Specified by:
      startElement in interface Receiver
      Parameters:
      nameCode - the name of the element.
      typeCode - 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

    • getSystemId

      public String getSystemId()
      Specified by:
      getSystemId in interface Result

    • usesTypeAnnotations

      public boolean usesTypeAnnotations()
      Description copied from interface: Receiver
      Ask whether this Receiver (or the downstream pipeline) makes any use of the type annotations supplied on element and attribute events. The default implementation of this method returns false.
      Specified by:
      usesTypeAnnotations in interface Receiver
      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 (or conversely, it may avoid stripping unwanted type annotations)