Package net.sf.saxon.event
Class XMLEmitter
java.lang.Object
net.sf.saxon.event.Emitter
net.sf.saxon.event.XMLEmitter
- Direct Known Subclasses:
HTMLEmitter
,MessageEmitter
,TEXTEmitter
,XHTMLEmitter
XMLEmitter is an Emitter that generates XML output
to a specified destination.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected boolean
protected int
protected Stack
protected boolean
protected boolean
protected boolean
(package private) static boolean[]
(package private) static boolean[]
protected boolean
Fields inherited from class net.sf.saxon.event.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
(int nameCode, int 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
void
comment
(CharSequence chars, int locationId, int properties) Handle a comment.protected String
emptyElementTagCloser
(String displayName, int nameCode) Close an empty element tag.void
Notify the end of a document nodevoid
End of an element.static void
void
namespace
(int namespaceCode, int properties) Notify a namespace.void
open()
Start of the event stream.protected void
Do the real work of starting the document.protected void
outputCharacterReference
(int charval) void
processingInstruction
(String target, CharSequence data, int locationId, int properties) Handle a processing instruction.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
(int nameCode, int typeCode, int locationId, int properties) Start of an element.protected int
testCharacters
(CharSequence chars) Test that all characters in a name are supported in the target encoding.protected void
writeAttribute
(int elCode, String attname, CharSequence value, int properties) Write attribute name=value pair.void
Write a CharSequence: 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.event.Emitter
getConfiguration, getOutputProperties, getOutputStream, getPipelineConfiguration, getSystemId, getWriter, makeWriter, setOutputProperties, setOutputStream, setPipelineConfiguration, setStreamResult, setSystemId, setUnparsedEntity, setWriter, usesWriter
-
Field Details
-
empty
protected boolean empty -
openStartTag
protected boolean openStartTag -
declarationIsWritten
protected boolean declarationIsWritten -
elementCode
protected int elementCode -
preferHex
protected boolean preferHex -
undeclareNamespaces
protected boolean undeclareNamespaces -
elementStack
-
specialInText
static boolean[] specialInText -
specialInAtt
static boolean[] specialInAtt
-
-
Constructor Details
-
XMLEmitter
public XMLEmitter()
-
-
Method Details
-
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
-
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.- Throws:
XPathException
-
endDocument
Notify the end of a document node- Throws:
XPathException
-
openDocument
Do the real work of starting the document. This happens when the first content is written.- Throws:
XPathException
-
writeDeclaration
Output the XML declaration- Throws:
XPathException
-
writeDocType
Output the document type declaration- Throws:
XPathException
-
close
End of the document.- Throws:
XPathException
-
startElement
public void startElement(int nameCode, int typeCode, int locationId, int properties) throws XPathException Start of an element. Output the start tag, escaping special characters.- Parameters:
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, xdt:untyped.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.- Throws:
XPathException
-
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:
namespaceCode
- an integer: the top half is a prefix code, the bottom half a URI code. These may be translated into an actual prefix and URI using the name pool. A prefix code of zero represents the empty prefix (that is, the default namespace). A URI code of zero represents a URI of "", that is, a namespace undeclaration.properties
- 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: it sets the REJECT_DUPLICATES flag, and this is treated as a hard error.- Throws:
XPathException
-
attribute
public void attribute(int nameCode, int 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 attribute, as held in the name pooltypeCode
- 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.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 value. The following bits are defined:- DISABLE_ESCAPING
- Disable escaping for this attribute
- NO_SPECIAL_CHARACTERS
- Attribute value contains no special characters
- Throws:
XPathException
-
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
-
closeStartTag
- Throws:
XPathException
-
emptyElementTagCloser
Close an empty element tag. (This is overridden in XHTMLEmitter). -
writeAttribute
protected void writeAttribute(int 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
-
testCharacters
Test that all characters in a name are supported in the target encoding.- 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
-
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
- NO_SPECIAL_CHARACTERS
- Value contains no special characters
- WHITESPACE
- Text is all whitespace
- Throws:
XPathException
-
writeCharSequence
Write a CharSequence: various implementations- Throws:
IOException
-
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. The following bits are defined:- CHECKED
- Data is known to be legal (e.g. doesn't contain "?>")
- Throws:
XPathException
-
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
-
outputCharacterReference
- Throws:
IOException
-
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. The following bits are defined:- CHECKED
- Comment is known to be legal (e.g. doesn't contain "--")
- Throws:
XPathException
-
main
- Throws:
Exception
-