public abstract class BinaryEmitter extends Emitter
allCharactersEncodable, characterSet, namePool, outputProperties, outputStream, pipelineConfig, streamResult, systemId, writerPI_DISABLE_OUTPUT_ESCAPING, PI_ENABLE_OUTPUT_ESCAPING| Constructor and Description |
|---|
BinaryEmitter() |
| Modifier and Type | Method and Description |
|---|---|
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 |
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 |
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
|
protected abstract byte[] |
textNodeToBinary(CharSequence chars) |
boolean |
usesTypeAnnotations()
Ask whether this Receiver (or the downstream pipeline) makes any use of the type annotations
supplied on element and attribute events
|
boolean |
usesWriter()
Determine whether the Emitter wants a Writer for character output or
an OutputStream for binary output.
|
close, getConfiguration, getOutputProperties, getOutputStream, getPipelineConfiguration, getSystemId, getWriter, makeOutputStream, makeWriter, setOutputProperties, setOutputStream, setPipelineConfiguration, setStreamResult, setSystemId, setUnparsedEntity, setWriterpublic boolean usesWriter()
usesWriter in class Emitterpublic void open()
throws XPathException
ReceiverXPathException - if an error occurspublic void startDocument(int properties)
throws XPathException
Receiverproperties - bit-significant integer indicating properties of the document node.
The definitions of the bits are in class ReceiverOptionsXPathException - if an error occurspublic void endDocument()
throws XPathException
ReceiverXPathException - if an error occurspublic void startElement(NodeName nameCode, SchemaType typeCode, int locationId, int properties) throws XPathException
ReceivernameCode - the name of the element.typeCode - the type annotation of the element.locationId - an integer which can be interpreted using a LocationProvider 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
properties, zero is supplied. The definitions of the bits are in class ReceiverOptionsXPathException - if an error occurspublic void namespace(NamespaceBinding namespaceBinding, int properties) throws XPathException
ReceivernamespaceBinding - 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 occurspublic void attribute(NodeName nameCode, SimpleType typeCode, CharSequence value, int locationId, int properties) throws XPathException
ReceivernameCode - The name of the attributetypeCode - The type of the attribute, as held in the name pool. The additional bit
NodeInfo.IS_DTD_TYPE may be set to indicate a DTD-derived type.value - the string value of the attributelocationId - an integer which can be interpreted using a LocationProvider 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 startContent()
throws XPathException
ReceiverXPathException - if an error occurspublic void endElement()
throws XPathException
ReceiverXPathException - if an error occurspublic void characters(CharSequence chars, int locationId, int properties) throws XPathException
Receiverchars - The characterslocationId - an integer which can be interpreted using a LocationProvider
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 occursprotected abstract byte[] textNodeToBinary(CharSequence chars) throws XPathException
XPathExceptionpublic void processingInstruction(String name, CharSequence data, int locationId, int properties) throws XPathException
Receivername - 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 LocationProvider 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.XPathException - if an error occurspublic void comment(CharSequence content, int locationId, int properties) throws XPathException
Receivercontent - The content of the commentlocationId - an integer which can be interpreted using a LocationProvider 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.XPathException - if an error occurspublic boolean usesTypeAnnotations()
EmitterusesTypeAnnotations in interface ReceiverusesTypeAnnotations in class EmitterCopyright (c) 2004-2013 Saxonica Limited. All rights reserved.