public interface Receiver
extends javax.xml.transform.Result
Modifier and Type | Method and Description |
---|---|
void |
attribute(NodeName attName,
SimpleType typeCode,
java.lang.CharSequence value,
Location location,
int properties)
Notify an attribute.
|
void |
characters(java.lang.CharSequence chars,
Location location,
int properties)
Notify character data.
|
void |
close()
Notify the end of the event stream
|
void |
comment(java.lang.CharSequence content,
Location location,
int properties)
Notify a comment.
|
void |
endDocument()
Notify the end of a document node
|
void |
endElement()
Notify the end of an element.
|
PipelineConfiguration |
getPipelineConfiguration()
Get the pipeline configuration
|
void |
namespace(NamespaceBindingSet namespaceBindings,
int properties)
Notify one or more namespaces.
|
void |
open()
Notify the start of the event stream
|
void |
processingInstruction(java.lang.String name,
java.lang.CharSequence data,
Location location,
int properties)
Output a processing instruction
|
void |
setPipelineConfiguration(PipelineConfiguration pipe)
Set the pipeline configuration
|
void |
setSystemId(java.lang.String systemId)
Set the System ID of the tree represented by this event stream
|
void |
setUnparsedEntity(java.lang.String name,
java.lang.String systemID,
java.lang.String publicID)
Notify an unparsed entity URI.
|
void |
startContent()
Notify the start of the content, that is, the completion of all attributes and namespaces.
|
void |
startDocument(int properties)
Notify the start of a document node
|
void |
startElement(NodeName elemName,
SchemaType typeCode,
Location location,
int properties)
Notify the start of an element
|
boolean |
usesTypeAnnotations()
Ask whether this Receiver (or the downstream pipeline) makes any use of the type annotations
supplied on element and attribute events
|
void setPipelineConfiguration(PipelineConfiguration pipe)
pipe
- the pipeline configurationPipelineConfiguration getPipelineConfiguration()
void setSystemId(java.lang.String systemId)
setSystemId
in interface javax.xml.transform.Result
systemId
- the system ID (which is used as the base URI of the nodes
if there is no xml:base attribute)void open() throws XPathException
XPathException
- if an error occursvoid startDocument(int properties) throws XPathException
properties
- bit-significant integer indicating properties of the document node.
The definitions of the bits are in class ReceiverOptions
XPathException
- if an error occursvoid endDocument() throws XPathException
XPathException
- if an error occursvoid setUnparsedEntity(java.lang.String name, java.lang.String systemID, java.lang.String publicID) throws XPathException
name
- The name of the unparsed entitysystemID
- The system identifier of the unparsed entitypublicID
- The identifier of the unparsed entityXPathException
- if an error occursvoid startElement(NodeName elemName, SchemaType typeCode, Location location, int properties) throws XPathException
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 revelant
properties, zero is supplied. The definitions of the bits are in class ReceiverOptions
XPathException
- if an error occursvoid namespace(NamespaceBindingSet namespaceBindings, int properties) throws XPathException
namespaceBindings
- contains the namespace prefix and namespace URIproperties
- The most important property is REJECT_DUPLICATES. If this property is 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:XPathException
- if an error occursvoid attribute(NodeName attName, SimpleType typeCode, java.lang.CharSequence value, Location location, int properties) throws XPathException
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:
IllegalStateException:
- attempt to output an attribute when there is no open element
start tagXPathException
- if an error occursvoid startContent() throws XPathException
XPathException
- if an error occursvoid endElement() throws XPathException
XPathException
- if an error occursvoid characters(java.lang.CharSequence chars, Location location, int properties) throws XPathException
chars
- The characterslocation
- provides information such as line number and system ID.properties
- Bit significant value. The following bits are defined:
XPathException
- if an error occursvoid processingInstruction(java.lang.String name, java.lang.CharSequence data, Location location, int properties) throws XPathException
name
- The PI name. This must be a legal name (it will not be checked).data
- The data portion of the processing instructionlocation
- provides information such as line number and system ID.properties
- Additional information about the PI.IllegalArgumentException:
- the content is invalid for an XML processing instructionXPathException
- if an error occursvoid comment(java.lang.CharSequence content, Location location, int properties) throws XPathException
content
- The content of the commentlocation
- provides information such as line number and system ID.properties
- Additional information about the comment.IllegalArgumentException:
- the content is invalid for an XML commentXPathException
- if an error occursvoid close() throws XPathException
XPathException
- if an error occursboolean usesTypeAnnotations()
Copyright (c) 2004-2018 Saxonica Limited. All rights reserved.