Package com.saxonica.ee.stream.adjunct

Class ConditionalBlockAdjunct.ConditionalBlockFeed

java.lang.Object
net.sf.saxon.event.Outputter
net.sf.saxon.event.ProxyOutputter
com.saxonica.ee.stream.feed.ItemFeed
com.saxonica.ee.stream.adjunct.ConditionalBlockAdjunct.ConditionalBlockFeed
All Implemented Interfaces:
Result, Receiver
Enclosing class:
ConditionalBlockAdjunct
public static class ConditionalBlockAdjunct.ConditionalBlockFeed extends ItemFeed

  • Method Details

    • getTentativeContent

      public List<OutputterEvent> getTentativeContent()

    • flushIfNonEmpty

      public void flushIfNonEmpty() throws XPathException
      Throws:
      XPathException

    • isEmpty

      public boolean isEmpty()

    • open

      public void open(Terminator terminator) throws XPathException
      Open the watch. This is done at the point where it first starts watching for nodes that match the selection.
      Overrides:
      open in class ItemFeed
      Parameters:
      terminator - used for early exit
      Throws:
      XPathException - if a dynamic error occurs

    • close

      public void close() throws XPathException
      The close() method is called immediately before the Watch is destroyed, that is, when the element whose declaration scopes the constraint implemented by this Watch goes out of scope. The default implementation does nothing.
      Specified by:
      close in interface Receiver
      Overrides:
      close in class ItemFeed
      Throws:
      XPathException - if a dynamic error occurs

    • startSelectedParentNode

      public Receiver startSelectedParentNode(FleetingParentNode node, Location locationId) throws XPathException
      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

    • endSelectedParentNode

      public void endSelectedParentNode(Location locationId) throws XPathException
      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

    • startDocument

      public void startDocument(int properties) throws XPathException
      Description copied from class: ProxyOutputter
      Notify the start of a document node
      Specified by:
      startDocument in interface Receiver
      Overrides:
      startDocument in class ProxyOutputter
      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

    • endDocument

      public void endDocument() throws XPathException
      Description copied from class: ProxyOutputter
      Notify the end of a document node
      Specified by:
      endDocument in interface Receiver
      Overrides:
      endDocument in class ProxyOutputter
      Throws:
      XPathException - if an 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(String prefix, NamespaceUri 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

    • endElement

      public void endElement() throws XPathException
      Description copied from class: ProxyOutputter
      Notify the end of an element. The Outputter must maintain a stack if it needs to know which element is ending.
      Specified by:
      endElement in interface Receiver
      Overrides:
      endElement 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

    • 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

    • attribute

      public void attribute(NodeName attName, SimpleType typeCode, 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

    • 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