This class allows output to be generated. It channels output requests to an
Emitter which does the actual writing.
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.
- checkAttributePrefix in interface Outputter
close
public void close()
throws TransformerException
Close the output
- 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)
- copyNamespaceNode in interface Outputter
flushStartTag
protected void flushStartTag()
throws TransformerException
Flush out a pending start tag
getOutputProperties
public Properties getOutputProperties()
- getOutputProperties in interface Outputter
makeEmitter
public Emitter makeEmitter(Properties props,
Result result)
throws TransformerException
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)
throws TransformerException
Create a new FileOutputStream, given a filename and a baseURI
reset
public void reset()
throws TransformerException
Synchronize the state of the Outputter with that of the underlying Emitter
- reset in interface Outputter
setOutputDestination
public void setOutputDestination(Properties props,
Result result)
throws TransformerException
Initialise the outputter for a new output destination, supplying
the output format details.
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.
- thereIsAnOpenStartTag in interface Outputter
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)
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().
- write in interface Outputter
writeAttribute
public void writeAttribute(int nameCode,
String value)
throws TransformerException
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.
- writeAttribute in interface Outputter
nameCode
- The name code of the attributevalue
- The value of the attribute
writeAttribute
public void writeAttribute(int nameCode,
String value,
boolean noEscape)
throws TransformerException
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.
- writeAttribute in interface Outputter
value
- The value of the attributenoEscape
- 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
- 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.
- writeContent in interface Outputter
s
- The String to be output
writeContent
public void writeContent(StringBuffer chars,
int start,
int len)
throws TransformerException
Produce text content output.
Special characters are escaped using XML/HTML conventions if the output format
requires it.
chars
- StringBuffer containing to be outputstart
- start position of characters to be outputlen
- number of characters 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.
- writeContent in interface Outputter
chars
- Character array to be outputstart
- start position of characters to be outputlength
- number of characters to be output
writeEndTag
public void writeEndTag(int nameCode)
throws TransformerException
Output an element end tag.
- writeEndTag in interface Outputter
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.
- writeNamespaceDeclaration in interface Outputter
nscode
- The namespace code
writePI
public void writePI(String target,
String data)
throws TransformerException
Write a processing instruction
- writePI in interface Outputter
writeStartTag
public void writeStartTag(int nameCode)
throws TransformerException
Output an element start tag.
The actual output of the tag is deferred until all attributes have been output
using writeAttribute().
- writeStartTag in interface Outputter
nameCode
- The element name code