oracle.dss.thin.beans.dataView
Class ThinDataview

java.lang.Object
  |
  +--oracle.dss.thin.beans.dataView.ThinDataview

All Implemented Interfaces:

CheckpointState, ComponentTypeConverter, DataviewCommon, ErrorHandlerCallback, Persistable, StringXMLizable, ThinBean, ThinBeanUI, ThinDataviewCommon

Direct Known Subclasses:

ThinGridView

public abstract class ThinDataview

extends java.lang.Object

implements ThinDataviewCommon, ErrorHandlerCallback, ComponentTypeConverter, Persistable

Base for ThinGridView objects. Application developers normally work with the concrete subclasses of this class. However, application developers will call some of these methods in the concrete subclasses.

The ThinDataviewCommon interface documents the events that the ThinDataview handles and generates.

See Also:

ThinDataviewCommon

Fields inherited from interface oracle.dss.thin.beans.dataView.ThinDataviewCommon

INLINE_ERROR_MSG, INLINE_INFO_MSG, INLINE_WARNING_MSG

Fields inherited from interface oracle.dss.thin.beans.ThinBeanUI

EVENT_HANDLED, EVENT_NOT_HANDLED, EVENT_RESPONSE_DONE

Constructor Summary

ThinDataview()
Constructor.

Method Summary

void	addDataListener(DataListener l) Adds a listener for changes to data, such as drilling or pivoting data.
void	addErrorHandler(ErrorHandler eh) Specifies the error handler for this view.
void	addThinViewListener(ThinViewListener l) Adds a listener for ThinDataviewCommon events, such as export events and save events.
void	cleanUp() Clears the memory of this view.
DataDirector	getDataDirector() Retrieves the data director for this view.
DataSource	getDataSource() Retrieves the data source for this view.
DataviewTitles	getDataviewFootnote() Retrieves the Footnote for this ThinDataviewCommon.
DataviewTitles	getDataviewSubtitle() Retrieves the Subtitle for this ThinDataviewCommon.
DataviewTitles	getDataviewTitle() Retrieves the Title for this ThinDataviewCommon.
java.lang.String	getDescription() Retrieves the description of this view.
ErrorHandler	getErrorHandler() Retrieves the current error handler for this view.
EventTarget	getEventTarget(java.lang.String event) Retrieves the event target for the specified event.
java.lang.String	getExportCharacterEncoding() Retrieves the character encoding that this ThinDataviewCommon uses when it exports its data.
int	getHTMLPagingControlWidth() Retrieves the number of page items that are displayed before the paging control wraps.
java.lang.String	getInlineMessage() Retrieves the inline message text to display.
int	getInlineMessageType() Retrieves the type of inline message to display.
java.util.Locale	getLocale() Retrieves the Locale that this ThinDataviewCommon uses.
java.lang.String	getLocalName() Retrieves the local name for this view.
Model	getModel() Retrieves the model for this DataviewCommon.
java.lang.String	getName() Retrieves the name of this view.
PagingControl	getPagingControl() Retrieves the paging control for this view.
int	getPagingControlPosition() Retrieves the location of the paging control in this ThinDataviewCommon.
abstract PersistableAttributes	getPersistableAttributes(PersistableAttributes attrs) Retrieves the attributes of this ThinDataview, for searching.
AggregateInfo[]	getPersistableComponents() Retrieves the persistable components that this Dataview aggregates.
java.lang.String	getThinBeanName() Retrieves the unique name of this thin bean.
TokenSubstitution	getTokenSubstitution() Retrieves the handler for token substitution in this view.
abstract int	getViewType() Retrieves the type of view that implements this ThinDataviewCommon.
java.lang.String	getXML(boolean allProperties) Retrieves the XML string for this ThinDataview.
java.lang.String	getXMLAsString() Retrieves the XML representation of this ThinDataview.
int	handleEvent(QueryParameterProvider provider) Handles a thin-bean event.
void	initialize(java.util.Hashtable env) Persistable interface
boolean	isDrillingEnabled() Indicates whether drilling is allowed in this view.
boolean	isEnabled() Indicates whether this ThinDataviewCommon is enabled.
boolean	isExternalFootnoteVisible() Indicates whether a footnote appears outside the view.
boolean	isExternalSubtitleVisible() Indicates whether a subtitle appears outside the view.
boolean	isExternalTitleVisible() Indicates whether a title appears outside the view.
boolean	isHTMLPagingControlAutosubmit() Indicates whether changes made in the paging control are automatically submitted to the data source.
boolean	isPagingControlVisible() Indicates whether the paging control appears in this view.
boolean	isPropertyOverrideFlag(int attrID, java.util.BitSet overrideFlags)
boolean	isXMLValidated() Indicates whether the view validates XML against its DTD.
abstract boolean	readXML(java.io.InputStream stream, int reset) Applies XML to this ThinDataview, from a String.
void	removeDataListener(DataListener l) Removes a listener for data events.
void	removeErrorHandler() Removes a customized error handler for this view.
void	removeThinViewListener(ThinViewListener l) Removes a listener for ThinDataviewCommon events.
void	resetToDefault(int reset) Resets properties of this ThinDataview to their default values.
void	setDataSource(DataSource ds) Specifies the data source for this view.
void	setDescription(java.lang.String n) Specifies a description for this view.
void	setDrillingEnabled(boolean b) Specifies whether drilling is allowed in this view.
void	setEnabled(boolean enabled) Specifies whether this ThinDataviewCommon is enabled.
void	setEventTarget(java.lang.String event, EventTarget target) Specifies an event target for an event that this ThinBeanUI generates.
void	setExportCharacterEncoding(java.lang.String encoding) Specifies the character encoding to use when exporting the view.
void	setExternalFootnoteVisible(boolean b) Specifies whether a footnote for this ThinDataviewCommon appears outside the view.
void	setExternalSubtitleVisible(boolean b) Specifies whether a subtitle for this ThinDataviewCommon appears outside the view.
void	setExternalTitleVisible(boolean b) Specifies whether a title for this ThinDataviewCommon appears outside the view.
void	setHTMLPagingControlAutosubmit(boolean autosubmit) Specifies whether changes made in the paging control are automatically submitted to the data source.
void	setHTMLPagingControlWidth(int width) Specifies the number of page items that are displayed before the paging control wraps to a new line.
void	setInlineMessage(java.lang.String msg) Specifies the inline message text to display.
void	setInlineMessageType(int type) Specifies the type of temporary inline message to display.
void	setLocale(java.util.Locale loc) Specifies the Locale for this ThinDataviewCommon.
void	setLocalName(java.lang.String n) Specifies a local name for this view.
void	setName(java.lang.String n) Specifies the name of this view.
void	setPagingControlPosition(int loc) Specifies the location of the paging control in this ThinDataviewCommon.
void	setPagingControlVisible(boolean v) Specifies whether the paging control appears in this view.
void	setPersistableAttributes(PersistableAttributes attrs) Specifies persistable attributes that can be used in searches of the BI Beans Catalog.
void	setPersistableComponents(AggregateInfo[] persistables) Specifies the list of Persistable components that this ThinDataview aggregates.
void	setThinBeanName(java.lang.String thinBeanName) Specifies a unique name for this thin bean.
void	setTokenSubstitution(TokenSubstitution token) Specifies a handler for token substitution in this view.
abstract boolean	setXML(java.lang.String xmlString, int reset) Applies XML to this ThinDataview, from a String.
abstract boolean	setXMLAsString(java.lang.String xml) Specifies the XML representation of this ThinDataview.
void	setXMLValidated(boolean validate) Specifies whether this view validates XML against its DTD.
void	writeXML(java.io.OutputStream stream, boolean allProperties) Writes XML for this ThinDataview to an output stream.

