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:
javax.xml.transform.Result,Receiver
- Enclosing class:
- ConditionalBlockAdjunct
public static class ConditionalBlockAdjunct.ConditionalBlockFeed extends ItemFeed
-
-
Field Summary
-
Fields inherited from class net.sf.saxon.event.Outputter
pipelineConfiguration, systemId
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidappend(Item item)Supply one item towards the streamed input of the expressionvoidattribute(NodeName attName, SimpleType typeCode, java.lang.CharSequence value, Location location, int properties)Notify an attribute.voidcharacters(java.lang.CharSequence chars, Location location, int properties)Notify character data.voidclose()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.voidcomment(java.lang.CharSequence content, Location location, int properties)Notify a comment.voidendDocument()Notify the end of a document nodevoidendElement()Notify the end of an element.voidendSelectedParentNode(Location locationId)Signal that the endElement event has occurred for the element whose startElement event caused the Watch to be activated.voidflushIfNonEmpty()java.util.List<OutputterEvent>getTentativeContent()booleanisEmpty()voidnamespace(java.lang.String prefix, java.lang.String namespaceUri, int properties)Notify a namespace binding.voidopen(Terminator terminator)Open the watch.voidstartDocument(int properties)Notify the start of a document nodevoidstartElement(NodeName elemName, SchemaType type, AttributeMap attributes, NamespaceMap namespaces, Location location, int properties)Notify the start of an element, supplying all attributes and namespacesvoidstartElement(NodeName elemName, SchemaType typeCode, Location location, int properties)Notify the start of an elementReceiverstartSelectedParentNode(FleetingParentNode node, Location locationId)Signal that an element or document node has been found that matches the selection that this Watch is looking for.-
Methods inherited from class com.saxonica.ee.stream.feed.ItemFeed
append, dynamicError, getContext, getExpression, getResult, getTerminator, hasFailed, processItems, setExpression, setHasFailed, setTerminator
-
Methods inherited from class net.sf.saxon.event.ProxyOutputter
getNextOutputter, open, processingInstruction, setLocation, setUnparsedEntity, startContent, usesTypeAnnotations
-
Methods inherited from class net.sf.saxon.event.Outputter
getConfiguration, getPipelineConfiguration, getStringReceiver, getSystemId, namespaces, setPipelineConfiguration, setSystemId
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface net.sf.saxon.event.Receiver
handlesAppend
-
-
-
-
Method Detail
-
getTentativeContent
public java.util.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:
openin classItemFeed- Parameters:
terminator- used for early exit- Throws:
XPathException- if a dynamic error occurs
-
close
public void close() throws XPathExceptionThe 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:
closein interfaceReceiver- Overrides:
closein classItemFeed- 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:
startSelectedParentNodein classItemFeed- Parameters:
node- the element or document node whose start event has been matchedlocationId- 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:
endSelectedParentNodein classItemFeed- 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 XPathExceptionDescription copied from class:ProxyOutputterNotify the start of a document node- Specified by:
startDocumentin interfaceReceiver- Overrides:
startDocumentin classProxyOutputter- Parameters:
properties- bit-significant integer indicating properties of the document node. The definitions of the bits are in classReceiverOption- Throws:
XPathException- if an error occurs
-
endDocument
public void endDocument() throws XPathExceptionDescription copied from class:ProxyOutputterNotify the end of a document node- Specified by:
endDocumentin interfaceReceiver- Overrides:
endDocumentin classProxyOutputter- Throws:
XPathException- if an error occurs
-
startElement
public void startElement(NodeName elemName, SchemaType typeCode, Location location, int properties) throws XPathException
Description copied from class:ProxyOutputterNotify the start of an element- Overrides:
startElementin classProxyOutputter- 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 originatedproperties- bit-significant properties of the element node. If there are no relevant properties, zero is supplied. The definitions of the bits are in classReceiverOption- 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:ProxyOutputterNotify the start of an element, supplying all attributes and namespaces- Specified by:
startElementin interfaceReceiver- Overrides:
startElementin classProxyOutputter- Parameters:
elemName- the name of the element.type- the type annotation of the element.attributes- the attributes of this elementnamespaces- the in-scope namespaces of this element: generally this is all the in-scope namespaces, without relying on inheriting namespaces from parent elementslocation- an object providing information about the module, line, and column where the node originatedproperties- bit-significant properties of the element node. If there are no relevant properties, zero is supplied. The definitions of the bits are in classReceiverOption- Throws:
XPathException- if an error occurs
-
namespace
public void namespace(java.lang.String prefix, java.lang.String namespaceUri, int properties) throws XPathExceptionDescription copied from class:ProxyOutputterNotify 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:
namespacein classProxyOutputter- Parameters:
prefix- The namespace prefix; zero-length string for the default namespacenamespaceUri- 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 XPathExceptionDescription copied from class:ProxyOutputterNotify the end of an element. The Outputter must maintain a stack if it needs to know which element is ending.- Specified by:
endElementin interfaceReceiver- Overrides:
endElementin classProxyOutputter- Throws:
XPathException- if an error occurs
-
characters
public void characters(java.lang.CharSequence chars, Location location, int properties) throws XPathExceptionDescription copied from class:ProxyOutputterNotify 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:
charactersin interfaceReceiver- Overrides:
charactersin classProxyOutputter- Parameters:
chars- The characterslocation- 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(java.lang.CharSequence content, Location location, int properties) throws XPathExceptionDescription copied from class:ProxyOutputterNotify a comment. Comments are only notified if they are outside the DTD.- Specified by:
commentin interfaceReceiver- Overrides:
commentin classProxyOutputter- Parameters:
content- The content of the commentlocation- 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, java.lang.CharSequence value, Location location, int properties) throws XPathException
Description copied from class:ProxyOutputterNotify an attribute. Attributes are notified after the startElement event, and before any children. Namespaces and attributes may be intermingled.- Overrides:
attributein classProxyOutputter- Parameters:
attName- The name of the attributetypeCode- The type annotation of the attributevalue- the string value of the attributelocation- 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:ItemFeedSupply one item towards the streamed input of the expression- Specified by:
appendin interfaceReceiver- Specified by:
appendin classItemFeed- Parameters:
item- the item to be supplied- Throws:
XPathException- if the operation fails
-
-