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

  • 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()
      Description copied from interface: OutputFormat
      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)
      Description copied from interface: OutputFormat
      Sets the character encoding.
      Specified by:
      setEncoding in interface OutputFormat
      Parameters:
      encoding - the character encoding
      See Also:

    • 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:
      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 interface OutputFormat
      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(String version)
      Sets the version of the XML output (eg "1.0")
      Specified by:
      setVersion in interface OutputFormat
      Parameters:
      version - , the xml version to output
      Predefined output methods are: xml, html, and text