Methods inherited from class java.lang.Object

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

Methods inherited from interface oracle.dss.thin.beans.ThinBean

getState, setBaseState, setState

Methods inherited from interface oracle.dss.rules.ComponentTypeConverter

convertComponentTypeToInteger, convertComponentTypeToString

Methods inherited from interface oracle.dss.thin.beans.CheckpointState

checkpointState, getCheckpointState, setCheckpointState

Constructor Detail

ThinDataview

public ThinDataview()

Constructor. Application developers should call the constructors of the concrete subclasses of this class. Those constructors call this constructor.

Method Detail

setThinBeanName

public void setThinBeanName(java.lang.String thinBeanName)

Description copied from interface: ThinBean

Specifies a unique name for this thin bean. You may have multiple instances of a thin bean in an application. Thin-bean events use the ThinBeanName as the value of the source query parameter, to identify the thin bean that should handle the event.

Specified by:

setThinBeanName in interface ThinBean

Following copied from interface: oracle.dss.thin.beans.ThinBean

Parameters:

thinBeanName - A unique name for this thin bean.

See Also:

BIConstants.SOURCE

getThinBeanName

public java.lang.String getThinBeanName()

Description copied from interface: ThinBean

Retrieves the unique name of this thin bean. The ThinBeanName uniquely identifies a thin bean in an application. Thin-bean events use the ThinBeanName as the value of the source query parameter, to identify the thin bean that should handle the event.

Specified by:

getThinBeanName in interface ThinBean

Following copied from interface: oracle.dss.thin.beans.ThinBean

Returns:

The name of this thin bean.

See Also:

BIConstants.SOURCE

handleEvent

public int handleEvent(QueryParameterProvider provider)
                throws ThinException

Description copied from interface: ThinBeanUI

Handles a thin-bean event. This ThinBeanUI handles events where the value of the source query parameter is the ThinBeanName for this thin bean.

You can examine the source query parameter to determine the thin bean whose handleEvent to call. Or you can call the handleEvent for each thin bean, checking the return from this method to discover which thin bean handled the event. Alternately, you can register thin beans with the ServletRequestHandler and call the handleEvent method of the ServletRequestHandler. The ServletRequestHandler will then route the event to the proper thin bean.

For more information about thin-bean events, see the BI Beans Help system.

Specified by:

handleEvent in interface ThinBeanUI

Following copied from interface: oracle.dss.thin.beans.ThinBeanUI

Parameters:

provider - The QueryParameterProvider for the HTTPServletRequest that is being handled.

Returns:

A constant that indicates whether this ThinBeanUI handled any events. Constants are listed in the See Also section.

Throws:

ThinException - If an error occurs that interrupts event handling.

See Also:

