Class XMLEmitter

java.lang.Object

com.icl.saxon.output.Emitter

com.icl.saxon.output.XMLEmitter

All Implemented Interfaces:

Result

Direct Known Subclasses:

HTMLEmitter, MessageEmitter, TEXTEmitter, XHTMLEmitter

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
(package private) char[]	attbuff1	Write attribute name=value pair.
protected CharacterSet	characterSet
protected boolean	declarationIsWritten
(package private) boolean	docTypeWritten	Output the document type declaration
protected boolean	empty
protected boolean	escaping
protected String	lastDisplayName
protected int	lastNameCode
protected String	lastPrefix
protected String	lastURI
protected boolean	openStartTag
protected boolean	preferHex
(package private) static boolean[]	specialInAtt
(package private) static boolean[]	specialInText

Fields inherited from class Emitter

locator, namePool, outputProperties, outputStream, systemId, writer

Fields inherited from interface Result

PI_DISABLE_OUTPUT_ESCAPING, PI_ENABLE_OUTPUT_ESCAPING

Constructor Summary

Constructors

Constructor	Description
XMLEmitter()

Method Summary

Modifier and Type	Method	Description
void	characters(char[] ch, int start, int length)	Character data.
protected void	closeStartTag(int nameCode, boolean emptyTag)
void	comment(char[] ch, int start, int length)	Handle a comment.
protected String	emptyElementTagCloser(int nameCode)	Close an empty element tag.
void	endDocument()	End of the document.
void	endElement(int nameCode)	End of an element.
protected void	outputCharacterReference(int charval)
void	processingInstruction(String target, String data)	Handle a processing instruction.
void	setDocumentLocator(Locator locator)	Set Document Locator.
void	setEscaping(boolean escaping)	Set escaping on or off
void	setOutputProperties(Properties details)	Set output properties
void	setResult(Result result)	Set the result destination
void	setUnparsedEntity(String name, String uri)	Set the URI for an unparsed entity in the document.
void	startDocument()	Start of the document.
void	startElement(int nameCode, Attributes attributes, int[] namespaces, int nscount)	Start of an element.
protected boolean	testCharacters(char[] array, int start, int len)
protected void	testCharacters(String name)	Test that all characters in a name are supported in the target encoding
protected void	writeAttribute(int elCode, String attname, String type, String value)
void	writeDeclaration()	Output the XML declaration
protected void	writeDocType(String type, String systemId, String publicId)
protected void	writeEscape(char[] ch, int start, int length, boolean inAttribute)	Write contents of array to current writer, after escaping special characters

Methods inherited from class Emitter

getNamePool, getOutputProperties, getOutputStream, getSystemId, getWriter, makeEmitter, setNamePool, setOutputStream, setSystemId, setWriter, usesWriter

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

characterSet

protected CharacterSet characterSet

empty

protected boolean empty

escaping

protected boolean escaping

openStartTag

protected boolean openStartTag

declarationIsWritten

protected boolean declarationIsWritten

preferHex

protected boolean preferHex

lastNameCode

protected int lastNameCode

lastDisplayName

protected String lastDisplayName

lastPrefix

protected String lastPrefix

lastURI

protected String lastURI

specialInText

static boolean[] specialInText

specialInAtt

static boolean[] specialInAtt

docTypeWritten

boolean docTypeWritten

Output the document type declaration

attbuff1

char[] attbuff1

Write attribute name=value pair. The element name is not used in this version of the method, but is used in the HTML subclass.

Constructor Details

XMLEmitter

public XMLEmitter()

Method Details

setDocumentLocator

public void setDocumentLocator(Locator locator)

Set Document Locator. Provided merely to satisfy the interface.

Overrides:

setDocumentLocator in class Emitter

startDocument

public void startDocument()
                   throws TransformerException

Start of the document. Make the writer and write the XML declaration.

Specified by:

startDocument in class Emitter

Throws:

TransformerException

writeDeclaration

public void writeDeclaration()
                      throws TransformerException

Output the XML declaration

Throws:

TransformerException

writeDocType

protected void writeDocType(String type,
 String systemId,
 String publicId)
                     throws TransformerException

Throws:

TransformerException

endDocument

public void endDocument()
                 throws TransformerException

End of the document. Close the output stream.

Specified by:

endDocument in class Emitter

Throws:

TransformerException

startElement

public void startElement(int nameCode,
 Attributes attributes,
 int[] namespaces,
 int nscount)
                  throws TransformerException

Start of an element. Output the start tag, escaping special characters.

Specified by:

startElement in class Emitter

Parameters:

namespaces - Array of namespace codes identifying the namespace prefix/uri pairs associated with this element

nscount - Number of significant entries within namespaces array

Throws:

TransformerException

closeStartTag

protected void closeStartTag(int nameCode,
 boolean emptyTag)
                      throws TransformerException

Throws:

TransformerException

emptyElementTagCloser

protected String emptyElementTagCloser(int nameCode)

Close an empty element tag. (This is overridden in XHTMLEmitter).

writeAttribute

protected void writeAttribute(int elCode,
 String attname,
 String type,
 String value)
                       throws TransformerException

Throws:

TransformerException

testCharacters

protected void testCharacters(String name)
                       throws TransformerException

Test that all characters in a name are supported in the target encoding

Throws:

TransformerException

testCharacters

protected boolean testCharacters(char[] array,
 int start,
 int len)

endElement

public void endElement(int nameCode)
                throws TransformerException

End of an element.

Specified by:

endElement in class Emitter

Throws:

TransformerException

characters

public void characters(char[] ch,
 int start,
 int length)
                throws TransformerException

Character data.

Specified by:

characters in class Emitter

Throws:

TransformerException

processingInstruction

public void processingInstruction(String target,
 String data)
                           throws TransformerException

Handle a processing instruction.

Specified by:

processingInstruction in class Emitter

Throws:

TransformerException

writeEscape

protected void writeEscape(char[] ch,
 int start,
 int length,
 boolean inAttribute)
                    throws IOException

Write contents of array to current writer, after escaping special characters

Parameters:

ch - The character array containing the string

start - The start position of the input string within the character array

length - The length of the input string within the character array This method converts the XML special characters (such as invalid input: '<' and invalid input: '&') into their predefined entities.

Throws:

IOException

outputCharacterReference

protected void outputCharacterReference(int charval)
                                 throws IOException

Throws:

IOException

setEscaping

public void setEscaping(boolean escaping)

Set escaping on or off

Overrides:

setEscaping in class Emitter

comment

public void comment(char[] ch,
 int start,
 int length)
             throws TransformerException

Handle a comment.

Specified by:

comment in class Emitter

Throws:

TransformerException

setResult

public void setResult(Result result)

Set the result destination

setOutputProperties

public void setOutputProperties(Properties details)

Set output properties

Overrides:

setOutputProperties in class Emitter

setUnparsedEntity

public void setUnparsedEntity(String name,
 String uri)
                       throws TransformerException

Set the URI for an unparsed entity in the document.

Overrides:

setUnparsedEntity in class Emitter

Throws:

TransformerException