Package org.exolab.adaptx.xslt
Class XSLOutput
- java.lang.Object
-
- org.exolab.adaptx.xslt.XSLObject
-
- org.exolab.adaptx.xslt.XSLOutput
-
- All Implemented Interfaces:
OutputFormat
public class XSLOutput extends XSLObject implements OutputFormat
A class for maintaining state information for the output of the XSL result tree- Since:
- XSLT 19990813 (XSL:P version 19990928)
- Version:
- $Revision: 4773 $ $Date: 2004-09-28 20:39:18 +0200 (Tue, 28 Sep 2004) $
- Author:
- Keith Visco
-
-
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
Constructors Constructor Description XSLOutput()
Creates a new Output with the given parent Stylesheet
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description XSLOutput
copy()
Creates a new copy of this XSLOutputjava.lang.String
getDoctypePublicId()
Returns the Public Id that should be used for the Doctypejava.lang.String
getDoctypeSystemId()
Returns the System Id that should be used in the Doctypejava.lang.String
getEncoding()
Returns the specified encoding, or null if no encoding was specified.boolean
getIndent()
Returns whether or not indenting the result is allowedjava.lang.String
getMethod()
Returns the output method
Predefined output methods are: xml, html, and textboolean
getOmitXMLDeclaration()
Returns whether or not the XML declaration should be supressed when serializing the resultjava.lang.String
getVersion()
Returns the XML version that should be output during serialization of the result treevoid
merge(XSLOutput output)
Merges the given XSLOutput object into this one.void
setDoctypePublicId(java.lang.String publicId)
Sets the Public Id that should be used for the Doctypevoid
setDoctypeSystemId(java.lang.String systemId)
Sets the System ID that should be used in the Doctypevoid
setEncoding(java.lang.String encoding)
Sets the character encoding.void
setIndent(boolean allowIndentation)
Returns whether or not indenting the result is allowedvoid
setMethod(java.lang.String method)
Sets the output methodvoid
setOmitXMLDeclaration(boolean omitDeclaration)
Sets whether or not the XML declaration should be supressed when serializing the resultvoid
setVersion(java.lang.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
-
-
-
-
Method Detail
-
copy
public XSLOutput copy()
Creates a new copy of this XSLOutput- Returns:
- the new XSLOutput
-
getDoctypePublicId
public java.lang.String getDoctypePublicId()
Returns the Public Id that should be used for the Doctype- Specified by:
getDoctypePublicId
in interfaceOutputFormat
- Returns:
- the Public Id that should be used for the Doctype, or null if none has been set
-
getDoctypeSystemId
public java.lang.String getDoctypeSystemId()
Returns the System Id that should be used in the Doctype- Specified by:
getDoctypeSystemId
in interfaceOutputFormat
- Returns:
- the System Id that should be used for the Doctype, or null if none has been set
-
getEncoding
public java.lang.String getEncoding()
Description copied from interface:OutputFormat
Returns the specified encoding, or null if no encoding was specified.- Specified by:
getEncoding
in interfaceOutputFormat
- 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 interfaceOutputFormat
- Returns:
- true if whitespace may be added to the output result for indentation and readability, otherwise returns false
-
getMethod
public java.lang.String getMethod()
Returns the output method
Predefined output methods are: xml, html, and text- Specified by:
getMethod
in interfaceOutputFormat
- 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 interfaceOutputFormat
- Returns:
- true if the XML declaration should be supressed when serializing the result
-
getVersion
public java.lang.String getVersion()
Returns the XML version that should be output during serialization of the result tree- Specified by:
getVersion
in interfaceOutputFormat
- 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(java.lang.String publicId)
Sets the Public Id that should be used for the Doctype- Specified by:
setDoctypePublicId
in interfaceOutputFormat
- Parameters:
publicId
- the Public Id that should be used for the Doctype
-
setDoctypeSystemId
public void setDoctypeSystemId(java.lang.String systemId)
Sets the System ID that should be used in the Doctype- Specified by:
setDoctypeSystemId
in interfaceOutputFormat
- Parameters:
systemId
- the System ID for the Doctype
-
setEncoding
public void setEncoding(java.lang.String encoding)
Description copied from interface:OutputFormat
Sets the character encoding.- Specified by:
setEncoding
in interfaceOutputFormat
- Parameters:
encoding
- the character encoding- See Also:
OutputFormat.getEncoding()
-
setIndent
public void setIndent(boolean allowIndentation)
Returns whether or not indenting the result is allowed- Specified by:
setIndent
in interfaceOutputFormat
-
setMethod
public void setMethod(java.lang.String method)
Sets the output method- Specified by:
setMethod
in interfaceOutputFormat
- Parameters:
method
- , the output method of this xsl:output object
Predefined output methods are: xml, html, and text
-
setOmitXMLDeclaration
public void setOmitXMLDeclaration(boolean omitDeclaration)
Sets whether or not the XML declaration should be supressed when serializing the result- Specified by:
setOmitXMLDeclaration
in interfaceOutputFormat
- Parameters:
omitDeclaration
- , the flag indicating whether or not the XML declaration should be supressed when serializing the result. Use true if you do NOT want the XML Declaration to appear in the output. The default value depends on the Method. If the method is "xml", this value will be false by default. If the method is "html", this value will be true by default.
-
setVersion
public void setVersion(java.lang.String version)
Sets the version of the XML output (eg "1.0")- Specified by:
setVersion
in interfaceOutputFormat
- Parameters:
version
- , the xml version to output
Predefined output methods are: xml, html, and text
-
-