|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.icl.saxon.output.Outputter
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.
Field Summary | |
protected Emitter |
emitter
|
Constructor Summary | |
Outputter()
|
Method Summary | |
abstract int |
checkAttributePrefix(int nameCode)
Check that the prefix for an attribute is acceptable, returning a substitute prefix if not. |
abstract void |
close()
Close the output |
abstract void |
copyNamespaceNode(int nscode)
Copy a namespace node to the current element node (Rules defined in XSLT 1.0 errata) |
Emitter |
getEmitter()
Get emitter. |
abstract java.util.Properties |
getOutputProperties()
|
void |
open()
Start the output process |
abstract void |
reset()
Synchronize the state of the Outputter with that of the underlying Emitter |
void |
setEscaping(boolean escaping)
Switch escaping (of special characters) on or off. |
abstract boolean |
thereIsAnOpenStartTag()
Test whether there is an open start tag. |
abstract void |
write(java.lang.String s)
Produce literal output. |
void |
writeAttribute(int nameCode,
java.lang.String value)
Output an attribute value. |
abstract void |
writeAttribute(int nameCode,
java.lang.String value,
boolean noEscape)
Output an attribute value. |
abstract void |
writeComment(java.lang.String comment)
Write a comment |
abstract void |
writeContent(char[] chars,
int start,
int length)
Produce text content output. |
abstract void |
writeContent(java.lang.String s)
Produce text content output. |
abstract void |
writeEndTag(int nameCode)
Output an element end tag. |
abstract void |
writeNamespaceDeclaration(int nscode)
Output a namespace declaration. |
abstract void |
writePI(java.lang.String target,
java.lang.String data)
Write a processing instruction |
abstract void |
writeStartTag(int nameCode)
Output an element start tag. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
protected Emitter emitter
Constructor Detail |
public Outputter()
Method Detail |
public Emitter getEmitter() throws javax.xml.transform.TransformerException
public abstract void reset() throws javax.xml.transform.TransformerException
public abstract java.util.Properties getOutputProperties()
public final void setEscaping(boolean escaping) throws javax.xml.transform.TransformerException
escaping:
- true if special characters are to be escaped, false if not.public final void open() throws javax.xml.transform.TransformerException
public abstract void write(java.lang.String s) throws javax.xml.transform.TransformerException
public abstract void writeContent(java.lang.String s) throws javax.xml.transform.TransformerException
s
- The String to be outputjavax.xml.transform.TransformerException
- for any failurepublic abstract void writeContent(char[] chars, int start, int length) throws javax.xml.transform.TransformerException
chars
- Character array to be outputstart
- start position of characters to be outputlength
- number of characters to be outputjavax.xml.transform.TransformerException
- for any failurepublic abstract void writeStartTag(int nameCode) throws javax.xml.transform.TransformerException
nameCode
- The element name codepublic abstract int checkAttributePrefix(int nameCode) throws javax.xml.transform.TransformerException
public abstract void writeNamespaceDeclaration(int nscode) throws javax.xml.transform.TransformerException
nscode
- The namespace codejavax.xml.transform.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.public abstract void copyNamespaceNode(int nscode) throws javax.xml.transform.TransformerException
public abstract boolean thereIsAnOpenStartTag()
public void writeAttribute(int nameCode, java.lang.String value) throws javax.xml.transform.TransformerException
nameCode
- The name code of the attributevalue
- The value of the attributejavax.xml.transform.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.public abstract void writeAttribute(int nameCode, java.lang.String value, boolean noEscape) throws javax.xml.transform.TransformerException
name
- The name of the attributevalue
- The value of the attributenoEscape
- True if it's known there are no special characters in the value. If
unsure, set this to false.javax.xml.transform.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.public abstract void writeEndTag(int nameCode) throws javax.xml.transform.TransformerException
nameCode
- The element name codepublic abstract void writeComment(java.lang.String comment) throws javax.xml.transform.TransformerException
public abstract void writePI(java.lang.String target, java.lang.String data) throws javax.xml.transform.TransformerException
public abstract void close() throws javax.xml.transform.TransformerException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |