com.icl.saxon.output

Class Outputter

public abstract class Outputter extends Object

This class allows output to be generated. It channels output requests to an Emitter which does the actual writing. This is an abstract class, there are concrete implementions for XML output and text output.

Author: Michael H. Kay

Field Summary
protected Emitteremitter
Method Summary
abstract intcheckAttributePrefix(int nameCode)
Check that the prefix for an attribute is acceptable, returning a substitute prefix if not.
abstract voidclose()
Close the output
abstract voidcopyNamespaceNode(int nscode)
Copy a namespace node to the current element node (Rules defined in XSLT 1.0 errata)
EmittergetEmitter()
Get emitter.
abstract PropertiesgetOutputProperties()
voidopen()
Start the output process
abstract voidreset()
Synchronize the state of the Outputter with that of the underlying Emitter
voidsetEscaping(boolean escaping)
Switch escaping (of special characters) on or off.
abstract booleanthereIsAnOpenStartTag()
Test whether there is an open start tag.
abstract voidwrite(String s)
Produce literal output.
voidwriteAttribute(int nameCode, String value)
Output an attribute value.
abstract voidwriteAttribute(int nameCode, String value, boolean noEscape)
Output an attribute value.
abstract voidwriteComment(String comment)
Write a comment
abstract voidwriteContent(String s)
Produce text content output.
abstract voidwriteContent(char[] chars, int start, int length)
Produce text content output.
abstract voidwriteEndTag(int nameCode)
Output an element end tag.
abstract voidwriteNamespaceDeclaration(int nscode)
Output a namespace declaration.
abstract voidwritePI(String target, String data)
Write a processing instruction
abstract voidwriteStartTag(int nameCode)
Output an element start tag.

Field Detail

emitter

protected Emitter emitter

Method Detail

checkAttributePrefix

public abstract int checkAttributePrefix(int nameCode)
Check that the prefix for an attribute is acceptable, returning a substitute prefix if not. The prefix is acceptable unless a namespace declaration has been written that assignes this prefix to a different namespace URI. This method also checks that the attribute namespace has been declared, and declares it if not.

close

public abstract void close()
Close the output

copyNamespaceNode

public abstract void copyNamespaceNode(int nscode)
Copy a namespace node to the current element node (Rules defined in XSLT 1.0 errata)

getEmitter

public Emitter getEmitter()
Get emitter. This is used by xsl:copy-of, a fragment is copied directly to the Emitter rather than going via the Outputter.

getOutputProperties

public abstract Properties getOutputProperties()

open

public final void open()
Start the output process

reset

public abstract void reset()
Synchronize the state of the Outputter with that of the underlying Emitter

setEscaping

public final void setEscaping(boolean escaping)
Switch escaping (of special characters) on or off.

Parameters: escaping: true if special characters are to be escaped, false if not.

thereIsAnOpenStartTag

public abstract boolean thereIsAnOpenStartTag()
Test whether there is an open start tag. This determines whether it is possible to write an attribute node at this point.

write

public abstract void write(String s)
Produce literal output. This is written as is, without any escaping. The method is provided for Java applications that wish to output literal HTML text. It is not used by the XSL system, which always writes using specific methods such as writeStartTag().

writeAttribute

public void writeAttribute(int nameCode, String value)
Output an attribute value.
This is added to a list of pending attributes for the current start tag, overwriting any previous attribute with the same name.
This method should NOT be used to output namespace declarations.

Parameters: nameCode The name code of the attribute value The value of the attribute

Throws: TransformerException if there is no start tag to write to (created using writeStartTag), or if character content has been written since the start tag was written.

writeAttribute

public abstract void writeAttribute(int nameCode, String value, boolean noEscape)
Output an attribute value.
This is added to a list of pending attributes for the current start tag, overwriting any previous attribute with the same name.
This method should NOT be used to output namespace declarations.
Before calling this, checkAttributePrefix() should be called to ensure the namespace is OK.

Parameters: name The name of the attribute value The value of the attribute noEscape True if it's known there are no special characters in the value. If unsure, set this to false.

Throws: TransformerException if there is no start tag to write to (created using writeStartTag), or if character content has been written since the start tag was written.

writeComment

public abstract void writeComment(String comment)
Write a comment

writeContent

public abstract void writeContent(String s)
Produce text content output.
Special characters are escaped using XML/HTML conventions if the output format requires it.

Parameters: s The String to be output

Throws: TransformerException for any failure

writeContent

public abstract void writeContent(char[] chars, int start, int length)
Produce text content output.
Special characters are escaped using XML/HTML conventions if the output format requires it.

Parameters: chars Character array to be output start start position of characters to be output length number of characters to be output

Throws: TransformerException for any failure

writeEndTag

public abstract void writeEndTag(int nameCode)
Output an element end tag.

Parameters: nameCode The element name code

writeNamespaceDeclaration

public abstract void writeNamespaceDeclaration(int nscode)
Output a namespace declaration.
This is added to a list of pending namespaces for the current start tag. If there is already another declaration of the same prefix, this one is ignored. Note that unlike SAX2 startPrefixMapping(), this call is made AFTER writing the start tag.

Parameters: nscode The namespace code

Throws: TransformerException if there is no start tag to write to (created using writeStartTag), or if character content has been written since the start tag was written.

writePI

public abstract void writePI(String target, String data)
Write a processing instruction

writeStartTag

public abstract void writeStartTag(int nameCode)
Output an element start tag.
The actual output of the tag is deferred until all attributes have been output using writeAttribute().

Parameters: nameCode The element name code