allCharactersEncodable, characterSet, outputProperties, outputStream, streamResult, writer
pipelineConfiguration, previousAtomic, systemId
Constructor and Description |
---|
PTreeEmitter(PipelineConfiguration pipe) |
Modifier and Type | Method and Description |
---|---|
void |
attribute(NodeName nameCode,
SimpleType typeCode,
java.lang.CharSequence value,
Location locationId,
int properties)
Notify an attribute.
|
void |
characters(java.lang.CharSequence chars,
Location locationId,
int properties)
Notify character data.
|
void |
close()
Notify the end of the event stream
|
void |
comment(java.lang.CharSequence content,
Location locationId,
int properties)
Notify a comment.
|
void |
endDocument()
Notify the end of a document node
|
void |
endElement()
Notify the end of an element.
|
void |
namespace(NamespaceBindingSet namespaceBindings,
int properties)
Notify a namespace.
|
void |
open()
Notify the start of the event stream
|
void |
processingInstruction(java.lang.String name,
java.lang.CharSequence data,
Location locationId,
int properties)
Output a processing instruction
|
void |
setPipelineConfiguration(PipelineConfiguration config)
Set the namePool in which all name codes can be found, and other configuration details
|
void |
setStreamResult(javax.xml.transform.stream.StreamResult result)
Set the StreamResult acting as the output destination of the Emitter
|
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 nameCode,
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
|
append, getOutputProperties, getOutputStream, getWriter, makeOutputStream, makeWriter, setOutputProperties, setOutputStream, setUnparsedEntity, setWriter, usesWriter
append, getConfiguration, getNamePool, getPipelineConfiguration, getSystemId, isTrueSequenceReceiver, setSystemId
public PTreeEmitter(PipelineConfiguration pipe)
public void setPipelineConfiguration(PipelineConfiguration config)
setPipelineConfiguration
in interface Receiver
setPipelineConfiguration
in class SequenceReceiver
config
- the pipeline configurationpublic void setStreamResult(javax.xml.transform.stream.StreamResult result) throws XPathException
setStreamResult
in class Emitter
result
- the output destinationXPathException
- if an error occurspublic void attribute(NodeName nameCode, SimpleType typeCode, java.lang.CharSequence value, Location locationId, int properties) throws XPathException
nameCode
- The name of the attribute, as held in the name pooltypeCode
- The type of the attribute, as held in the name poollocationId
- an integer which can be interpreted using a LocationMap to return
information such as line number and system ID. If no location information is available,
the value zero is supplied.properties
- Bit significant value. The following bits are defined:
value
- the string value of the attributeIllegalStateException:
- attempt to output an attribute when there is no open element
start tagXPathException
- if an error occurspublic void characters(java.lang.CharSequence chars, Location locationId, int properties) throws XPathException
chars
- The characterslocationId
- an integer which can be interpreted using a LocationMap to return
information such as line number and system ID. If no location information is available,
the value zero is supplied.properties
- Bit significant value. The following bits are defined:
XPathException
- if an error occurspublic void close() throws XPathException
close
in interface Receiver
close
in class Emitter
XPathException
- if an error occurspublic void comment(java.lang.CharSequence content, Location locationId, int properties) throws XPathException
content
- The content of the commentlocationId
- an integer which can be interpreted using a LocationMap to return
information such as line number and system ID. If no location information is available,
the value zero is supplied.properties
- Additional information about the comment. The following bits are
defined:
IllegalArgumentException:
- the content is invalid for an XML commentXPathException
- if an error occurspublic void endDocument() throws XPathException
XPathException
- if an error occurspublic void endElement() throws XPathException
XPathException
- if an error occurspublic void namespace(NamespaceBindingSet namespaceBindings, int properties) throws XPathException
namespaceBindings
- the (prefix, uri) pair representing a namespace bindingproperties
- 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 ofXPathException
- if an error occurspublic void open() throws XPathException
open
in interface Receiver
open
in class SequenceReceiver
XPathException
- if an error occurspublic void processingInstruction(java.lang.String name, java.lang.CharSequence data, Location locationId, 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 instructionlocationId
- an integer which can be interpreted using a LocationMap to return
information such as line number and system ID. If no location information is available,
the value zero is supplied.properties
- Additional information about the PI. The following bits are
defined:
IllegalArgumentException:
- the content is invalid for an XML processing instructionXPathException
- if an error occurspublic void startContent() throws XPathException
XPathException
- if an error occurspublic void 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 occurspublic void startElement(NodeName nameCode, SchemaType typeCode, Location location, int properties) throws XPathException
nameCode
- integer code identifying the name of the element within the name pool.typeCode
- integer code identifying the element's type within the name pool. The value -1
indicates the default type, xs:untyped.location
- information such as line number and system ID.properties
- bit-significant properties of the element node. If there are no revelantXPathException
- if an error occurspublic boolean usesTypeAnnotations()
usesTypeAnnotations
in interface Receiver
usesTypeAnnotations
in class Emitter
Copyright (c) 2004-2018 Saxonica Limited. All rights reserved.