okapi.coreobjects
Class OkapiView

java.lang.Object
  okapi.coreobjects.OkapiView

All Implemented Interfaces:

java.io.Serializable

public class OkapiView
extends java.lang.Object
implements java.io.Serializable

OkapiView style sheet specification object. OkapiView is the object which defines an association between a style sheet, an OkapiToolRenderer which uses that style sheet, and the specification of the output from that style sheet

Version:

$Revision: 31044 $, $Date: 2008-09-02 17:08:01 -0400 (Tue, 02 Sep 2008) $

Author:

MIT Stellar team

See Also:

Serialized Form

Field Summary

java.lang.String	description Textual description to guide web site designer in choosing which styles from the library to use or make available.
java.lang.String	language Language for this style, in standard form, e.g.
java.lang.String	media media type for which this style is optimized, e.g.
java.lang.String	mimeType mime-type produced by this style.
OkapiToolRenderer	renderer ToolRenderer capable of using this style.
java.lang.String	style Style designation.
java.util.Map	styleStores Style stores.

Constructor Summary

OkapiView(int viewCode)
Return the View for this viewCode

OkapiView(OkapiToolRenderer renderer, java.lang.String style, java.util.Map styleStores, java.lang.String language, java.lang.String mimeType, java.lang.String media, java.lang.String description)
Create new fully defined View.

OkapiView(OkapiToolRenderer renderer, java.lang.String style, java.lang.String mimeType, java.lang.String description)
Create new minimally defined View.

OkapiView(OkapiToolRenderer renderer, java.lang.String style, java.lang.String language, java.lang.String mimeType, java.lang.String media, java.lang.String description)
Create new fully defined View without style stores.

Method Summary

java.lang.String	getAsXml(java.util.Map options) Method getAsXml
java.lang.String	getAsXml(java.util.Map options, int indent) Method getAsXml
java.lang.String	getAsXml(java.util.Map options, java.lang.String tag) Method getAsXml
java.lang.String	getAsXml(java.util.Map options, java.lang.String tag, int indent) Returns an xml representation of this object, with the options defined by the options map, an element of type tag surrounding the xml, and the first line indented indent times.
int	getViewCode() Return viewCode of this View
void	setDataSource(javax.sql.DataSource dataSource) Set the dataSource to be used for data access.

Methods inherited from class java.lang.Object

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

Field Detail

renderer

public OkapiToolRenderer renderer

ToolRenderer capable of using this style.

style

public java.lang.String style

Style designation. May be the name of a style sheet file or a symbolic name.

styleStores

public java.util.Map styleStores

Style stores. May be used to store particular style sheets. Usage, keys, contents of the store are all Renderer dependent.

language

public java.lang.String language

Language for this style, in standard form, e.g. en, fr-CA, etc.

mimeType

public java.lang.String mimeType

mime-type produced by this style.

media

public java.lang.String media

media type for which this style is optimized, e.g. browser, netscape, explorer, avantgo, webtv

description

public java.lang.String description

Textual description to guide web site designer in choosing which styles from the library to use or make available.

Constructor Detail

OkapiView

public OkapiView(OkapiToolRenderer renderer,
                 java.lang.String style,
                 java.util.Map styleStores,
                 java.lang.String language,
                 java.lang.String mimeType,
                 java.lang.String media,
                 java.lang.String description)

Create new fully defined View.

OkapiView

public OkapiView(OkapiToolRenderer renderer,
                 java.lang.String style,
                 java.lang.String language,
                 java.lang.String mimeType,
                 java.lang.String media,
                 java.lang.String description)

Create new fully defined View without style stores.

OkapiView

public OkapiView(OkapiToolRenderer renderer,
                 java.lang.String style,
                 java.lang.String mimeType,
                 java.lang.String description)

Create new minimally defined View.

OkapiView

public OkapiView(int viewCode)

Return the View for this viewCode

Method Detail

getViewCode

public int getViewCode()

Return viewCode of this View

getAsXml

public java.lang.String getAsXml(java.util.Map options,
                                 java.lang.String tag,
                                 int indent)

Returns an xml representation of this object, with the options defined by the options map, an element of type tag surrounding the xml, and the first line indented indent times. See OkapiObject.getAsXml(String tag, int indent) for more information about using the getAsXml methods.

getAsXml

public java.lang.String getAsXml(java.util.Map options,
                                 java.lang.String tag)

Method getAsXml

Parameters:

options -

tag -

Returns:

String

getAsXml

public java.lang.String getAsXml(java.util.Map options,
                                 int indent)

Method getAsXml

Parameters:

options -

indent -

Returns:

String

getAsXml

public java.lang.String getAsXml(java.util.Map options)

Method getAsXml

Parameters:

options -

Returns:

String

setDataSource

public void setDataSource(javax.sql.DataSource dataSource)

Set the dataSource to be used for data access.

Parameters:

dataSource -