ThinBeanUI.EVENT_NOT_HANDLED, ThinBeanUI.EVENT_HANDLED, ThinBeanUI.EVENT_RESPONSE_DONE, ServletRequestHandler

setEventTarget

public void setEventTarget(java.lang.String event,
EventTarget target)

Description copied from interface: ThinBeanUI

Specifies an event target for an event that this ThinBeanUI generates. Call this method to specify the ThinBeanUI that should handle the event. You can also use event targets to direct an event to another part of your application, to change the target frame for an event, and to add application parameters to an event.

Specified by:

setEventTarget in interface ThinBeanUI

Following copied from interface: oracle.dss.thin.beans.ThinBeanUI

Parameters:

event - A constant that identifies the event to target. Valid constants are defined in the BIConstants interface and end with "_EVENT".

target - The event target that specifies the thin bean that should handle the event.

See Also:

BIConstants

getEventTarget

public EventTarget getEventTarget(java.lang.String event)

Description copied from interface: ThinBeanUI

Retrieves the event target for the specified event.

Specified by:

getEventTarget in interface ThinBeanUI

Following copied from interface: oracle.dss.thin.beans.ThinBeanUI

Parameters:

event - A constant that identifies the event whose target you want. Valid constants are defined in the BIConstants interface and end with "_EVENT".

Returns:

The event target that has been set for event.

See Also:

BIConstants

getViewType

public abstract int getViewType()

Description copied from interface: ThinDataviewCommon

Retrieves the type of view that implements this ThinDataviewCommon.

Specified by:

getViewType in interface ThinDataviewCommon

Following copied from interface: oracle.dss.thin.beans.dataView.ThinDataviewCommon

Returns:

A constant that represents the type of view. Valid constants are listed in the See Also section.

See Also:

Dataview.VIEW_TYPE_CROSSTAB, Dataview.VIEW_TYPE_GRAPH, Dataview.VIEW_TYPE_TABLE

addThinViewListener

public void addThinViewListener(ThinViewListener l)

Description copied from interface: ThinDataviewCommon

Adds a listener for ThinDataviewCommon events, such as export events and save events.

Specified by:

addThinViewListener in interface ThinDataviewCommon

Following copied from interface: oracle.dss.thin.beans.dataView.ThinDataviewCommon

Parameters:

l - The listener to add.

See Also:

ThinViewListenerAdapter

removeThinViewListener

public void removeThinViewListener(ThinViewListener l)

Description copied from interface: ThinDataviewCommon

Removes a listener for ThinDataviewCommon events.

Specified by:

removeThinViewListener in interface ThinDataviewCommon

Following copied from interface: oracle.dss.thin.beans.dataView.ThinDataviewCommon

Parameters:

l - The listener to remove.

setPagingControlPosition

public void setPagingControlPosition(int loc)

Description copied from interface: ThinDataviewCommon

Specifies the location of the paging control in this ThinDataviewCommon.

Specified by:

setPagingControlPosition in interface ThinDataviewCommon

Following copied from interface: oracle.dss.thin.beans.dataView.ThinDataviewCommon

Parameters:

loc - A constant that indicates the location for the paging control. Valid constants are listed in the See Also section. If you specify an invalid value, then this method places the paging control above the titles, as if you had set PAGING_CONTROL_ABOVE_TITLES.

See Also:

Dataview.PAGING_CONTROL_ABOVE_TITLES, Dataview.PAGING_CONTROL_BELOW_TITLES

getPagingControlPosition

public int getPagingControlPosition()

Description copied from interface: ThinDataviewCommon

Retrieves the location of the paging control in this ThinDataviewCommon.

Specified by:

getPagingControlPosition in interface ThinDataviewCommon

Following copied from interface: oracle.dss.thin.beans.dataView.ThinDataviewCommon

Returns:

A constant that indicates the location of the paging control. Constants are listed in the See Also section.

See Also:

Dataview.PAGING_CONTROL_ABOVE_TITLES, Dataview.PAGING_CONTROL_BELOW_TITLES

setInlineMessageType

public void setInlineMessageType(int type)

Description copied from interface: ThinDataviewCommon

Specifies the type of temporary inline message to display. The InlineMessage property determines the text of the message.

Note: The ThinDataviewCommon calls this method when it displays messages. Application developers can use it to display custom messages as well.

Specified by:

setInlineMessageType in interface ThinDataviewCommon

Following copied from interface: oracle.dss.thin.beans.dataView.ThinDataviewCommon

Parameters:

type - A constant that indicates the type of inline message to display. Valid constants are listed in the See Also section.

See Also:

ThinDataviewCommon.INLINE_ERROR_MSG, ThinDataviewCommon.INLINE_WARNING_MSG, ThinDataviewCommon.INLINE_INFO_MSG, ThinDataviewCommon.setInlineMessage(java.lang.String)

getInlineMessageType

public int getInlineMessageType()

Description copied from interface: ThinDataviewCommon

Retrieves the type of inline message to display. The InlineMessage property determines the text of the message. The inline message conveys errors, warnings, or informational messages that are related to actions on the view.

Note: The ThinDataviewCommon calls this method when it displays messages. Application developers can also use it in displaying custom messages.

Specified by:

getInlineMessageType in interface ThinDataviewCommon

