Package net.sf.saxon.event
Class XMLEmitter
- java.lang.Object
-
- net.sf.saxon.event.Emitter
-
- net.sf.saxon.event.XMLEmitter
-
- All Implemented Interfaces:
javax.xml.transform.Result
,Receiver
- Direct Known Subclasses:
HTMLEmitter
,MessageEmitter
,MessageWarner
,TEXTEmitter
,XHTMLEmitter
,XQueryEmitter
public class XMLEmitter extends Emitter
XMLEmitter is an Emitter that generates XML output to a specified destination.
-
-
Field Summary
Fields Modifier and Type Field Description protected boolean
declarationIsWritten
protected int
elementCode
protected java.util.Stack
elementStack
protected boolean
empty
protected boolean
openStartTag
protected boolean
preferHex
protected boolean
undeclareNamespaces
-
Fields inherited from class net.sf.saxon.event.Emitter
allCharactersEncodable, characterSet, namePool, outputProperties, outputStream, pipelineConfig, streamResult, systemId, writer
-
-
Constructor Summary
Constructors Constructor Description XMLEmitter()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
attribute(int nameCode, int typeCode, java.lang.CharSequence value, int locationId, int properties)
Notify an attribute.void
characters(java.lang.CharSequence chars, int locationId, int properties)
Character data.void
close()
End of the document.void
closeStartTag()
Mark the end of the start tagvoid
comment(java.lang.CharSequence chars, int locationId, int properties)
Handle a comment.protected java.lang.String
emptyElementTagCloser(java.lang.String displayName, int nameCode)
Close an empty element tag.void
endDocument()
Notify the end of a document nodevoid
endElement()
End of an element.protected java.lang.String
getCachedName(int nameCode)
Get a name from the local name cachevoid
namespace(int namespaceCode, int properties)
Notify a namespace.void
open()
Start of the event stream.protected void
openDocument()
Do the real work of starting the document.protected void
outputCharacterReference(int charval)
void
processingInstruction(java.lang.String target, java.lang.CharSequence data, int locationId, int properties)
Handle a processing instruction.protected void
putCachedName(int nameCode, java.lang.String displayName)
Add a name to the local name cachevoid
startContent()
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(java.lang.CharSequence chars)
Test that all characters in a name (for example) are supported in the target encoding.protected void
writeAttribute(int elCode, java.lang.String attname, java.lang.CharSequence value, int properties)
Write attribute name=value pair.void
writeCharSequence(java.lang.CharSequence s)
Write a CharSequence (without any escaping of special characters): various implementationsvoid
writeDeclaration()
Output the XML declarationprotected void
writeDocType(java.lang.String type, java.lang.String systemId, java.lang.String publicId)
Output the document type declarationprotected void
writeEscape(java.lang.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 Detail
-
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
protected java.util.Stack elementStack
-
-
Method Detail
-
open
public void open() throws XPathException
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
public void startDocument(int properties) throws XPathException
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
-
endDocument
public void endDocument() throws XPathException
Notify the end of a document node- Throws:
XPathException
-
openDocument
protected void openDocument() throws XPathException
Do the real work of starting the document. This happens when the first content is written.- Throws:
XPathException
-
writeDeclaration
public void writeDeclaration() throws XPathException
Output the XML declaration- Throws:
XPathException
-
writeDocType
protected void writeDocType(java.lang.String type, java.lang.String systemId, java.lang.String publicId) throws XPathException
Output the document type declaration- Parameters:
type
- The element namesystemId
- The DOCTYP system identifierpublicId
- The DOCTYPE public identifier- Throws:
XPathException
-
close
public void close() throws XPathException
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, xs: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. The definitions of the bits are in classReceiverOptions
- Throws:
XPathException
-
namespace
public void namespace(int namespaceCode, int properties) throws XPathException
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, java.lang.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.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
-
startContent
public void startContent() throws XPathException
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
public void closeStartTag() throws XPathException
Mark the end of the start tag- Throws:
XPathException
- if an IO exception occurs
-
emptyElementTagCloser
protected java.lang.String emptyElementTagCloser(java.lang.String displayName, int nameCode)
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(int elCode, java.lang.String attname, java.lang.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
protected int testCharacters(java.lang.CharSequence chars) throws XPathException
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
public void endElement() throws XPathException
End of an element.- Throws:
XPathException
-
characters
public void characters(java.lang.CharSequence chars, int locationId, int properties) throws XPathException
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
-
writeCharSequence
public void writeCharSequence(java.lang.CharSequence s) throws java.io.IOException
Write a CharSequence (without any escaping of special characters): various implementations- Parameters:
s
- the character sequence to be written- Throws:
java.io.IOException
-
processingInstruction
public void processingInstruction(java.lang.String target, java.lang.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(java.lang.CharSequence chars, boolean inAttribute) throws java.io.IOException, XPathException
Write contents of array to current writer, after escaping special characters. This method converts the XML special characters (such as < and &) into their predefined entities.- Parameters:
chars
- The character sequence containing the stringinAttribute
- Set to true if the text is in an attribute value- Throws:
java.io.IOException
XPathException
-
outputCharacterReference
protected void outputCharacterReference(int charval) throws java.io.IOException
- Throws:
java.io.IOException
-
comment
public void comment(java.lang.CharSequence chars, int locationId, int properties) throws XPathException
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
-
getCachedName
protected java.lang.String getCachedName(int nameCode)
Get a name from the local name cache- Parameters:
nameCode
- the integer name code- Returns:
- a lexical QName if the name is in the cache; otherwise, null
-
putCachedName
protected void putCachedName(int nameCode, java.lang.String displayName)
Add a name to the local name cache- Parameters:
nameCode
- the integer name codedisplayName
- the corresponding lexical QName
-
-