oracle.ifs.server.renderers

Class XmlRenderer

java.lang.Object

oracle.ifs.server.renderers.XmlRenderer

All Implemented Interfaces:

Renderer

Direct Known Subclasses:

SimpleXmlRenderer

public abstract class XmlRenderer
extends Object
implements Renderer

An XMLRenderer creates a representation of a LibraryObject in XML format. Classes which extend XMLRenderer convert a given LibraryObject into an XMLDocument representation. XMLRenderer itself converts the XMLDocument into a InputStream or Reader.

XMLRenderer uses the options hashtable specify the requested character encoding for the output data. If no encoding is specified, the default encoding from the session's Localizer is used. Like all Renderers, an XMLRenderer must provide a constructor with the following signature: XMLRenderer(S_LibrarySession) throws IfsException.

Version:

1.0

Author:

Josh Sacks

(Unpublished)

Field Summary

Fields

Modifier and Type	Field and Description
static String	CHAR_ENCODING The hashtable key for specifying a character encoding to the renderAsStream method.
protected Localizer	m_Localizer The localizer from the session which created this XMLRenderer

Constructor Summary

Constructors

Constructor and Description
XmlRenderer(S_LibrarySession ls) Constructs an XMLRenderer.

Method Summary

Modifier and Type	Method and Description
protected abstract Document	createTree(S_LibraryObject slo, Hashtable options) Creates a DOM tree representing the S_LibraryObject passed in.
Reader	renderAsReader(S_LibraryObject slo, Hashtable options) Renders the specified LibraryObject as a Reader.
InputStream	renderAsStream(S_LibraryObject slo, Hashtable options) Renders the specified LibraryObject as an InputStream.
String	renderAsString(S_LibraryObject slo, Hashtable options) Renders the specified LibraryObject as a String.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CHAR_ENCODING

public static final String CHAR_ENCODING

The hashtable key for specifying a character encoding to the renderAsStream method. The key's value must be a String.

See Also:

Constant Field Values

(Published)

m_Localizer

protected Localizer m_Localizer

The localizer from the session which created this XMLRenderer

(Unpublished)

Constructor Detail

XmlRenderer

public XmlRenderer(S_LibrarySession ls)
            throws IfsException

Constructs an XMLRenderer.

Parameters:

ls - The LibrarySession constructing the XMLRenderer

Throws:

IfsException - thrown if the operation failed

(Published)

Method Detail

renderAsStream

public final InputStream renderAsStream(S_LibraryObject slo,
                                        Hashtable options)
                                 throws IfsException

Renders the specified LibraryObject as an InputStream.

Specified by:

renderAsStream in interface Renderer

Parameters:

slo - The object to be rendered

options - A hashtable containing options configuring rendering

Returns:

the InputStream

Throws:

IfsException - thrown if the operation fails

(Published)

renderAsReader

public final Reader renderAsReader(S_LibraryObject slo,
                                   Hashtable options)
                            throws IfsException

Renders the specified LibraryObject as a Reader.

Specified by:

renderAsReader in interface Renderer

Parameters:

slo - The object to be rendered

options - A hashtable containing options configuring rendering

Returns:

the Reader

Throws:

IfsException - thrown if the operation fails

(Published)

renderAsString

public final String renderAsString(S_LibraryObject slo,
                                   Hashtable options)
                            throws IfsException

Renders the specified LibraryObject as a String.

Parameters:

slo - The object to be rendered

options - A hashtable containing options configuring rendering

Returns:

the String

Throws:

IfsException - thrown if the operation fails

(Published)

createTree

protected abstract Document createTree(S_LibraryObject slo,
                                       Hashtable options)
                                throws IfsException

Creates a DOM tree representing the S_LibraryObject passed in.

XMLRenderer will renderer the returned XMLDocument. The options available are:

CHARACTER_SET

Sets the character encoding for this document

Parameters:

slo - the object to be rendered

options - the options table- see method description

Returns:

the XMLDocument to render

Throws:

IfsException - thrown if an error occured during this operation

(Published)