Following copied from interface: oracle.dss.thin.beans.dataView.ThinDataviewCommon

Returns:

A constant that indicates the type of inline message to display. Valid constants are listed in the See Also section.

See Also:

ThinDataviewCommon.INLINE_ERROR_MSG, ThinDataviewCommon.INLINE_WARNING_MSG, ThinDataviewCommon.INLINE_INFO_MSG, ThinDataviewCommon.getInlineMessage()

setInlineMessage

public void setInlineMessage(java.lang.String msg)

Description copied from interface: ThinDataviewCommon

Specifies the inline message text to display. If the message is null, then no message is displayed. The message is reset to null after the message is displayed once or when the view's data source is updated. The InlineMessageType property controls the type of message.

Note: The ThinDataviewCommon calls this method when it displays messages. Application developers can also use it to display custom messages.

Specified by:

setInlineMessage in interface ThinDataviewCommon

Following copied from interface: oracle.dss.thin.beans.dataView.ThinDataviewCommon

Parameters:

msg - The message to display.

See Also:

ThinDataviewCommon.setInlineMessageType(int)

getInlineMessage

public java.lang.String getInlineMessage()

Description copied from interface: ThinDataviewCommon

Retrieves the inline message text to display. If the message is null, then the ThinDataviewCommon displays no message. The message is reset to null after the message is displayed once and whenever the view's data source is updated. The InlineMessageType property controls the type of message that is displayed.

Note: The ThinDataviewCommon calls this method when it displays messages. Application developers can also use it in displaying custom messages.

Specified by:

getInlineMessage in interface ThinDataviewCommon

Following copied from interface: oracle.dss.thin.beans.dataView.ThinDataviewCommon

Returns:

The message to display.

See Also:

ThinDataviewCommon.setInlineMessageType(int)

setTokenSubstitution

public void setTokenSubstitution(TokenSubstitution token)

Description copied from interface: ThinDataviewCommon

Specifies a handler for token substitution in this view. Token substitution handlers make it possible for users to insert tokens (such as a token for the current dimension member) in the title, subtitle, and footnote of this view. Most application developers will use the default TokenSubstitution. You need to call this method only if you provide your own handler for allowing users to insert tokens.

Specified by:

setTokenSubstitution in interface ThinDataviewCommon

Following copied from interface: oracle.dss.thin.beans.dataView.ThinDataviewCommon

Parameters:

token - The token substitution handler for this view.

getTokenSubstitution

public TokenSubstitution getTokenSubstitution()

Description copied from interface: ThinDataviewCommon

Retrieves the handler for token substitution in this view. Token substitution handlers make it possible for users to insert tokens (such as a token for the current dimension member) in the title, subtitle, and footnote of this view. Most application developers will use the default TokenSubstitution.

Specified by:

getTokenSubstitution in interface ThinDataviewCommon

Following copied from interface: oracle.dss.thin.beans.dataView.ThinDataviewCommon

Returns:

The token substitution handler for this view. By default, this is a TokenSubstitutionAdapter.

setDataSource

public void setDataSource(DataSource ds)

Description copied from interface: DataviewCommon

Specifies the data source for this view. In the Model-View-Controller architecture, the data source is the model. It feeds data to the view for display. The Model class in a presentation bean represents the DataSource to the view, but the DataSource is the real source of the data.

Specified by:

setDataSource in interface DataviewCommon

Following copied from interface: oracle.dss.dataView.DataviewCommon

Parameters:

ds - The data source for this view.

getDataSource

public DataSource getDataSource()

Description copied from interface: DataviewCommon

Retrieves the data source for this view.

Specified by:

getDataSource in interface DataviewCommon

Following copied from interface: oracle.dss.dataView.DataviewCommon

Returns:

The DataSource for this view. If no model or data source has been set for this view, this method returns null.

getDataDirector

public DataDirector getDataDirector()

Retrieves the data director for this view. The data director has been initialized.

Returns:

The data director for this view.

addDataListener

public void addDataListener(DataListener l)

Description copied from interface: ThinDataviewCommon

Adds a listener for changes to data, such as drilling or pivoting data. Call this method to register listeners for data changes.

For example, if you want to intercept drill requests, implement a DataListener. In the viewDrillRequesting method, put the code for responding to the drill request. You can simply extend the DataListenerAdapter class, so that you do not have to implement the other methods in the interface.

Specified by:

addDataListener in interface ThinDataviewCommon

Following copied from interface: oracle.dss.thin.beans.dataView.ThinDataviewCommon

Parameters:

l - The listener to add.

See Also:

DataListener.viewDrillRequesting(oracle.dss.dataView.DrillEvent), DataListenerAdapter

removeDataListener

public void removeDataListener(DataListener l)

Description copied from interface: ThinDataviewCommon

Removes a listener for data events.

Specified by:

removeDataListener in interface ThinDataviewCommon

Following copied from interface: oracle.dss.thin.beans.dataView.ThinDataviewCommon

Parameters:

l - The listener to remove.

addErrorHandler

public void addErrorHandler(ErrorHandler eh)

Specifies the error handler for this view. This view can have one and only one error handler. The error handler is called when the view traps an error from another source, such as a DataSource, and when an internal error condition or exception occurs.

The default error handler prints messages to the console.

