org.exolab.adaptx.xslt

Class XSLOutput

Implemented Interfaces:
OutputFormat

public class XSLOutput
extends XSLObject
implements OutputFormat

A class for maintaining state information for the output of the XSL result tree
Version:
$Revision: 4773 $ $Date: 2004-09-28 14:39:18 -0400 (Tue, 28 Sep 2004) $
Author:
Keith Visco
Since:
XSLT 19990813 (XSL:P version 19990928)

Field Summary

Fields inherited from class org.exolab.adaptx.xslt.XSLObject

APPLY_IMPORTS, APPLY_TEMPLATES, ARG, ATTRIBUTE, ATTRIBUTE_SET, CALL_TEMPLATE, CDATA, CHOOSE, COMMENT, CONTENTS, COPY, COPY_OF, ELEMENT, ENTITY_REF, FOR_EACH, FUNCTIONS, ID, IF, IMPORT, INCLUDE, KEY, LITERAL, LOCALE, MESSAGE, NUMBER, OTHERWISE, OUTPUT, PARAM, PI, PRESERVE_SPACE, SCRIPT, SORT, STRIP_SPACE, STYLESHEET, TEMPLATE, TEXT, VALUE_OF, VARIABLE, WHEN, WITH_PARAM

Constructor Summary

XSLOutput()
Creates a new Output with the given parent Stylesheet

Method Summary

XSLOutput
copy()
Creates a new copy of this XSLOutput
String
getDoctypePublicId()
Returns the Public Id that should be used for the Doctype
String
getDoctypeSystemId()
Returns the System Id that should be used in the Doctype
String
getEncoding()
Returns the specified encoding, or null if no encoding was specified.
boolean
getIndent()
Returns whether or not indenting the result is allowed
String
getMethod()
Returns the output method
Predefined output methods are: xml, html, and text
boolean
getOmitXMLDeclaration()
Returns whether or not the XML declaration should be supressed when serializing the result
String
getVersion()
Returns the XML version that should be output during serialization of the result tree
void
merge(XSLOutput output)
Merges the given XSLOutput object into this one.
void
setDoctypePublicId(String publicId)
Sets the Public Id that should be used for the Doctype
void
setDoctypeSystemId(String systemId)
Sets the System ID that should be used in the Doctype
void
setEncoding(String encoding)
Sets the character encoding.
void
setIndent(boolean allowIndentation)
Returns whether or not indenting the result is allowed
void
setMethod(String method)
Sets the output method
void
setOmitXMLDeclaration(boolean omitDeclaration)
Sets whether or not the XML declaration should be supressed when serializing the result
void
setVersion(String version)
Sets the version of the XML output (eg "1.0")

Methods inherited from class org.exolab.adaptx.xslt.XSLObject

addNamespaceDecl, appendAction, appendText, appendText, getActions, getAttribute, getAttributes, getNamespace, getNearestAncestor, getNodeValue, getStylesheet, getText, getType, getTypeFromName, getTypeName, resolveNamespace, setAllowActions, setAttribute, setNamespace, setTypeName

Constructor Details

XSLOutput

public XSLOutput()
Creates a new Output with the given parent Stylesheet

Method Details

copy

public XSLOutput copy()
Creates a new copy of this XSLOutput
Returns:
the new XSLOutput

getDoctypePublicId

public String getDoctypePublicId()
Returns the Public Id that should be used for the Doctype
Specified by:
getDoctypePublicId in interface OutputFormat
Returns:
the Public Id that should be used for the Doctype, or null if none has been set

getDoctypeSystemId

public String getDoctypeSystemId()
Returns the System Id that should be used in the Doctype
Specified by:
getDoctypeSystemId in interface OutputFormat
Returns:
the System Id that should be used for the Doctype, or null if none has been set

getEncoding

public String getEncoding()
Returns the specified encoding, or null if no encoding was specified.
Specified by:
getEncoding in interface OutputFormat
Returns:
the encoding, or null if no encoding specified.

getIndent

public boolean getIndent()
Returns whether or not indenting the result is allowed
Specified by:
getIndent in interface OutputFormat
Returns:
true if whitespace may be added to the output result for indentation and readability, otherwise returns false

getMethod

public String getMethod()
Returns the output method
Predefined output methods are: xml, html, and text
Specified by:
getMethod in interface OutputFormat
Returns:
the output method

getOmitXMLDeclaration

public boolean getOmitXMLDeclaration()
Returns whether or not the XML declaration should be supressed when serializing the result
Specified by:
getOmitXMLDeclaration in interface OutputFormat
Returns:
true if the XML declaration should be supressed when serializing the result

getVersion

public String getVersion()
Returns the XML version that should be output during serialization of the result tree
Specified by:
getVersion in interface OutputFormat
Returns:
the XML version that should be used during serialization of of the result tree

merge

public void merge(XSLOutput output)
Merges the given XSLOutput object into this one. Any attributes already existing in this XSLOutput will be over-written with the ones from the given XSLOutput.
Parameters:
output - the XSLOutput to merge with this one.

setDoctypePublicId

public void setDoctypePublicId(String publicId)
Sets the Public Id that should be used for the Doctype
Specified by:
setDoctypePublicId in interface OutputFormat
Parameters:
publicId - the Public Id that should be used for the Doctype

setDoctypeSystemId

public void setDoctypeSystemId(String systemId)
Sets the System ID that should be used in the Doctype
Specified by:
setDoctypeSystemId in interface OutputFormat
Parameters:
systemId - the System ID for the Doctype

setEncoding

public void setEncoding(String encoding)
Sets the character encoding.
Specified by:
setEncoding in interface OutputFormat
Parameters:
encoding - the character encoding

setIndent

public void setIndent(boolean allowIndentation)
Returns whether or not indenting the result is allowed
Specified by:
setIndent in interface OutputFormat

setMethod

public void setMethod(String method)
Sets the output method
Specified by:
setMethod in interface OutputFormat
Parameters:

setOmitXMLDeclaration

public void setOmitXMLDeclaration(boolean omitDeclaration)
Sets whether or not the XML declaration should be supressed when serializing the result
Specified by:
setOmitXMLDeclaration in interface OutputFormat
Parameters:

setVersion

public void setVersion(String version)
Sets the version of the XML output (eg "1.0")
Specified by:
setVersion in interface OutputFormat
Parameters: