com.icl.saxon.output

Class GeneralOutputter

public class GeneralOutputter extends Outputter

This class allows output to be generated. It channels output requests to an Emitter which does the actual writing.

Author: Michael H. Kay

Field Summary
char[]charbuffer
Produce literal output.
Constructor Summary
GeneralOutputter(NamePool pool)
Method Summary
intcheckAttributePrefix(int nameCode)
Check that the prefix for an attribute is acceptable, returning a substitute prefix if not.
voidclose()
Close the output
voidcopyNamespaceNode(int nscode)
Copy a namespace node to the current element node (Rules defined in XSLT 1.0 errata)
protected voidflushStartTag()
Flush out a pending start tag
PropertiesgetOutputProperties()
EmittermakeEmitter(Properties props, Result result)
Make an emitter appropriate for a given set of output properties and output destination.
static FileOutputStreammakeFileOutputStream(String baseURI, String fileName, boolean mkdirs)
Create a new FileOutputStream, given a filename and a baseURI
voidreset()
voidsetOutputDestination(Properties props, Result result)
Initialise the outputter for a new output destination, supplying the output format details.
booleanthereIsAnOpenStartTag()
Test whether there is an open start tag.
static StringurlToFileName(String base)
The following atrocious code is borrowed from Xalan, where it is commented simply: // yuck.
voidwrite(String s)
voidwriteAttribute(int nameCode, String value)
Output an attribute value.
voidwriteAttribute(int nameCode, String value, boolean noEscape)
Output an attribute value.
voidwriteComment(String comment)
Write a comment
voidwriteContent(String s)
Produce text content output.
voidwriteContent(char[] chars, int start, int length)
Produce text content output.
voidwriteContent(StringBuffer chars, int start, int len)
Produce text content output.
voidwriteEndTag(int nameCode)
Output an element end tag.
voidwriteNamespaceDeclaration(int nscode)
Output a namespace declaration.
voidwritePI(String target, String data)
Write a processing instruction
voidwriteStartTag(int nameCode)
Output an element start tag.

Field Detail

charbuffer

char[] charbuffer
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().

Constructor Detail

GeneralOutputter

public GeneralOutputter(NamePool pool)

Method Detail

checkAttributePrefix

public 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 void close()
Close the output

copyNamespaceNode

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

flushStartTag

protected void flushStartTag()
Flush out a pending start tag

getOutputProperties

public Properties getOutputProperties()

makeEmitter

public Emitter makeEmitter(Properties props, Result result)
Make an emitter appropriate for a given set of output properties and output destination. Also updates the output properties

makeFileOutputStream

public static FileOutputStream makeFileOutputStream(String baseURI, String fileName, boolean mkdirs)
Create a new FileOutputStream, given a filename and a baseURI

reset

public void reset()

setOutputDestination

public void setOutputDestination(Properties props, Result result)
Initialise the outputter for a new output destination, supplying the output format details.

Parameters: outputProperties Details of the new output format result Details of the new output destination

thereIsAnOpenStartTag

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

urlToFileName

public static String urlToFileName(String base)
The following atrocious code is borrowed from Xalan, where it is commented simply: // yuck. The backslash variants added by MHK.

write

public void write(String s)

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 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 void writeComment(String comment)
Write a comment

writeContent

public 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 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

writeContent

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

Parameters: chars StringBuffer containing to be output start start position of characters to be output len number of characters to be output

Throws: TransformerException for any failure

writeEndTag

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

Parameters: nameCode The element name code

writeNamespaceDeclaration

public 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 void writePI(String target, String data)
Write a processing instruction

writeStartTag

public 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