oracle.dss.thin.beans.dataView
Interface ThinDataviewCommon

All Superinterfaces:

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

All Known Implementing Classes:

ThinDataview, ThinGraph

public interface ThinDataviewCommon

extends ThinBeanUI, DataviewCommon, Persistable, ErrorHandlerCallback, CheckpointState

Methods that are common to all thin presentation beans. This interface defines methods that the ThinCrosstab, ThinTable, and ThinGraph implement.

Each ThinDataviewCommon implementation generates the following events:

• BIConstants.DRILL_EVENT -- Generated when a user drills on a drillable component of a view. The view that generates the event also handles it.
• BIConstants.PAGE_EVENT -- Generated when a users selects a different page of data to display. The view that generates the event also handles it.
• BIConstants.INIT_FIND_MEMBER_EVENT -- Generated when a user selects the more item in the list of dimension members that paging control displays. The FindMember dialog handles this event. Your application must set an event target to direct this event to a FindMember dialog. If you do not, then the more item does not appear in the list of dimension members in the paging control.

The ThinDataviewCommon handles the following events:

• BIConstants.ROTATE_EVENT -- The presentation handles this event by editing the query that it displays. The event is generated by the RotateTool bean.
• BIConstants.DRILL_EVENT - The ThinCrosstab
• or ThinGraph handles this event by editing the query that it displays. The event is generated by the presentation bean when a user clicks on a drillable component.
• BIConstants.PAGE_EVENT -- The presentation handles this event by changing the page of data. It is generated when a user selects an item in the paging control or in the FindMember dialog.
• BIConstants.EXPORT_EVENT -- The thin presentation bean handles this event by exporting the data. Before and after the export, the presentation fires an ExportEvent to any registered listeners. You can register a ThinViewListener to consume the Java event or to respond to the export. The EXPORT_EVENT is generated the ExportOptions dialog.
• BIConstants.SAVE_EVENT -- The thin presentation handles this event by saving itself to the BI Beans Catalog. Before and after saving, the presentation fires a SaveEvent to any registered listeners. You can register a ThinViewListener to consume the Java event or to respond to the export. The SAVE_EVENT is generated by the SaveAs dialog and by the SaveConfirmation dialog.

For more information about using thin presentation beans, see the BI Beans Help system.

See Also:

FindMember, ExportOptions, SaveAs, SaveConfirmation, ThinViewListener

Field Summary

static int	INLINE_ERROR_MSG Inline message type: Error message.
static int	INLINE_INFO_MSG Inline message type: Information message.
static int	INLINE_WARNING_MSG Inline message type: Warning.

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

EVENT_HANDLED, EVENT_NOT_HANDLED, EVENT_RESPONSE_DONE

Method Summary

void	addDataListener(DataListener l) Adds a listener for changes to data, such as drilling or pivoting data.
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.
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	getExportCharacterEncoding() Retrieves the character encoding that this ThinDataviewCommon uses when it exports its data.
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.
int	getPagingControlPosition() Retrieves the location of the paging control in this ThinDataviewCommon.
TokenSubstitution	getTokenSubstitution() Retrieves the handler for token substitution in this view.
int	getViewType() Retrieves the type of view that implements this ThinDataviewCommon.
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	isPagingControlVisible() Indicates whether the paging control appears in this view.
void	removeDataListener(DataListener l) Removes a listener for data events.
void	removeThinViewListener(ThinViewListener l) Removes a listener for ThinDataviewCommon events.
void	resetToDefault(int reset) Resets properties of this ThinDataviewCommon to their default values.
void	setEnabled(boolean enabled) Specifies whether this ThinDataviewCommon is enabled.
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	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	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	setTokenSubstitution(TokenSubstitution token) Specifies a handler for token substitution in this view.
void	writeXML(java.io.OutputStream stream, boolean allProperties) Writes XML for this ThinDataviewCommon to an output stream.

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

getEventTarget, handleEvent, setEventTarget

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

getState, getThinBeanName, setBaseState, setState, setThinBeanName

Methods inherited from interface oracle.dss.dataView.DataviewCommon

getDataSource, getErrorHandler, getHTMLPagingControlWidth, getModel, isHTMLPagingControlAutosubmit, setDataSource, setHTMLPagingControlAutosubmit, setHTMLPagingControlWidth

Methods inherited from interface oracle.dss.rules.ComponentTypeConverter

convertComponentTypeToInteger, convertComponentTypeToString

Methods inherited from interface oracle.dss.util.persistence.Persistable

getPersistableAttributes, getPersistableComponents, initialize, setPersistableAttributes, setPersistableComponents

Methods inherited from interface oracle.dss.util.persistence.StringXMLizable

getXMLAsString, setXMLAsString

Methods inherited from interface oracle.dss.util.ErrorHandlerCallback

addErrorHandler, removeErrorHandler

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

checkpointState, getCheckpointState, setCheckpointState

Field Detail

INLINE_ERROR_MSG

public static final int INLINE_ERROR_MSG

Inline message type: Error message.

See Also:

setInlineMessageType(int)

INLINE_WARNING_MSG

public static final int INLINE_WARNING_MSG

Inline message type: Warning.

See Also:

setInlineMessageType(int)

INLINE_INFO_MSG

public static final int INLINE_INFO_MSG

Inline message type: Information message.

See Also:

setInlineMessageType(int)

Method Detail

getViewType

public int getViewType()

Retrieves the type of view that implements this 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

isEnabled

public boolean isEnabled()

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

Returns:

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

setEnabled

public void setEnabled(boolean enabled)

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

Parameters:

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

getDataviewTitle

public DataviewTitles getDataviewTitle()

Retrieves the Title for this ThinDataviewCommon.

Returns:

The title component for this view.

getDataviewSubtitle

public DataviewTitles getDataviewSubtitle()

Retrieves the Subtitle for this ThinDataviewCommon.

Returns:

The subtitle component for this view.

getDataviewFootnote

public DataviewTitles getDataviewFootnote()

Retrieves the Footnote for this ThinDataviewCommon.

Returns:

The footnote component for this view.

setPagingControlVisible

public void setPagingControlVisible(boolean v)

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.

Parameters:

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

See Also:

FindMember, EventTarget

isPagingControlVisible

public boolean isPagingControlVisible()

Indicates whether the paging control appears in this view.

Returns:

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

setPagingControlPosition

public void setPagingControlPosition(int loc)

Specifies the location of the paging control in this 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()

Retrieves the location of the paging control in this 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)

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.

Parameters:

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

See Also:

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

getInlineMessageType

public int getInlineMessageType()

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.

Returns:

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

See Also:

INLINE_ERROR_MSG, INLINE_WARNING_MSG, INLINE_INFO_MSG, getInlineMessage()

setInlineMessage

public void setInlineMessage(java.lang.String msg)

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.

Parameters:

msg - The message to display.

See Also:

setInlineMessageType(int)

getInlineMessage

public java.lang.String getInlineMessage()

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.

Returns:

The message to display.

See Also:

setInlineMessageType(int)

setExportCharacterEncoding

public void setExportCharacterEncoding(java.lang.String encoding)

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.

Parameters:

encoding - The character encoding for export.

getExportCharacterEncoding

public java.lang.String getExportCharacterEncoding()

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

Returns:

The character encoding for export.

setExternalTitleVisible

public void setExternalTitleVisible(boolean b)

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.

Parameters:

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

See Also:

getDataviewTitle()

isExternalTitleVisible

public boolean isExternalTitleVisible()

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.

Returns:

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

setExternalSubtitleVisible

public void setExternalSubtitleVisible(boolean b)

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.

Parameters:

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

See Also:

getDataviewSubtitle()

isExternalSubtitleVisible

public boolean isExternalSubtitleVisible()

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.

Returns:

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

setExternalFootnoteVisible

public void setExternalFootnoteVisible(boolean b)

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.

Parameters:

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

See Also:

getDataviewFootnote()

isExternalFootnoteVisible

public boolean isExternalFootnoteVisible()

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.

Returns:

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

setTokenSubstitution

public void setTokenSubstitution(TokenSubstitution token)

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.

Parameters:

token - The token substitution handler for this view.

getTokenSubstitution

public TokenSubstitution getTokenSubstitution()

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.

Returns:

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

setLocale

public void setLocale(java.util.Locale loc)

Specifies the Locale for this ThinDataviewCommon.

Specified by:

setLocale in interface ThinBeanUI

Parameters:

loc - The Locale for this ThinDataviewCommon.

getLocale

public java.util.Locale getLocale()

Retrieves the Locale that this ThinDataviewCommon uses.

Specified by:

getLocale in interface ThinBeanUI

Returns:

loc The Locale for this ThinDataviewCommon.

writeXML

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

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

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.

resetToDefault

public void resetToDefault(int reset)

Resets properties of this ThinDataviewCommon 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.

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

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, 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()

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

addDataListener

public void addDataListener(DataListener l)

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.

Parameters:

l - The listener to add.

See Also:

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

removeDataListener

public void removeDataListener(DataListener l)

Removes a listener for data events.

Parameters:

l - The listener to remove.

addThinViewListener

public void addThinViewListener(ThinViewListener l)

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

Parameters:

l - The listener to add.

See Also:

ThinViewListenerAdapter

removeThinViewListener

public void removeThinViewListener(ThinViewListener l)

Removes a listener for ThinDataviewCommon events.

Parameters:

l - The listener to remove.