Package net.sf.saxon.serialize
Class XMLEmitter
java.lang.Object
net.sf.saxon.serialize.Emitter
net.sf.saxon.serialize.XMLEmitter
- Direct Known Subclasses:
HTMLEmitter
,MessageEmitter
,MessageWarner
,TEXTEmitter
,XHTMLEmitter
XMLEmitter is an Emitter that generates XML output
to a specified destination.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected CharacterReferenceGenerator
protected boolean
protected NodeName
protected int
protected boolean
(package private) static boolean[]
(package private) static boolean[]
protected boolean
protected boolean
protected boolean
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
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
attribute
(NodeName nameCode, SimpleType typeCode, CharSequence value, int locationId, int properties) Notify an attribute.void
characters
(CharSequence chars, int locationId, int properties) Character data.void
close()
End of the document.void
Mark the end of the start tagvoid
comment
(CharSequence chars, int locationId, int properties) Handle a comment.protected String
emptyElementTagCloser
(String displayName, NodeName nameCode) Close an empty element tag.void
Notify the end of a document nodevoid
End of an element.protected String
void
namespace
(NamespaceBinding namespaceBinding, int properties) Notify a namespace.void
open()
Start of the event stream.protected void
Do the real work of starting the document.void
processingInstruction
(String target, CharSequence data, int locationId, int properties) Handle a processing instruction.void
Set the character reference generator to be used for generating hexadecimal or decimal character referencesvoid
setEscapeNonAscii
(Boolean escape) Say that all non-ASCII characters should be escaped, regardless of the character encodingvoid
setIndentForNextAttribute
(int indent) void
Notify the start of the content, that is, the completion of all attributes and namespaces.void
startDocument
(int properties) Start of a document node.void
startElement
(NodeName elemName, SchemaType typeCode, int locationId, int properties) Start of an element.protected int
testCharacters
(CharSequence chars) Test that all characters in a name (for example) are supported in the target encoding.boolean
Ask whether this Receiver (or the downstream pipeline) makes any use of the type annotations supplied on element and attribute eventsprotected void
writeAttribute
(NodeName elCode, String attname, CharSequence value, int properties) Write attribute name=value pair.void
Write a CharSequence (without any escaping of special characters): various implementationsvoid
Output the XML declarationprotected void
writeDocType
(String type, String systemId, String publicId) Output the document type declarationprotected void
writeEscape
(CharSequence chars, boolean inAttribute) Write contents of array to current writer, after escaping special characters.Methods inherited from class net.sf.saxon.serialize.Emitter
getConfiguration, getOutputProperties, getOutputStream, getPipelineConfiguration, getSystemId, getWriter, makeOutputStream, makeWriter, setOutputProperties, setOutputStream, setPipelineConfiguration, setStreamResult, setSystemId, setUnparsedEntity, setWriter, usesWriter
-
Field Details
-
started
protected boolean started -
startedElement
protected boolean startedElement -
openStartTag
protected boolean openStartTag -
declarationIsWritten
protected boolean declarationIsWritten -
elementCode
-
indentForNextAttribute
protected int indentForNextAttribute -
undeclareNamespaces
protected boolean undeclareNamespaces -
elementStack
-
characterReferenceGenerator
-
specialInText
static boolean[] specialInText -
specialInAtt
static boolean[] specialInAtt
-
-
Constructor Details
-
XMLEmitter
public XMLEmitter()
-
-
Method Details
-
setCharacterReferenceGenerator
Set the character reference generator to be used for generating hexadecimal or decimal character references- Parameters:
generator
- the character reference generator to be used
-
setEscapeNonAscii
Say that all non-ASCII characters should be escaped, regardless of the character encoding- Parameters:
escape
- true if all non ASCII characters should be escaped
-
open
Start of the event stream. Nothing is done at this stage: the opening of the output file is deferred until some content is written to it.- Throws:
XPathException
- if an error occurs
-
startDocument
Start of a document node. Nothing is done at this stage: the opening of the output file is deferred until some content is written to it.- Parameters:
properties
- bit-significant integer indicating properties of the document node. The definitions of the bits are in classReceiverOptions
- Throws:
XPathException
- if an error occurs
-
endDocument
Notify the end of a document node- Throws:
XPathException
- if an error occurs
-
openDocument
Do the real work of starting the document. This happens when the first content is written.- Throws:
XPathException
- f an error occurs opening the output file
-
writeDeclaration
Output the XML declaration- Throws:
XPathException
-
writeDocType
Output the document type declaration- Parameters:
type
- The element namesystemId
- The DOCTYP system identifierpublicId
- The DOCTYPE public identifier- Throws:
XPathException
- if an error occurs writing to the output
-
close
End of the document.- Specified by:
close
in interfaceReceiver
- Overrides:
close
in classEmitter
- Throws:
XPathException
- if an error occurs
-
startElement
public void startElement(NodeName elemName, SchemaType typeCode, int locationId, int properties) throws XPathException Start of an element. Output the start tag, escaping special characters.- Parameters:
elemName
- the name of the element.typeCode
- the type annotation of the element.locationId
- an integer which can be interpreted using aLocationProvider
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 classReceiverOptions
- Throws:
XPathException
- if an error occurs
-
namespace
Description copied from interface:Receiver
Notify a namespace. Namespaces are notified after the startElement event, and before any children for the element. The namespaces that are reported are only required to include those that are different from the parent element. The events represent namespace declarations and undeclarations rather than in-scope namespace nodes: an undeclaration is represented by a namespace code of zero. If the sequence of namespace events contains two A namespace must not conflict with any namespaces already used for element or attribute names.- Parameters:
namespaceBinding
- 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:- Throws:
XPathException
- if an error occurs
-
setIndentForNextAttribute
public void setIndentForNextAttribute(int indent) -
attribute
public void attribute(NodeName nameCode, SimpleType typeCode, CharSequence value, int locationId, int properties) throws XPathException Description copied from interface:Receiver
Notify an attribute. Attributes are notified after the startElement event, and before any children. Namespaces and attributes may be intermingled.- Parameters:
nameCode
- 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 aLocationProvider
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:- DISABLE_ESCAPING
- Disable escaping for this attribute
- NO_SPECIAL_CHARACTERS
- Attribute value contains no special characters
- Throws:
XPathException
- if an error occurs
-
getAttributeIndentString
-
startContent
Description copied from interface:Receiver
Notify the start of the content, that is, the completion of all attributes and namespaces. Note that the initial receiver of output from XSLT instructions will not receive this event, it has to detect it itself. Note that this event is reported for every element even if it has no attributes, no namespaces, and no content.- Throws:
XPathException
- if an error occurs
-
closeStartTag
Mark the end of the start tag- Throws:
XPathException
- if an IO exception occurs
-
emptyElementTagCloser
Close an empty element tag. (This is overridden in XHTMLEmitter).- Parameters:
displayName
- the name of the empty elementnameCode
- the fingerprint of the name of the empty element- Returns:
- the string used to close an empty element tag.
-
writeAttribute
protected void writeAttribute(NodeName elCode, String attname, CharSequence value, int properties) throws XPathException Write attribute name=value pair.- Parameters:
elCode
- The element name is not used in this version of the method, but is used in the HTML subclass.attname
- The attribute name, which has already been validated to ensure it can be written in this encodingvalue
- The value of the attributeproperties
- Any special properties of the attribute- Throws:
XPathException
- if an error occurs
-
testCharacters
Test that all characters in a name (for example) are supported in the target encoding.- Parameters:
chars
- the characters to be tested- Returns:
- zero if all the characters are available, or the value of the first offending character if not
- Throws:
XPathException
-
endElement
End of an element.- Throws:
XPathException
- if an error occurs
-
characters
Character data.- Parameters:
chars
- The characterslocationId
- an integer which can be interpreted using aLocationProvider
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:- DISABLE_ESCAPING
- Disable escaping for this text node
- USE_CDATA
- Output as a CDATA section
- Throws:
XPathException
- if an error occurs
-
writeCharSequence
Write a CharSequence (without any escaping of special characters): various implementations- Parameters:
s
- the character sequence to be written- Throws:
IOException
- in the event of a failure to write to the output file
-
processingInstruction
public void processingInstruction(String target, CharSequence data, int locationId, int properties) throws XPathException Handle a processing instruction.- Parameters:
target
- 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 aLocationProvider
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.- Throws:
XPathException
- if an error occurs
-
writeEscape
protected void writeEscape(CharSequence chars, boolean inAttribute) throws IOException, XPathException Write contents of array to current writer, after escaping special characters. This method converts the XML special characters (such as invalid input: '<' and invalid input: '&') into their predefined entities.- Parameters:
chars
- The character sequence containing the stringinAttribute
- Set to true if the text is in an attribute value- Throws:
IOException
XPathException
-
comment
Handle a comment.- Parameters:
chars
- The content of the commentlocationId
- an integer which can be interpreted using aLocationProvider
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.- Throws:
XPathException
- if an error occurs
-
usesTypeAnnotations
public boolean usesTypeAnnotations()Ask whether this Receiver (or the downstream pipeline) makes any use of the type annotations supplied on element and attribute events- Specified by:
usesTypeAnnotations
in interfaceReceiver
- Overrides:
usesTypeAnnotations
in classEmitter
- Returns:
- true if the Receiver makes any use of this information. If false, the caller may supply untyped nodes instead of supplying the type annotation
-