Use this method to install your own error handler. This method then sets the error handler on the Model.

Specified by:

addErrorHandler in interface ErrorHandlerCallback

Parameters:

eh - The error handler to use.

removeErrorHandler

public void removeErrorHandler()

Removes a customized error handler for this view. This method replaces the current error handler with a default error handler. This method in turn sets the new default error handler on the Model. The default error handler prints information to the console.

Specified by:

removeErrorHandler in interface ErrorHandlerCallback

getErrorHandler

public ErrorHandler getErrorHandler()

Description copied from interface: DataviewCommon

Retrieves the current error handler for this view.

Specified by:

getErrorHandler in interface DataviewCommon

Following copied from interface: oracle.dss.dataView.DataviewCommon

Returns:

The current error handler for this view.

getDataviewTitle

public DataviewTitles getDataviewTitle()

Description copied from interface: ThinDataviewCommon

Retrieves the Title for this ThinDataviewCommon.

Specified by:

getDataviewTitle in interface ThinDataviewCommon

Following copied from interface: oracle.dss.thin.beans.dataView.ThinDataviewCommon

Returns:

The title component for this view.

getDataviewSubtitle

public DataviewTitles getDataviewSubtitle()

Description copied from interface: ThinDataviewCommon

Retrieves the Subtitle for this ThinDataviewCommon.

Specified by:

getDataviewSubtitle in interface ThinDataviewCommon

Following copied from interface: oracle.dss.thin.beans.dataView.ThinDataviewCommon

Returns:

The subtitle component for this view.

getDataviewFootnote

public DataviewTitles getDataviewFootnote()

Description copied from interface: ThinDataviewCommon

Retrieves the Footnote for this ThinDataviewCommon.

Specified by:

getDataviewFootnote in interface ThinDataviewCommon

Following copied from interface: oracle.dss.thin.beans.dataView.ThinDataviewCommon

Returns:

The footnote component for this view.

readXML

public abstract boolean readXML(java.io.InputStream stream,
                                int reset)
                         throws BIIOException,
BISAXException,
BIParseException

Applies XML to this ThinDataview, from a String. This method reads the XML from xmlString and applies its attribute settings to this ThinDataview. The reset parameter determines how much of the ThinDataview to reset before applying XML. In general, you can:

• Apply the XML to the current ThinDataview without resetting anything to default values
• Reset property values only, leaving registered listeners and callbacks
• Reset property values and remove any listeners and callbacks that have been registered with this ThinDataview

Resetting returns property values in the ThinDataview to the default values for the version that is specified in the XML.

Parameters:

stream - The XML to apply to this ThinDataview.

reset - A constant that indicates how much and how far to reset the view before applying XML. Valid constants appear in the See Also section. If you pass an invalid constant, then this method logs a message with the error handler and does not reset any property values.

Returns:

true if the XML is successfully applied to this ThinDataview, false if an IO exception occurs.

Throws:

BIIOException - If an error occurs in reading xmlString.

BISAXException - If a general SAX exception occurs in parsing the XML.

BIParseException - If the XML syntax is not correct, or if the XML is not valid according to the DTD that is specified in the XML.

See Also:

Dataview.RESET_NONE, Dataview.RESET_XML_PROPERTIES, Dataview.RESET_EVERYTHING

setXML

public abstract boolean setXML(java.lang.String xmlString,
                               int reset)
                        throws BIIOException,
BISAXException,
BIParseException

Applies XML to this ThinDataview, from a String. This method reads the XML from xmlString and applies its attribute settings to this ThinDataview. The reset parameter determines how much of the ThinDataview to reset before applying XML. In general, you can:

• Apply the XML to the current ThinDataview without resetting anything to default values
• Reset property values only, leaving registered listeners and callbacks
• Reset property values and remove any listeners and callbacks that have been registered with this ThinDataview

Resetting returns property values in the ThinDataview to the default values for the version that is specified in the XML.

Parameters:

xmlString - The XML to apply to this ThinDataview.

reset - A constant that indicates how much and how far to reset the view before applying XML. Valid constants appear in the See Also section. If you pass an invalid constant, then this method logs a message with the error handler and does not reset any property values.

Returns:

true if the XML is successfully applied to this ThinDataview, false if an IO exception occurs.

Throws:

BIIOException - If an error occurs in reading xmlString.

BISAXException - If a general SAX exception occurs in parsing the XML.

BIParseException - If the XML syntax is not correct, or if the XML is not valid according to the DTD that is specified in the XML.

See Also:

Dataview.RESET_NONE, Dataview.RESET_XML_PROPERTIES, Dataview.RESET_EVERYTHING

setXMLValidated

public void setXMLValidated(boolean validate)

Specifies whether this view validates XML against its DTD. By default, the view does not validate the XML. If there is a parsing error in the XML, then the view ignores the badly formed XML. If you want readXML and setXML to throw a BIParseException if they encounter XML that cannot be parsed, then pass true to this method.

Parameters:

validate - true to have XML validated, false to have the view ignore invalid XML.

See Also:

setXML(java.lang.String, int)

isXMLValidated

public boolean isXMLValidated()

Indicates whether the view validates XML against its DTD.

Returns:

true if the view validates XML, false if the view applies XML without validation.

setName

public final void setName(java.lang.String n)

Specifies the name of this view.

Parameters:

n - The name to use for this view.

getName

public final java.lang.String getName()

Retrieves the name of this view.

Returns:

The name of this view.

setLocalName

public final void setLocalName(java.lang.String n)

Specifies a local name for this view. The name of the view should be constant in all versions of an application. The local name should be a translation of the name into the local language.

Parameters:

n - The local name of this view bean.

getLocalName

public final java.lang.String getLocalName()

Retrieves the local name for this view. The local name should be a translation of the name, into the local language.

Returns:

The local name of this view.

setDescription

public final void setDescription(java.lang.String n)

Specifies a description for this view. For accessiblity, the description is used as the summary for HTML tables in this view.

Parameters:

n - The description to use for this view.

getDescription

public final java.lang.String getDescription()

Retrieves the description of this view. For accessiblity, the description is used as the summary for HTML tables in this view.

Returns:

The description of this view.

setDrillingEnabled

public final void setDrillingEnabled(boolean b)

Specifies whether drilling is allowed in this view. Drilling is enabled by default.

Parameters:

b - true to enable drilling; false to disable drilling.

isDrillingEnabled

public final boolean isDrillingEnabled()

Indicates whether drilling is allowed in this view.

Returns:

true if drilling is enabled, false if driling is disabled.

setExportCharacterEncoding

public void setExportCharacterEncoding(java.lang.String encoding)

Description copied from interface: ThinDataviewCommon

Specifies the character encoding to use when exporting the view. For a list of standard character sets, see http://www.iana.org/assignments/character-sets.

Specified by:

setExportCharacterEncoding in interface ThinDataviewCommon

Following copied from interface: oracle.dss.thin.beans.dataView.ThinDataviewCommon

Parameters:

encoding - The character encoding for export.

getExportCharacterEncoding

public java.lang.String getExportCharacterEncoding()

Description copied from interface: ThinDataviewCommon

Retrieves the character encoding that this ThinDataviewCommon uses when it exports its data.

Specified by:

getExportCharacterEncoding in interface ThinDataviewCommon

Following copied from interface: oracle.dss.thin.beans.dataView.ThinDataviewCommon

Returns:

The character encoding for export.

setExternalTitleVisible

public void setExternalTitleVisible(boolean b)

Description copied from interface: ThinDataviewCommon

Specifies whether a title for this ThinDataviewCommon appears outside the view. For example, if you display a title for this view in a UIX HeaderBean, then set this property to true. If you want the title to appear with exported data, then you should get the internal title and set its text, as well.

If this property is true, then the internal title component for the view does not appear. This property is set to false by default.

Specified by:

setExternalTitleVisible in interface ThinDataviewCommon

Following copied from interface: oracle.dss.thin.beans.dataView.ThinDataviewCommon

Parameters:

b - true if there is an external title, false if there is not.

See Also:

ThinDataviewCommon.getDataviewTitle()

isExternalTitleVisible

public boolean isExternalTitleVisible()

Description copied from interface: ThinDataviewCommon

Indicates whether a title appears outside the view.

If this property is true, then the internal title component for the view does not appear. This property is set to false by default.

Specified by:

isExternalTitleVisible in interface ThinDataviewCommon

Following copied from interface: oracle.dss.thin.beans.dataView.ThinDataviewCommon

Returns:

true if there is an external title, false if there is not.

setExternalSubtitleVisible

public void setExternalSubtitleVisible(boolean b)

Description copied from interface: ThinDataviewCommon

Specifies whether a subtitle for this ThinDataviewCommon appears outside the view. If you want the subtitle to appear with exported data, then you should get the internal subtitle and set its text, as well.

If this property is true, then the internal subtitle component for the view does not appear. This property is set to false by default.

Specified by:

setExternalSubtitleVisible in interface ThinDataviewCommon

Following copied from interface: oracle.dss.thin.beans.dataView.ThinDataviewCommon

Parameters:

b - true if there is an external subtitle, false if there is not.

See Also:

ThinDataviewCommon.getDataviewSubtitle()

isExternalSubtitleVisible

public boolean isExternalSubtitleVisible()

Description copied from interface: ThinDataviewCommon

Indicates whether a subtitle appears outside the view.

If this property is true, then the internal subtitle component for the view does not appear. This property is set to false by default.

Specified by:

isExternalSubtitleVisible in interface ThinDataviewCommon

Following copied from interface: oracle.dss.thin.beans.dataView.ThinDataviewCommon

Returns:

true if there is an external subtitle, false if there is not.

setExternalFootnoteVisible

public void setExternalFootnoteVisible(boolean b)

Description copied from interface: ThinDataviewCommon

Specifies whether a footnote for this ThinDataviewCommon appears outside the view. If you want the footnote to appear with exported data, then you should get the internal footnote and set its text, as well.

If this property is true, then the internal footnote component for the view does not appear. This property is set to false by default.

Specified by:

setExternalFootnoteVisible in interface ThinDataviewCommon

Following copied from interface: oracle.dss.thin.beans.dataView.ThinDataviewCommon

Parameters:

b - true if there is an external footnote, false if there is not.

See Also:

ThinDataviewCommon.getDataviewFootnote()

isExternalFootnoteVisible

public boolean isExternalFootnoteVisible()

Description copied from interface: ThinDataviewCommon

Indicates whether a footnote appears outside the view.

If this property is true, then the internal footnote component for the view does not appear. This property is set to false by default.

Specified by:

isExternalFootnoteVisible in interface ThinDataviewCommon

Following copied from interface: oracle.dss.thin.beans.dataView.ThinDataviewCommon

Returns:

true if there is an external footnote, false if there is not.

getModel

public Model getModel()

Description copied from interface: DataviewCommon

Retrieves the model for this DataviewCommon. The model represents the data that this DataviewCommon displays.

Specified by:

getModel in interface DataviewCommon

Following copied from interface: oracle.dss.dataView.DataviewCommon

Returns:

The model for this DataviewCommon.

setLocale

public void setLocale(java.util.Locale loc)

Description copied from interface: ThinDataviewCommon

Specifies the Locale for this ThinDataviewCommon.

Specified by:

setLocale in interface ThinDataviewCommon

Following copied from interface: oracle.dss.thin.beans.dataView.ThinDataviewCommon

Parameters:

loc - The Locale for this ThinDataviewCommon.

getLocale

public java.util.Locale getLocale()

Description copied from interface: ThinDataviewCommon

Retrieves the Locale that this ThinDataviewCommon uses.

Specified by:

getLocale in interface ThinDataviewCommon

Following copied from interface: oracle.dss.thin.beans.dataView.ThinDataviewCommon

Returns:

loc The Locale for this ThinDataviewCommon.

getXML

public java.lang.String getXML(boolean allProperties)

Retrieves the XML string for this ThinDataview. The XML can include values for all of the properties in the ThinDataview, or, for better performance, it can include only the values that are different from the default values.

Notes: This method sets the current version as the version in the XML.

The XML does not contain attributes for the Locale property or the XMLValidated property.

Parameters:

allProperties - true to retrieve XML for all properties, false to retrieve XML only for properties whose values are different from the default property values.

Returns:

The XML string for this ThinDataview.

writeXML

public void writeXML(java.io.OutputStream stream,
                     boolean allProperties)

Writes XML for this ThinDataview to an output stream. The XML can include values for all of the properties in the ThinDataview, or, for better performance, it can include only the values that are different from the default values.

Notes: This method sets the current version as the version in the XML.

The XML does not contain attributes for the Locale property or the XMLValidated property.

Specified by:

writeXML in interface ThinDataviewCommon

Parameters:

stream - The output stream to which to write the XML.

allProperties - true to write out XML for all properties, false to write out XML only for properties whose values are different from the default property values.

getPagingControl

public PagingControl getPagingControl()

Retrieves the paging control for this view. The paging control provides user interface for changing the page of data that appears in this view.

Returns:

The paging control for this view. If there is no paging control for this view, returns null.

setPagingControlVisible

public void setPagingControlVisible(boolean v)

Description copied from interface: ThinDataviewCommon

Specifies whether the paging control appears in this view. The paging control displays 25 dimension members for each dimension in the page edge. To display more than 25 dimension members, you must create a FindMember dialog and set an EventTarget to direct the INIT_FIND_MEMBER_EVENT to the FindMember.

Specified by:

setPagingControlVisible in interface ThinDataviewCommon

Following copied from interface: oracle.dss.thin.beans.dataView.ThinDataviewCommon

Parameters:

v - true to make the paging control visible, false to hide it.

See Also:

FindMember, EventTarget

isPagingControlVisible

public boolean isPagingControlVisible()

Description copied from interface: ThinDataviewCommon

Indicates whether the paging control appears in this view.

Specified by:

isPagingControlVisible in interface ThinDataviewCommon

Following copied from interface: oracle.dss.thin.beans.dataView.ThinDataviewCommon

Returns:

true if the paging control appears in this view, false if it does not.

setHTMLPagingControlAutosubmit

public void setHTMLPagingControlAutosubmit(boolean autosubmit)

Specifies whether changes made in the paging control are automatically submitted to the data source. By default, changes are not automatically submitted.

Specified by:

setHTMLPagingControlAutosubmit in interface DataviewCommon

Parameters:

autosubmit - true to enable automatic submission, false to disable it.

isHTMLPagingControlAutosubmit

public boolean isHTMLPagingControlAutosubmit()

Indicates whether changes made in the paging control are automatically submitted to the data source.

Specified by:

isHTMLPagingControlAutosubmit in interface DataviewCommon

Returns:

true if changes are automatically submitted, false if they are not.

setHTMLPagingControlWidth

public void setHTMLPagingControlWidth(int width)

Description copied from interface: DataviewCommon

Specifies the number of page items that are displayed before the paging control wraps to a new line. The default value is 3. This property is used for the thin beans only.

Specified by:

setHTMLPagingControlWidth in interface DataviewCommon

Following copied from interface: oracle.dss.dataView.DataviewCommon

Parameters:

width - The number of page items to display before wrapping. To display all page items on the same line, pass -1.

getHTMLPagingControlWidth

public int getHTMLPagingControlWidth()

Description copied from interface: DataviewCommon

Retrieves the number of page items that are displayed before the paging control wraps. This property is used for the thin beans only.

Specified by:

getHTMLPagingControlWidth in interface DataviewCommon

Following copied from interface: oracle.dss.dataView.DataviewCommon

