Class CatchingReceiver

All Implemented Interfaces:
Result, Receiver

public class CatchingReceiver extends ProxyReceiver
This class catches all errors thrown by a Receiver pipeline, and reports them to a specified ErrorReporter; after an error has occurred, all further events are ignored. The class is added to a validation pipeline when validation of a streamed input document is requested, to allow a try/catch expression to catch validation errors.
  • Constructor Details

  • Method Details

    • open

      public void open()
      Description copied from class: ProxyReceiver
      Start of event stream
      Specified by:
      open in interface Receiver
      Overrides:
      open in class ProxyReceiver
    • close

      public void close()
      Description copied from class: ProxyReceiver
      End of output. Note that closing this receiver also closes the rest of the pipeline.
      Specified by:
      close in interface Receiver
      Overrides:
      close in class ProxyReceiver
    • startDocument

      public void startDocument(int properties)
      Description copied from class: ProxyReceiver
      Start of a document node.
      Specified by:
      startDocument in interface Receiver
      Overrides:
      startDocument in class ProxyReceiver
      Parameters:
      properties - bit-significant integer indicating properties of the document node. The definitions of the bits are in class ReceiverOption
    • endDocument

      public void endDocument()
      Description copied from class: ProxyReceiver
      Notify the end of a document node
      Specified by:
      endDocument in interface Receiver
      Overrides:
      endDocument in class ProxyReceiver
    • startElement

      public void startElement(NodeName elemName, SchemaType type, AttributeMap attributes, NamespaceMap namespaces, Location location, int properties)
      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
    • endElement

      public void endElement()
      Description copied from class: ProxyReceiver
      End of element
      Specified by:
      endElement in interface Receiver
      Overrides:
      endElement in class ProxyReceiver
    • characters

      public void characters(UnicodeString chars, Location locationId, int properties)
      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
    • processingInstruction

      public void processingInstruction(String target, UnicodeString data, Location locationId, int properties)
      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.
    • comment

      public void comment(UnicodeString chars, Location locationId, int properties)
      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.
    • append

      public void append(Item item, Location locationId, int copyNamespaces)
      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