|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object net.sf.saxon.serialize.Emitter com.saxonica.ptree.PTreeEmitter
public class PTreeEmitter
An Emitter (serializer) to output a result tree in Saxon PTree format
Field Summary |
---|
Fields inherited from class net.sf.saxon.serialize.Emitter |
---|
allCharactersEncodable, characterSet, namePool, outputProperties, outputStream, pipelineConfig, streamResult, systemId, writer |
Fields inherited from interface javax.xml.transform.Result |
---|
PI_DISABLE_OUTPUT_ESCAPING, PI_ENABLE_OUTPUT_ESCAPING |
Constructor Summary | |
---|---|
PTreeEmitter(PipelineConfiguration pipe)
|
Method Summary | |
---|---|
void |
attribute(NodeName nameCode,
SimpleType typeCode,
CharSequence value,
int locationId,
int properties)
Notify an attribute. |
void |
characters(CharSequence chars,
int locationId,
int properties)
Notify character data. |
void |
close()
Notify the end of the event stream |
void |
comment(CharSequence content,
int 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(NamespaceBinding namespaceBinding,
int properties)
Notify a namespace. |
void |
open()
Notify the start of the event stream |
void |
processingInstruction(String name,
CharSequence data,
int 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(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,
int locationId,
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 |
Methods inherited from class net.sf.saxon.serialize.Emitter |
---|
getConfiguration, getOutputProperties, getOutputStream, getPipelineConfiguration, getSystemId, getWriter, makeOutputStream, makeWriter, setOutputProperties, setOutputStream, setSystemId, setUnparsedEntity, setWriter, usesWriter |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public PTreeEmitter(PipelineConfiguration pipe)
Method Detail |
---|
public void setPipelineConfiguration(PipelineConfiguration config)
setPipelineConfiguration
in interface Receiver
setPipelineConfiguration
in class Emitter
config
- the pipeline configurationpublic void setStreamResult(StreamResult result) throws XPathException
setStreamResult
in class Emitter
result
- the output destination
XPathException
- if an error occurspublic void attribute(NodeName nameCode, SimpleType typeCode, CharSequence value, int 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 attribute
IllegalStateException:
- attempt to output an attribute when there is no open element
start tag
XPathException
- if an error occurspublic void characters(CharSequence chars, int 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(CharSequence content, int 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 comment
XPathException
- if an error occurspublic void endDocument() throws XPathException
XPathException
- if an error occurspublic void endElement() throws XPathException
XPathException
- if an error occurspublic void namespace(NamespaceBinding namespaceBinding, int properties) throws XPathException
namespaceBinding
- 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 of
conflicts is to take the namespace that comes last. XSLT therefore doesn't recover from this error:
XPathException
- if an error occurspublic void open() throws XPathException
XPathException
- if an error occurspublic void processingInstruction(String name, CharSequence data, int 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 instruction
XPathException
- 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, int locationId, 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.locationId
- 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 properties of the element node. If there are no revelant
XPathException
- if an error occurspublic boolean usesTypeAnnotations()
usesTypeAnnotations
in interface Receiver
usesTypeAnnotations
in class Emitter
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |