|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--oracle.ifs.server.renderers.XmlRenderer
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
.
Field Summary | |
static java.lang.String |
CHAR_ENCODING
The hashtable key for specifying a character encoding to the renderAsStream method. |
Constructor Summary | |
XmlRenderer(S_LibrarySession ls)
Constructs an XMLRenderer. |
Method Summary | |
protected abstract oracle.xml.parser.v2.XMLDocument |
createTree(S_LibraryObject slo,
java.util.Hashtable options)
Creates a DOM tree representing the S_LibraryObject passed in. |
java.io.Reader |
renderAsReader(S_LibraryObject slo,
java.util.Hashtable options)
Renders the specified LibraryObject as a Reader. |
java.io.InputStream |
renderAsStream(S_LibraryObject slo,
java.util.Hashtable options)
Renders the specified LibraryObject as an InputStream. |
java.lang.String |
renderAsString(S_LibraryObject slo,
java.util.Hashtable options)
Renders the specified LibraryObject as a String. |
Field Detail |
public static final java.lang.String CHAR_ENCODING
Constructor Detail |
public XmlRenderer(S_LibrarySession ls) throws IfsException
ls
- The LibrarySession constructing the XMLRendererIfsException
- thrown if the operation failedMethod Detail |
public final java.io.InputStream renderAsStream(S_LibraryObject slo, java.util.Hashtable options) throws IfsException
renderAsStream
in interface Renderer
slo
- The object to be renderedoptions
- A hashtable containing options configuring renderingIfsException
- thrown if the operation failspublic final java.io.Reader renderAsReader(S_LibraryObject slo, java.util.Hashtable options) throws IfsException
renderAsReader
in interface Renderer
slo
- The object to be renderedoptions
- A hashtable containing options configuring renderingIfsException
- thrown if the operation failspublic final java.lang.String renderAsString(S_LibraryObject slo, java.util.Hashtable options) throws IfsException
slo
- The object to be renderedoptions
- A hashtable containing options configuring renderingIfsException
- thrown if the operation failsprotected abstract oracle.xml.parser.v2.XMLDocument createTree(S_LibraryObject slo, java.util.Hashtable options) throws IfsException
XMLRenderer will renderer the returned XMLDocument. The options available are:
slo
- the object to be renderedoptions
- the options table- see method descriptionIfsException
- thrown if an error occured during this
operation
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |