Package com.saxonica.ee.stream.feed
Class ExistenceFeed
- java.lang.Object
-
- net.sf.saxon.event.Outputter
-
- net.sf.saxon.event.ProxyOutputter
-
- com.saxonica.ee.stream.feed.ItemFeed
-
- com.saxonica.ee.stream.feed.ExistenceFeed
-
-
Field Summary
-
Fields inherited from class net.sf.saxon.event.Outputter
pipelineConfiguration, systemId
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
ExistenceFeed(Expression exp, ItemFeed result, XPathContext context)
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description abstract void
action()
void
append(Item item)
Supply one item towards the streamed input of the expressionvoid
attribute(NodeName attName, SimpleType typeCode, java.lang.String value, Location location, int properties)
Notify an attribute.void
characters(UnicodeString chars, Location location, int properties)
Notify character data.abstract void
close()
Finish evaluating the expression.void
comment(UnicodeString content, Location location, int properties)
Notify a comment.void
endDocument()
Notify the end of a document nodevoid
endElement()
Notify the end of an element.void
namespace(java.lang.String prefix, NamespaceUri namespaceUri, int properties)
Notify a namespace binding.void
startDocument(int properties)
Notify the start of a document nodevoid
startElement(NodeName elemName, SchemaType type, AttributeMap attributes, NamespaceMap namespaces, Location location, int properties)
Notify the start of an element, supplying all attributes and namespacesvoid
startElement(NodeName elemName, SchemaType typeCode, Location location, int properties)
Notify the start of an element-
Methods inherited from class com.saxonica.ee.stream.feed.ItemFeed
append, dynamicError, endSelectedParentNode, getContext, getExpression, getResultFeed, getTerminator, hasFailed, open, processItems, setExpression, setHasFailed, setTerminator, startSelectedParentNode
-
Methods inherited from class net.sf.saxon.event.ProxyOutputter
getNextOutputter, open, processingInstruction, 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
-
-
-
-
Constructor Detail
-
ExistenceFeed
protected ExistenceFeed(Expression exp, ItemFeed result, XPathContext context)
-
-
Method Detail
-
action
public abstract void action() throws XPathException
- Throws:
XPathException
-
startDocument
public void startDocument(int properties) throws XPathException
Description copied from class:ProxyOutputter
Notify the start of a document node- Specified by:
startDocument
in interfaceReceiver
- Overrides:
startDocument
in 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 XPathException
Description copied from class:ProxyOutputter
Notify the end of a document node- Specified by:
endDocument
in interfaceReceiver
- Overrides:
endDocument
in 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:ProxyOutputter
Notify the start of an element- Overrides:
startElement
in 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:ProxyOutputter
Notify the start of an element, supplying all attributes and namespaces- Specified by:
startElement
in interfaceReceiver
- Overrides:
startElement
in 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, 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 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 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 interfaceReceiver
- Overrides:
endElement
in classProxyOutputter
- 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 interfaceReceiver
- Overrides:
characters
in 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(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 interfaceReceiver
- Overrides:
comment
in 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.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 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:ItemFeed
Supply one item towards the streamed input of the expression- Specified by:
append
in interfaceReceiver
- Specified by:
append
in classItemFeed
- Parameters:
item
- the item to be supplied- Throws:
XPathException
- if the operation fails
-
close
public abstract void close() throws XPathException
Description copied from class:ItemFeed
Finish evaluating the expression.- Specified by:
close
in interfaceReceiver
- Overrides:
close
in classItemFeed
- Throws:
XPathException
- if a dynamic error occurs
-
-