Overview Package Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

com.icl.saxon.output

Class StringOutputter

public final class StringOutputter
extends Outputter
This class allows output to be generated. It channels output requests to an Emitter which does the actual writing. This is a specialized and simplified version that is used to handle xsl:attribute, xsl:comment, and xsl:processing-instruction.

Field Summary

Fields inherited from class com.icl.saxon.output.Outputter

emitter

Constructor Summary

StringOutputter(StringBuffer buffer)

Method Summary

int
checkAttributePrefix(int nameCode)
Check that the prefix for an attribute is acceptable, returning a substitute prefix if not.
void
close()
Close the output
void
copyNamespaceNode(int nscode)
Copy a namespace node to the current element node (Rules defined in XSLT 1.0 errata)
Properties
getOutputProperties()
void
reset()
void
setErrorListener(ErrorListener listener)
boolean
thereIsAnOpenStartTag()
Test whether there is an open start tag.
void
write(String s)
Produce literal output.
void
writeAttribute(int nameCode, String value, boolean noEscape)
Output an attribute value.
void
writeComment(String comment)
Write a comment.
void
writeContent(String s)
Produce text content output.
void
writeContent(char[] chars, int start, int length)
Produce text content output.
void
writeEndTag(int nameCode)
Output an element end tag.
void
writeNamespaceDeclaration(int nscode)
Output a namespace declaration.
void
writePI(String target, String data)
Write a processing instruction No-op in this implementation
void
writeStartTag(int nameCode)
Output an element start tag.

Methods inherited from class com.icl.saxon.output.Outputter

checkAttributePrefix, close, copyNamespaceNode, getEmitter, getOutputProperties, open, reset, setEscaping, thereIsAnOpenStartTag, write, writeAttribute, writeAttribute, writeComment, writeContent, writeContent, writeEndTag, writeNamespaceDeclaration, writePI, writeStartTag

Constructor Details

StringOutputter

public StringOutputter(StringBuffer buffer)

Method Details

checkAttributePrefix

public int checkAttributePrefix(int nameCode)
            throws TransformerException
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.
Overrides:
checkAttributePrefix in interface Outputter

close

public void close()
            throws TransformerException
Close the output
Overrides:
close in interface Outputter

copyNamespaceNode

public void copyNamespaceNode(int nscode)
            throws TransformerException
Copy a namespace node to the current element node (Rules defined in XSLT 1.0 errata)
Overrides:
copyNamespaceNode in interface Outputter

getOutputProperties

public Properties getOutputProperties()
Overrides:
getOutputProperties in interface Outputter

reset

public void reset()
            throws TransformerException
Overrides:
reset in interface Outputter

setErrorListener

public void setErrorListener(ErrorListener listener)

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.
Overrides:
thereIsAnOpenStartTag in interface Outputter

write

public void write(String s)
            throws TransformerException
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().
Overrides:
write in interface Outputter

writeAttribute

public void writeAttribute(int nameCode,
                           String value,
                           boolean noEscape)
            throws TransformerException
Output an attribute value.
No-op in this implementation.
Overrides:
writeAttribute in interface Outputter

Parameters:
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.

writeComment

public void writeComment(String comment)
            throws TransformerException
Write a comment. No-op in this implementation
Overrides:
writeComment in interface Outputter

writeContent

public void writeContent(String s)
            throws TransformerException
Produce text content output.
Special characters are escaped using XML/HTML conventions if the output format requires it.
Overrides:
writeContent in interface Outputter

Parameters:
s - The String to be output

writeContent

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

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

writeEndTag

public void writeEndTag(int nameCode)
            throws TransformerException
Output an element end tag.
Overrides:
writeEndTag in interface Outputter

Parameters:
nameCode - The element name code

writeNamespaceDeclaration

public void writeNamespaceDeclaration(int nscode)
            throws TransformerException
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.
Overrides:
writeNamespaceDeclaration in interface Outputter

Parameters:
nscode - The namespace code

writePI

public void writePI(String target,
                    String data)
            throws TransformerException
Write a processing instruction No-op in this implementation
Overrides:
writePI in interface Outputter

writeStartTag

public void writeStartTag(int nameCode)
            throws TransformerException
Output an element start tag. With this outputter, this is a recoverable error.
Overrides:
writeStartTag in interface Outputter

Parameters:
nameCode - The element name code

Overview Package Tree Index Deprecated About