Returns:

The number of page items to display before wrapping.

isEnabled

public boolean isEnabled()

Description copied from interface: ThinDataviewCommon

Indicates whether this ThinDataviewCommon is enabled. Users cannot interact with a disabled view, but they can see it.

Specified by:

isEnabled in interface ThinDataviewCommon

Following copied from interface: oracle.dss.thin.beans.dataView.ThinDataviewCommon

Returns:

true if users can interact with this ThinDataviewCommon, false if they cannot.

setEnabled

public void setEnabled(boolean enabled)

Description copied from interface: ThinDataviewCommon

Specifies whether this ThinDataviewCommon is enabled. When a ThinDataviewCommon is disabled, users can see it, but they cannot interact with it.

Specified by:

setEnabled in interface ThinDataviewCommon

Following copied from interface: oracle.dss.thin.beans.dataView.ThinDataviewCommon

Parameters:

enabled - true to enable this ThinDataviewCommon, false to disable it.

resetToDefault

public void resetToDefault(int reset)

Resets properties of this ThinDataview to their default values. The reset parameter determines whether to reset only the properties or to reset the properties and remove registered listeners and callbacks.

When reset is RESET_EVERYTHING, then this method removes event targets as well.

This method is helpful when you want to reuse a ThinDataview rather than instantiate a new one.

Specified by:

resetToDefault in interface ThinDataviewCommon

Parameters:

reset - A constant that indicates how much to reset. Valid constants are listed in the See Also section. If you pass an invalid value or RESET_NONE, then this method logs a message with the error handler and does not change any properties.

See Also:

Dataview.RESET_XML_PROPERTIES, Dataview.RESET_EVERYTHING

cleanUp

public void cleanUp()

Description copied from interface: ThinDataviewCommon

Clears the memory of this view. Call this method when you no longer need this view.

Specified by:

cleanUp in interface ThinDataviewCommon

initialize

public void initialize(java.util.Hashtable env)

Persistable interface

Specified by:

initialize in interface Persistable

Following copied from interface: oracle.dss.util.persistence.Persistable

Parameters:

env - Environment properties.

getPersistableAttributes

public abstract PersistableAttributes getPersistableAttributes(PersistableAttributes attrs)

Retrieves the attributes of this ThinDataview, for searching. This method adds the attributes that this ThinDataview defines to the attributes that the application has specified. The attributes are used by the persistence service, when users search the repository for components that have particular attribute values.

Specified by:

getPersistableAttributes in interface Persistable

Parameters:

attrs - The searchable attributes that the application has specified for this ThinDataview.

Returns:

A PersistableAttributes that includes the application specified attributes as well as the attributes that are specific to this ThinDataview.

setPersistableAttributes

public void setPersistableAttributes(PersistableAttributes attrs)

Specifies persistable attributes that can be used in searches of the BI Beans Catalog. This implementation does nothing. Only properties of the ThinDataview itself can be used as persistable attributes.

Specified by:

setPersistableAttributes in interface Persistable

Parameters:

attrs - Any PersistableAttributes.

setXMLAsString

public abstract boolean setXMLAsString(java.lang.String xml)
                                throws BIPersistenceException

Specifies the XML representation of this ThinDataview. The persistence service calls this method when the view is restored from the BI Beans Catalog. Application developers should not call this method. To load XML from a file, call setXML or readXML.

Specified by:

setXMLAsString in interface StringXMLizable

Parameters:

xml - The XML representation of the view.

Returns:

true if the XML was successfully set, false if not.

Throws:

BIPersistenceException - If a problem occurs in setting the XML.

See Also:

readXML(java.io.InputStream, int), setXML(java.lang.String, int)

getPersistableComponents

public AggregateInfo[] getPersistableComponents()

Retrieves the persistable components that this Dataview aggregates. Dataview objects aggregate the data source that defines the data that view displays.

The persistence service calls this method when the view is restored from the BI Beans Catalog. Application developers should not call this method.

Specified by:

getPersistableComponents in interface Persistable

Returns:

The data source for this ThinDataview, in an AggregateInfo array.

setPersistableComponents

public void setPersistableComponents(AggregateInfo[] persistables)

Specifies the list of Persistable components that this ThinDataview aggregates. ThinDataview objects aggregate the data source that defines the data that view displays.

The persistence service calls this method when the view is stored in the BI Beans Catalog. Application developers should not call this method.

Specified by:

setPersistableComponents in interface Persistable

Parameters:

persistables - The data source for this ThinDataview, in an AggregateInfo array.

getXMLAsString

public java.lang.String getXMLAsString()

Retrieves the XML representation of this ThinDataview. This method is called by the persistence service when you save the ThinDataview to the BI Beans Catalog.

This method calls getXML(false), so the XML that is stored in the Catalog has only property values that are different from the default values.

Application developers should not call this method. To create a file that has the XML for this ThinDataview, call the writeXML method or the getXML method.

Specified by:

getXMLAsString in interface StringXMLizable

Returns:

The XML representation of this ThinDataview.

See Also:

getXML(boolean), writeXML(java.io.OutputStream, boolean)

isPropertyOverrideFlag

public boolean isPropertyOverrideFlag(int attrID,
                                      java.util.BitSet overrideFlags)