oracle.dss.dataView
Class CommonDataview

java.lang.Object
  oracle.dss.dataView.CommonDataview

All Implemented Interfaces:

DataviewAttributes, DataviewCommon, DataviewConstants, oracle.dss.presutil.CommonViewAttributes, ComponentTypeConverter

Direct Known Subclasses:

CommonGauge, CommonGraph

public class CommonDataview
extends java.lang.Object
implements DataviewCommon, DataviewConstants, DataviewAttributes

Application developers should not create this class. CommonGraph extends this class.

Since:

4.0

Nested Class Summary

protected static class

CommonDataview.NullObject

Field Summary

static java.lang.String	a_animationDownColor
static java.lang.String	a_animationDuration
static java.lang.String	a_animationIndicators
static java.lang.String	a_animationOnDataChange
static java.lang.String	a_animationOnDisplay
static java.lang.String	a_animationUpColor
static java.lang.String	a_interactivityBehavior
static java.lang.String	a_visualEffects
static java.lang.String	ad_auto
static java.lang.String	ad_none
static java.lang.String	adc_auto
static java.lang.String	adc_none
static java.lang.String	adc_on
static java.lang.String	ai_all
static java.lang.String	ai_none
protected FontList	fontList
protected oracle.dss.util.persistence.PersistableAttributes	m_attrs
protected boolean	m_dataUnformattedSupported
protected java.lang.String	m_description
protected java.util.ResourceBundle	m_dvStrings
protected ErrorHandler	m_eh
protected boolean	m_htmlPagingControlAutosubmit
protected int	m_htmlPagingControlWidth
protected java.lang.String[]	m_layerMetadataLabelTypes
protected boolean	m_layermetaLonglabelSupported
protected boolean	m_layermetaMediumlabelSupported
protected boolean	m_layermetaNameSupported
protected boolean	m_layermetaShortlabelSupported
protected boolean	m_layermetaViewStyleSupported
protected java.lang.String	m_localName
protected java.lang.String[]	m_memberMetadataLabelTypes
protected boolean	m_metaDateSupported
protected boolean	m_metaLonglabelSupported
protected boolean	m_metaMediumlabelSupported
protected boolean	m_metaShortlabelSupported
protected boolean	m_metaValueSupported
protected boolean	m_metaViewStyleSupported
protected static java.lang.String	m_method_fillRelationalDataArrays
protected static java.lang.String	m_method_setDescription
protected static java.lang.String	m_method_setLocalName
protected static java.lang.String	m_method_setName
protected java.lang.String	m_name
protected int	m_pagingControlPosition
protected boolean	m_pagingVisible
protected ThickDataview	m_thickView
protected boolean	m_validate
protected DataviewXML	m_viewXML
protected WaitData[]	m_waitDataForRows
static java.lang.String	ve_auto
static java.lang.String	ve_bevel
static java.lang.String	ve_glow
static java.lang.String	ve_none
static java.lang.String	ve_shadow

Fields inherited from interface oracle.dss.dataView.DataviewConstants

AD_AUTO, AD_MAX, AD_MIN, AD_NONE, ADC_AUTO, ADC_MAX, ADC_MIN, ADC_NONE, ADC_ON, AI_ALL, AI_MAX, AI_MIN, AI_NONE, ANIMATION_DOWN_COLOR, ANIMATION_DURATION, ANIMATION_INDICATORS, ANIMATION_ON_DATA_CHANGE, ANIMATION_ON_DISPLAY, ANIMATION_UP_COLOR, DATAVIEW_END, DATAVIEW_FOOTNOTE, DATAVIEW_FOOTNOTE_NAME, DATAVIEW_SUBTITLE, DATAVIEW_SUBTITLE_NAME, DATAVIEW_TITLE, DATAVIEW_TITLE_NAME, DEFAULT_ZOOM_FACTOR, FOOTNOTE, FOOTNOTE_NAME, FORMAT_MANAGER_NAME, FT_COLOR, FT_GRADIENT, FT_PATTERN, FT_TEXTURE, GD_CUSTOM_LINEAR, GD_CUSTOM_RADIAL, GD_DIAGONAL_135, GD_DIAGONAL_45, GD_DOWN, GD_RADIAL, GD_RADIAL_BOTTOM_LEFT, GD_RADIAL_BOTTOM_RIGHT, GD_RADIAL_OFF_CENTER, GD_RADIAL_TOP_LEFT, GD_RADIAL_TOP_RIGHT, GD_RIGHT, LAP_BOTTOM, LAP_LEFT, LAP_RIGHT, LAP_TOP, MAP_ALL, MAP_DATA, MAP_DATATEXT, MAP_LABELS, MAP_LEGEND, MAP_ORDINALLABELS, MAP_TITLES, PAGE_CONTROL, page_header, PAGE_HEADER, PAGE_HEADER_NAME, PAGE_ITEM, PAGE_ITEM_NAME, PAGING_COMPONENT_NAME, PAGING_CONTROL_ABOVE_TITLES, PAGING_CONTROL_BELOW_TITLES, PAGING_CONTROL_EAST_OF_VIEW, PAGING_CONTROL_SOUTH_OF_VIEW, PAGING_CONTROL_WEST_OF_VIEW, RESET_EVERYTHING, RESET_EVERYTHING_CUSTOM, RESET_EVERYTHING_NOT_DATASOURCE, RESET_EVERYTHING_ORIGINAL, RESET_MAX, RESET_MIN, RESET_NONE, RESET_XML_PROPERTIES, RESET_XML_PROPERTIES_CUSTOM, RESET_XML_PROPERTIES_ORIGINAL, STYLE_MANAGER_NAME, SUBTITLE, SUBTITLE_NAME, TITLE, TITLE_NAME, TOOLTIP_NAME, VE_AUTO, VE_BEVEL, VE_GLOW, VE_MAX, VE_MIN, VE_NONE, VE_SFX_MAX, VE_SFX_MIN, VE_SHADOW, VIEW_FORMAT_NAME, VIEW_STYLE_NAME, VIEW_TYPE_CROSSTAB, VIEW_TYPE_GAUGE, VIEW_TYPE_GRAPH, VIEW_TYPE_PAGINGCONTROL, VIEW_TYPE_TABLE, VISUAL_EFFECTS

Constructor Summary

CommonDataview(java.util.Locale loc)

CommonDataview(java.util.Locale loc, ErrorHandler handler)

Method Summary

void	addErrorHandler(ErrorHandler eh) Specifies the error handler for this view.
void	clearPropertyOverrideFlag(int attrID, java.util.BitSet overrideFlags)
protected void	clearStyleModified()
void	clearWaitDataForAllRows()
static int	convertAnimationIndicatorsToInt(java.lang.String type)
static java.lang.String	convertAnimationIndicatorsToString(int type)
static int	convertAnimationOnDataChangeToInt(java.lang.String type)
static java.lang.String	convertAnimationOnDataChangeToString(int type)
static int	convertAnimationOnDisplayToInt(java.lang.String type)
static java.lang.String	convertAnimationOnDisplayToString(int type)
int	convertComponentTypeToInteger(java.lang.String type) Retrieves an integer representation of a view component, from a String.
java.lang.String	convertComponentTypeToString(int type) Retrieves a String representation of a view component, from an integer.
static int	convertVisualEffectsToInt(java.lang.String type)
static java.lang.String	convertVisualEffectsToString(int type)
java.util.BitSet	createPropertyOverrideFlags(int maxID)
void	dataFormatChanged()
void	dataStyleChanged()
protected void	fillRelationalDataArrays(int colCount, int rowCount, java.util.List colLabelsList, java.util.List rowLabelsList, java.util.Hashtable dataVals, java.lang.Object[] colLabels, java.lang.Object[] rowLabels, java.lang.Object[][] data)
DataAccess	getDataAccess()
DataDirector	getDataDirector()
DataSource	getDataSource() Retrieves the data source for this view.
DataviewTitles	getDataviewFootnote() Retrieves the footnote for this view.
protected static java.util.ResourceBundle	getDataviewResourceBundle(java.util.Locale loc)
DataviewTitles	getDataviewSubtitle() Retrieves the subtitle for this view.
DataviewTitles	getDataviewTitle() Retrieves the title for this view.
java.lang.String	getDescription()
ErrorHandler	getErrorHandler() Retrieves the current error handler for this view.
java.lang.String	getFlashPlayerDownloadMessageHTML(java.lang.String version, java.lang.String url)
FontList	getFontList()
int	getHTMLPagingControlWidth() Retrieves the number of page items that are displayed before the paging control wraps.
java.lang.String	getIntlString(java.lang.String key)
java.lang.String	getIntlString(java.lang.String key, java.util.ResourceBundle rBundle)
java.lang.String	getLayerMetadataLabelType() Retrieves the type of labels that this view displays for dimension names on all edges.
java.lang.String	getLayerMetadataLabelType(int edge) Retrieves the type of labels that this view displays for dimension names on the specified edge.
java.util.Locale	getLocale() Retrieves the Locale for this DataviewCommon.
java.lang.String	getLocalName()
java.lang.String	getMemberMetadataLabelType() Retrieves the type of labels that this view displays for dimension members.
java.lang.String	getMemberMetadataLabelType(int edge) Retrieves the type of labels that this view displays for dimension members on the specified edge.
Model	getModel() Retrieves the model for this DataviewCommon.
java.lang.String	getName()
protected oracle.dss.util.xml.ObjectNode	getObjectNode(java.lang.String objName, boolean allProperties)
protected oracle.dss.util.xml.ObjectNode	getObjectNode(java.lang.String objName, boolean allProperties, java.lang.String version)
int	getPagingControlPosition()
oracle.dss.util.persistence.AggregateInfo[]	getPersistableComponents() Retrieves the persistable components that this Dataview aggregates.
ThickDataview	getThickDataview()
TokenSubstitution	getTokenSubstitution() Retrieves the handler for token substitution in this view.
java.lang.String	getVersion()
int	getViewType()
protected DataviewXML	getViewXML()
protected WaitData[]	getWaitData()
WaitData	getWaitDataForRow(int row)
java.lang.String	getXML(java.lang.String objName, boolean allProperties) Retrieves the XML string for this Dataview.
int	getZoomFactor()
boolean	isDataUnformattedSupported()
boolean	isDataViewFormatSupported()
boolean	isDrillingEnabled()
boolean	isDrillingSupported()
protected boolean	isEdgeValid(int edge) Determine if the given edge is valid.
boolean	isHTMLPagingControlAutosubmit() Indicates whether paging control changes are automatically submitted.
boolean	isLayerMetadataLabelTypeSupported(java.lang.String type)
boolean	isLayerMetaLongLabelSupported()
boolean	isLayerMetaMediumLabelSupported()
boolean	isLayerMetaNameSupported()
boolean	isLayerMetaShortLabelSupported()
boolean	isLayerMetaViewStyleSupported()
protected boolean	isLogTabularMissingDataWarning() Determine whether the warning for missing data values should be logged when setting tabular data.
boolean	isMemberMetadataLabelTypeSupported(java.lang.String type)
boolean	isMetadataDateSupported()
boolean	isMetadataLongLabelSupported()
boolean	isMetadataMediumLabelSupported()
boolean	isMetadataShortLabelSupported()
boolean	isMetadataValueSupported()
boolean	isMetadataViewStyleSupported()
boolean	isPagingControlVisible()
boolean	isPropertyOverrideFlag(int attrID, java.util.BitSet overrideFlags)
protected boolean	isStyleModified()
protected boolean	isStyleOverrideMode()
protected boolean	isUserOverrideMode()
boolean	isXMLValidated() Indicates whether the Dataview validates XML against its DTD.
void	metadataStyleChanged()
void	removeErrorHandler() Removes a customized error handler for this view.
void	repaint()
java.awt.Font	scaleFont(java.awt.Font f, int zoomFactor)
void	setDataAccess(DataAccess dataAccess)
void	setDataDirector(DataDirector dataDirector)
void	setDataSource(DataSource ds) Specifies the data source for this view.
void	setDataUnformattedSupported(boolean supported)
void	setDescription(java.lang.String desc)
void	setDrillingEnabled(boolean b)
boolean	setGridData(java.lang.Object[] columnLabels, java.lang.Object[] rowLabels, java.lang.Object[][] data)
protected boolean	setGridData(java.lang.Object[] columnLabels, java.lang.Object[] rowLabels, java.lang.Object[][] data, boolean bAllowNoData)
void	setHTMLPagingControlAutosubmit(boolean autosubmit) Specifies whether paging control changes are automatically submitted.
void	setHTMLPagingControlWidth(int width) Specifies the number of page items that are displayed before the paging control wraps to a new line.
void	setLayerMetadataLabelType(int edge, java.lang.String type) Specifies the type of labels to display for dimension names on the specified edge in this view.
void	setLayerMetadataLabelType(java.lang.String type) Specifies the type of labels to display for dimension names on all edges in this view.
void	setLayerMetaLongLabelSupported(boolean supported)
void	setLayerMetaMediumLabelSupported(boolean supported)
void	setLayerMetaNameSupported(boolean supported)
void	setLayerMetaShortLabelSupported(boolean supported)
void	setLayerMetaViewStyleSupported(boolean supported)
void	setLocale(java.util.Locale loc) Specifies the Locale for this Graph.
void	setLocalName(java.lang.String name)
protected void	setLocalXMLDataSource(LocalXMLDataSource ds)
void	setMemberMetadataLabelType(int edge, java.lang.String type) Specifies the type of labels to display for dimension members on the specified edge in this view.
void	setMemberMetadataLabelType(java.lang.String type) Specifies the type of labels to display for dimension members on all edges in this view.
void	setMetadataDateSupported(boolean supported)
void	setMetadataLongLabelSupported(boolean supported)
void	setMetadataMediumLabelSupported(boolean supported)
void	setMetadataShortLabelSupported(boolean supported)
void	setMetadataValueSupported(boolean supported)
void	setMetadataViewStyleSupported(boolean supported)
void	setModel(Model model)
void	setName(java.lang.String name)
void	setPagingControlPosition(int loc)
void	setPagingControlVisible(boolean v)
void	setPersistableAttributes(oracle.dss.util.persistence.PersistableAttributes attrs) Specifies persistable attributes that can be used in searches of the repository.
void	setPersistableComponents(oracle.dss.util.persistence.AggregateInfo[] persistables)
void	setPropertyOverrideFlags(int attrID, java.util.BitSet userFlags, java.util.BitSet styleFlags)
protected void	setStyleOverrideMode(boolean flag)
boolean	setTabularData(java.util.List tableRows) Specifies data for the Graph, from a table of data.
protected boolean	setTabularData(java.util.List tableRows, boolean bAllowNoData)
void	setThickDataview(ThickDataview view)
void	setTokenSubstitution(TokenSubstitution token) Specifies a handler for token substitution in this view.
protected void	setUserOverrideMode(boolean flag)
protected void	setViewXML(DataviewXML viewXML)
void	setWaitDataForRow(int row, WaitData waitData)
void	setXMLValidated(boolean validate) Specifies whether this Dataview validates XML against its DTD.
protected void	updateResourceBundle()

Methods inherited from class java.lang.Object

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

Field Detail

fontList

protected FontList fontList

For internal use only. Application developers should not use this

Cached font list

m_eh

protected transient ErrorHandler m_eh

For internal use only. Application developers should not use this

Error handler callback

m_thickView

protected ThickDataview m_thickView

For internal use only. Application developers should not use this

Implementation that allows operations on a thick version of this view

m_viewXML

protected DataviewXML m_viewXML

For internal use only. Application developers should not use this

XML processing object

m_memberMetadataLabelTypes

protected java.lang.String[] m_memberMetadataLabelTypes

For internal use only. Application developers should not use this

m_layerMetadataLabelTypes

protected java.lang.String[] m_layerMetadataLabelTypes

For internal use only. Application developers should not use this

m_waitDataForRows

protected WaitData[] m_waitDataForRows

For internal use only. Application developers should not use this

list of rows waiting for data from lazy data fetch

m_dataUnformattedSupported

protected boolean m_dataUnformattedSupported

For internal use only. Application developers should not use this

m_metaDateSupported

protected boolean m_metaDateSupported

For internal use only. Application developers should not use this

m_metaLonglabelSupported

protected boolean m_metaLonglabelSupported

For internal use only. Application developers should not use this

m_metaMediumlabelSupported

protected boolean m_metaMediumlabelSupported

For internal use only. Application developers should not use this

m_metaShortlabelSupported

protected boolean m_metaShortlabelSupported

For internal use only. Application developers should not use this

m_metaViewStyleSupported

protected boolean m_metaViewStyleSupported

For internal use only. Application developers should not use this

m_metaValueSupported

protected boolean m_metaValueSupported

For internal use only. Application developers should not use this

m_layermetaShortlabelSupported

protected boolean m_layermetaShortlabelSupported

For internal use only. Application developers should not use this

m_layermetaMediumlabelSupported

protected boolean m_layermetaMediumlabelSupported

For internal use only. Application developers should not use this

m_layermetaLonglabelSupported

protected boolean m_layermetaLonglabelSupported

For internal use only. Application developers should not use this

m_layermetaNameSupported

protected boolean m_layermetaNameSupported

For internal use only. Application developers should not use this

m_layermetaViewStyleSupported

protected boolean m_layermetaViewStyleSupported

For internal use only. Application developers should not use this

m_attrs

protected transient oracle.dss.util.persistence.PersistableAttributes m_attrs

For internal use only. Application developers should not use this

A PersistableAttributes component of this view. This structure holds searchable attributes relevant to this view.

m_dvStrings

protected java.util.ResourceBundle m_dvStrings

m_htmlPagingControlAutosubmit

protected boolean m_htmlPagingControlAutosubmit

For internal use only. Application developers should not use this

m_htmlPagingControlWidth

protected int m_htmlPagingControlWidth

For internal use only. Application developers should not use this

m_name

protected java.lang.String m_name

For internal use only. Application developers should not use this

Bean name

m_localName

protected java.lang.String m_localName

For internal use only. Application developers should not use this

Bean local name

m_description

protected java.lang.String m_description

For internal use only. Application developers should not use this

Bean description

m_pagingControlPosition

protected int m_pagingControlPosition

For internal use only. Application developers should not use this

m_pagingVisible

protected boolean m_pagingVisible

For internal use only. Application developers should not use this

m_validate

protected boolean m_validate

For internal use only. Application developers should not use this

XML validation is turned off by default

a_animationOnDataChange

public static final java.lang.String a_animationOnDataChange

See Also:

Constant Field Values

For internal use only. Application developers should not use this

a_animationIndicators

public static final java.lang.String a_animationIndicators

See Also:

Constant Field Values

For internal use only. Application developers should not use this

a_animationUpColor

public static final java.lang.String a_animationUpColor

See Also:

Constant Field Values

For internal use only. Application developers should not use this

a_animationDownColor

public static final java.lang.String a_animationDownColor

See Also:

Constant Field Values

For internal use only. Application developers should not use this

a_animationDuration

public static final java.lang.String a_animationDuration

See Also:

Constant Field Values

For internal use only. Application developers should not use this

a_animationOnDisplay

public static final java.lang.String a_animationOnDisplay

See Also:

Constant Field Values

For internal use only. Application developers should not use this

a_visualEffects

public static final java.lang.String a_visualEffects

See Also:

Constant Field Values

For internal use only. Application developers should not use this

a_interactivityBehavior

public static final java.lang.String a_interactivityBehavior

See Also:

Constant Field Values

For internal use only. Application developers should not use this

adc_none

public static final java.lang.String adc_none

See Also:

Constant Field Values

For internal use only. Application developers should not use this

adc_auto

public static final java.lang.String adc_auto

See Also:

Constant Field Values

For internal use only. Application developers should not use this

adc_on

public static final java.lang.String adc_on

See Also:

Constant Field Values

For internal use only. Application developers should not use this

ai_none

public static final java.lang.String ai_none

See Also:

Constant Field Values

For internal use only. Application developers should not use this

ai_all

public static final java.lang.String ai_all

See Also:

Constant Field Values

For internal use only. Application developers should not use this

ad_none

public static final java.lang.String ad_none

See Also:

Constant Field Values

For internal use only. Application developers should not use this

ad_auto

public static final java.lang.String ad_auto

See Also:

Constant Field Values

For internal use only. Application developers should not use this

ve_none

public static final java.lang.String ve_none

See Also:

Constant Field Values

For internal use only. Application developers should not use this

ve_auto

public static final java.lang.String ve_auto

See Also:

Constant Field Values

For internal use only. Application developers should not use this

ve_shadow

public static final java.lang.String ve_shadow

See Also:

Constant Field Values

For internal use only. Application developers should not use this

ve_glow

public static final java.lang.String ve_glow

See Also:

Constant Field Values

For internal use only. Application developers should not use this

ve_bevel

public static final java.lang.String ve_bevel

See Also:

Constant Field Values

For internal use only. Application developers should not use this

m_method_setName

protected static final java.lang.String m_method_setName

See Also:

Constant Field Values

For internal use only. Application developers should not use this

m_method_setLocalName

protected static final java.lang.String m_method_setLocalName

See Also:

Constant Field Values

For internal use only. Application developers should not use this

m_method_setDescription

protected static final java.lang.String m_method_setDescription

See Also:

Constant Field Values

For internal use only. Application developers should not use this

m_method_fillRelationalDataArrays

protected static final java.lang.String m_method_fillRelationalDataArrays

See Also:

Constant Field Values

For internal use only. Application developers should not use this

Constructor Detail

CommonDataview

public CommonDataview(java.util.Locale loc)

CommonDataview

public CommonDataview(java.util.Locale loc,
                      ErrorHandler handler)

Method Detail

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.

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.

getErrorHandler

public ErrorHandler getErrorHandler()

Description copied from interface: DataviewCommon

Retrieves the current error handler for this view.

Specified by:

getErrorHandler in interface DataviewCommon

Returns:

The current error handler for this view.

For internal use only. Application developers should not use this

Retrieves the current error handler for this view.

getFontList

public FontList getFontList()

Specified by:

getFontList in interface DataviewCommon

Returns:

The current font cache list.

For internal use only. Application developers should not use this

Retrieves the list of fonts that are currently in the cache.

getZoomFactor

public int getZoomFactor()

Specified by:

getZoomFactor in interface DataviewCommon

Returns:

The default zoom factor for this view.

For internal use only. Application developers should not use this

Retrieves the default zoom factor for this view. This number serves as the reference point for calls to the scaleFont method.

getVersion

public java.lang.String getVersion()

Returns:

String The XML version that this view is using

For internal use only. Application developers should not use this

gets the values of the current XML version.

scaleFont

public java.awt.Font scaleFont(java.awt.Font f,
                               int zoomFactor)

Specified by:

scaleFont in interface DataviewCommon

Parameters:

f - The font to scale.

zoomFactor - The percent of the default zoom factor to make the font. For example, to double the size of the font, pass 2 * (getZoomFactor()).

For internal use only. Application developers should not use this

Scales a font.

getIntlString

public java.lang.String getIntlString(java.lang.String key)

Specified by:

getIntlString in interface DataviewCommon

Parameters:

key - the String that needs to be translated.

Returns:

the translated String

For internal use only. Application developers should not use this

because users don't have the keys. Retrieves string resource from the Dataview's ResourceBundle class.

getIntlString

public java.lang.String getIntlString(java.lang.String key,
                                      java.util.ResourceBundle rBundle)

Specified by:

getIntlString in interface DataviewCommon

Parameters:

key - the String that needs to be translated.

rBundle - the bundle to look in

Returns:

the translated String.

For internal use only. Application developers should not use this

Retrieves string resource from a given ResourceBundle class.

setThickDataview

public void setThickDataview(ThickDataview view)

For internal use only. Application developers should not use this

getThickDataview

public ThickDataview getThickDataview()

For internal use only. Application developers should not use this

updateResourceBundle

protected void updateResourceBundle()

For internal use only. Application developers should not use this

getDataviewResourceBundle

protected static java.util.ResourceBundle getDataviewResourceBundle(java.util.Locale loc)
                                                             throws java.util.MissingResourceException

Throws:

java.util.MissingResourceException

getLocale

public java.util.Locale getLocale()

Description copied from interface: DataviewCommon

Retrieves the Locale for this DataviewCommon.

Specified by:

getLocale in interface DataviewCommon

setLocale

public void setLocale(java.util.Locale loc)

Specifies the Locale for this Graph.

Parameters:

loc - The Locale for this Graph.

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

Returns:

The model for this DataviewCommon.

setModel

public void setModel(Model model)

setPersistableAttributes

public void setPersistableAttributes(oracle.dss.util.persistence.PersistableAttributes attrs)

Specifies persistable attributes that can be used in searches of the repository. This implementation does nothing. Only properties of the Dataview itself can be used as persistable attributes.

Parameters:

attrs - Any PersistableAttributes.

getPersistableComponents

public oracle.dss.util.persistence.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.

Returns:

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

setPersistableComponents

public void setPersistableComponents(oracle.dss.util.persistence.AggregateInfo[] persistables)

Parameters:

aggregates - a AggregateInfo[] value that represents the components to assign to the view.

For internal use only. Application developers should not use this

Specifies the components (e.g. selections) associated with the view.

setMemberMetadataLabelType

public void setMemberMetadataLabelType(int edge,
                                       java.lang.String type)

Specifies the type of labels to display for dimension members on the specified edge in this view. The default value for all edges is METADATA_LONGLABEL. If the edge or type is invalid, then this method logs a message with the error handler, and it does not change the current label type.

Note: Not all data sources support all types of labels. Before you call this method, ensure that the data source supports the label type that you want to set. Call DataDirector.getSupportedMetadataMap, and then call the containsType method of the returned map.

Specified by:

setMemberMetadataLabelType in interface DataviewAttributes

Parameters:

edge - A constant that represents the edge that the metadata label type applies to. Valid constants are listed in the See Also section, and they end in "EDGE".

type - A constant that represents the type of metadata label to show. Valid constants are listed in the See Also section, and they begin with "METADATA".

See Also:

DataDirector.COLUMN_EDGE, DataDirector.ROW_EDGE, DataDirector.PAGE_EDGE, MetadataMap.METADATA_LONGLABEL, MetadataMap.METADATA_MEDIUMLABEL, MetadataMap.METADATA_SHORTLABEL, MetadataMap.METADATA_VALUE, DataDirector.getSupportedMetadataMap()

getMemberMetadataLabelType

public java.lang.String getMemberMetadataLabelType(int edge)

Retrieves the type of labels that this view displays for dimension members on the specified edge. The default value for all edges is METADATA_LONGLABEL. Returns null if the specified edge is invalid.

Specified by:

getMemberMetadataLabelType in interface DataviewAttributes

Specified by:

getMemberMetadataLabelType in interface DataviewCommon

Parameters:

edge - A constant that represents the edge for which to get the metadata label type. Valid constants are listed in the See Also section, and they end with "EDGE".

Returns:

A constant that represents the type of metadata label to display. Valid constants are listed in the See Also section, and they begin with "METADATA".

See Also:

DataDirector.COLUMN_EDGE, DataDirector.ROW_EDGE, DataDirector.PAGE_EDGE, MetadataMap.METADATA_LONGLABEL, MetadataMap.METADATA_MEDIUMLABEL, MetadataMap.METADATA_SHORTLABEL, MetadataMap.METADATA_VALUE

isMemberMetadataLabelTypeSupported

public boolean isMemberMetadataLabelTypeSupported(java.lang.String type)

Specified by:

isMemberMetadataLabelTypeSupported in interface DataviewCommon

Parameters:

type - type of member metadata label

Returns:

true if the type is supported, false if not

For internal use only. Application developers should not use this

Determine whether the given type of member metadata label is supported by the data source.

setMemberMetadataLabelType

public void setMemberMetadataLabelType(java.lang.String type)

Specifies the type of labels to display for dimension members on all edges in this view. This is a convenience method to use instead of calling setMemberMetadataLabelType(int, String) on every edge. The default value for all edges is METADATA_LONGLABEL. If the type is invalid, then this method logs a message with the error handler and does not change the current label type.

Note: Not all data sources support all types of labels. Before you call this method, ensure that the data source supports the label type that you want to set. Call DataDirector.getSupportedMetadataMap, and then call the containsType method of the returned map.

Parameters:

type - A constant that represents the type of metadata label to show. Valid constants are listed in the See Also section.

See Also:

setMemberMetadataLabelType(int, String), MetadataMap.METADATA_LONGLABEL, MetadataMap.METADATA_MEDIUMLABEL, MetadataMap.METADATA_SHORTLABEL, MetadataMap.METADATA_VALUE, DataDirector.getSupportedMetadataMap()

getMemberMetadataLabelType

public java.lang.String getMemberMetadataLabelType()

Retrieves the type of labels that this view displays for dimension members. If this view displays the same label type on all edges, then this method returns that type. If different label types are used on different edges, then this method returns null. If this method returns null, then call the getMemberMetadataLabelType(int) method for each edge to get the label types. The default value for all edges is METADATA_LONGLABEL.

Returns:

A constant that represents the type of metadata label that is displayed on all edges, or null if different label types are used for different edges.

See Also:

getMemberMetadataLabelType(int), MetadataMap.METADATA_LONGLABEL, MetadataMap.METADATA_MEDIUMLABEL, MetadataMap.METADATA_SHORTLABEL, MetadataMap.METADATA_VALUE

setLayerMetadataLabelType

public void setLayerMetadataLabelType(java.lang.String type)

Specifies the type of labels to display for dimension names on all edges in this view. This is a convenience method to use instead of calling setLayerMetadataLabelType(int, String) on every edge. The default value for all edges is LAYER_METADATA_LONGLABEL. If the type is invalid, then this method logs a message with the error handler and does not change the current label type.

Note: Not all data sources support all types of labels. Before you call this method, ensure that the data source supports the label type that you want to set. Call DataDirector.getSupportedLayerMetadataMap, and then call the containsType method of the returned map.

Parameters:

type - A constant that represents the type of layer metadata label to show. Valid constants are listed in the See Also section.

See Also:

setLayerMetadataLabelType(int, String), LayerMetadataMap.LAYER_METADATA_LONGLABEL, LayerMetadataMap.LAYER_METADATA_MEDIUMLABEL, LayerMetadataMap.LAYER_METADATA_SHORTLABEL, LayerMetadataMap.LAYER_METADATA_NAME, DataDirector.getSupportedLayerMetadataMap()

isMetadataViewStyleSupported

public boolean isMetadataViewStyleSupported()

Specified by:

isMetadataViewStyleSupported in interface DataviewCommon

Returns:

true if METADATA_VIEWSTYLE is supported, else false

For internal use only. Application developers should not use this

setMetadataViewStyleSupported

public void setMetadataViewStyleSupported(boolean supported)

For internal use only. Application developers should not use this

set the flag for METADATA_VIEWSTYLE type true or false

setMetadataDateSupported

public void setMetadataDateSupported(boolean supported)

For internal use only. Application developers should not use this

set the flag for METADATA_DATE type true or false

isMetadataDateSupported

public boolean isMetadataDateSupported()

For internal use only. Application developers should not use this

set the flag for METADATA_DATE type true or false

getLayerMetadataLabelType

public java.lang.String getLayerMetadataLabelType()

Retrieves the type of labels that this view displays for dimension names on all edges. If the same label type is shown on all edges, then this method returns that type. If different label types are used on different edges, then this method returns null. If this method returns null, then call getLayerMetadataLabelType(int) for each edge to get the label types. The default value for all edges is LAYER_METADATA_LONGLABEL.

Returns:

A constant that represents the type of layer metadata label that this view uses for all dimension names, or null if different edges use different label types.

See Also:

getLayerMetadataLabelType(int), LayerMetadataMap.LAYER_METADATA_LONGLABEL, LayerMetadataMap.LAYER_METADATA_MEDIUMLABEL, LayerMetadataMap.LAYER_METADATA_SHORTLABEL, LayerMetadataMap.LAYER_METADATA_NAME

setLayerMetadataLabelType

public void setLayerMetadataLabelType(int edge,
                                      java.lang.String type)

Specifies the type of labels to display for dimension names on the specified edge in this view. The default value for all edges is LAYER_METADATA_LONGLABEL. If the edge or type is invalid, then this method logs a message with the error handler and does not change the current label type.

Note: Not all data sources support all types of labels. Before you call this method, ensure that the data source supports the label type that you want to set. Call DataDirector.getSupportedLayerMetadataMap, and then call the containsType method of the returned map.

Specified by:

setLayerMetadataLabelType in interface DataviewAttributes

Parameters:

edge - A constant that represents the edge that the metadata label type applies to. Valid constants are listed in the See Also section, and they end with "EDGE".

type - A constant that represents the type of layer metadata label to show. Valid constants are listed in the See Also section, and they begin with "LAYER_METADATA".

See Also:

DataDirector.COLUMN_EDGE, DataDirector.ROW_EDGE, DataDirector.PAGE_EDGE, LayerMetadataMap.LAYER_METADATA_LONGLABEL, LayerMetadataMap.LAYER_METADATA_MEDIUMLABEL, LayerMetadataMap.LAYER_METADATA_SHORTLABEL, LayerMetadataMap.LAYER_METADATA_NAME, DataDirector.getSupportedLayerMetadataMap()

getLayerMetadataLabelType

public java.lang.String getLayerMetadataLabelType(int edge)

Retrieves the type of labels that this view displays for dimension names on the specified edge. The default value for all edges is LAYER_METADATA_LONGLABEL. Returns null if the given edge is invalid.

Specified by:

getLayerMetadataLabelType in interface DataviewAttributes

Specified by:

getLayerMetadataLabelType in interface DataviewCommon

Parameters:

edge - A constant that represents the edge for which to get the metadata label type. Valid constants are listed in the See Also section, and they end with "EDGE".

Returns:

A constant that represents the type of layer metadata label to show. Valid constants are listed in the See Also section, and they begin with "LAYER_METADATA".

See Also:

DataDirector.COLUMN_EDGE, DataDirector.ROW_EDGE, DataDirector.PAGE_EDGE, LayerMetadataMap.LAYER_METADATA_LONGLABEL, LayerMetadataMap.LAYER_METADATA_MEDIUMLABEL, LayerMetadataMap.LAYER_METADATA_SHORTLABEL, LayerMetadataMap.LAYER_METADATA_NAME

setMetadataLongLabelSupported

public void setMetadataLongLabelSupported(boolean supported)

For internal use only. Application developers should not use this

set the flag for METADATA_LONGLABEL type true or false

isMetadataLongLabelSupported

public boolean isMetadataLongLabelSupported()

For internal use only. Application developers should not use this

return true if METADATA_LONGLABEL type is supported, else false

setMetadataMediumLabelSupported

public void setMetadataMediumLabelSupported(boolean supported)

For internal use only. Application developers should not use this

set flag for METADATA_MEDIUMLABEL type to true or false

isMetadataMediumLabelSupported

public boolean isMetadataMediumLabelSupported()

For internal use only. Application developers should not use this

return true if METADATA_MEDIUMLABEL type is supported, else false

setMetadataShortLabelSupported

public void setMetadataShortLabelSupported(boolean supported)

For internal use only. Application developers should not use this

set flag for METADATA_SHORTLABEL type to true or false

isMetadataShortLabelSupported

public boolean isMetadataShortLabelSupported()

Specified by:

isMetadataShortLabelSupported in interface DataviewCommon

For internal use only. Application developers should not use this

return true if METADATA_SHORTLABEL type is supported, else false

setMetadataValueSupported

public void setMetadataValueSupported(boolean supported)

For internal use only. Application developers should not use this

set the flag for METADATA_VALUE type true or false

isMetadataValueSupported

public boolean isMetadataValueSupported()

Returns:

true if METADATA_VALUE is supported, else false

For internal use only. Application developers should not use this

isLayerMetadataLabelTypeSupported

public boolean isLayerMetadataLabelTypeSupported(java.lang.String type)

Specified by:

isLayerMetadataLabelTypeSupported in interface DataviewCommon

Parameters:

type - type of layer metadata label

Returns:

true if the type is supported, false if not

For internal use only. Application developers should not use this

Determine whether the given type of layer metadata label is supported by the data source.

setLayerMetaLongLabelSupported

public void setLayerMetaLongLabelSupported(boolean supported)

For internal use only. Application developers should not use this

set flag for LAYER_METADATA_LONGLABEL type to true or false

isLayerMetaLongLabelSupported

public boolean isLayerMetaLongLabelSupported()

For internal use only. Application developers should not use this

return true if LAYER_METADATA_LONGLABEL type is supported, else false

setLayerMetaMediumLabelSupported

public void setLayerMetaMediumLabelSupported(boolean supported)

For internal use only. Application developers should not use this

set flag for LAYER_METADATA_MEDIUMLABEL type to true or false

isLayerMetaMediumLabelSupported

public boolean isLayerMetaMediumLabelSupported()

For internal use only. Application developers should not use this

return true if LAYER_METADATA_MEDIUMLABEL type is supported, else false

setLayerMetaShortLabelSupported

public void setLayerMetaShortLabelSupported(boolean supported)

For internal use only. Application developers should not use this

set flag for LAYER_METADATA_SHORTLABEL type to true or false

isLayerMetaShortLabelSupported

public boolean isLayerMetaShortLabelSupported()

Specified by:

isLayerMetaShortLabelSupported in interface DataviewCommon

For internal use only. Application developers should not use this

return true if LAYER_METADATA_SHORTLABEL type is supported, else false

setLayerMetaNameSupported

public void setLayerMetaNameSupported(boolean supported)

For internal use only. Application developers should not use this

set flag for LAYER_METADATA_NAME type to true or false

isLayerMetaNameSupported

public boolean isLayerMetaNameSupported()

For internal use only. Application developers should not use this

return true if LAYER_METADATA_NAME type is supported, else false

setLayerMetaViewStyleSupported

public void setLayerMetaViewStyleSupported(boolean supported)

For internal use only. Application developers should not use this

set flag for LAYER_METADATA_VIEWSTYLE type to true or false

isLayerMetaViewStyleSupported

public boolean isLayerMetaViewStyleSupported()

Specified by:

isLayerMetaViewStyleSupported in interface DataviewCommon

For internal use only. Application developers should not use this

return true if LAYER_METADATA_VIEWSTYLE type is supported, else false

setDataUnformattedSupported

public void setDataUnformattedSupported(boolean supported)

For internal use only. Application developers should not use this

set the flag for DATA_UNFORMATTED type true or false

isDataUnformattedSupported

public boolean isDataUnformattedSupported()

Specified by:

isDataUnformattedSupported in interface DataviewCommon

For internal use only. Application developers should not use this

return true if DATA_UNFORMATTED type is supported, else false

isDataViewFormatSupported

public boolean isDataViewFormatSupported()

Specified by:

isDataViewFormatSupported in interface DataviewCommon

Returns:

true if DATA_VIEWFORMAT is supported, else false

For internal use only. Application developers should not use this

repaint

public void repaint()

Specified by:

repaint in interface DataviewCommon

For internal use only. Application developers should not use this

getDataviewFootnote

public DataviewTitles getDataviewFootnote()

Retrieves the footnote for this view.

Specified by:

getDataviewFootnote in interface DataviewCommon

Returns:

The footnote for this view.

getDataviewSubtitle

public DataviewTitles getDataviewSubtitle()

Retrieves the subtitle for this view.

Specified by:

getDataviewSubtitle in interface DataviewCommon

Returns:

The subtitle for this view.

getDataviewTitle

public DataviewTitles getDataviewTitle()

Retrieves the title for this view.

Specified by:

getDataviewTitle in interface DataviewCommon

Returns:

The title for this view.

dataFormatChanged

public void dataFormatChanged()

Specified by:

dataFormatChanged in interface DataviewCommon

For internal use only. Application developers should not use this

Notifies the view that its data formats have changed. The format manager calls this method whenever the data format rules have been updated, in order to apply the new formats.

metadataStyleChanged

public void metadataStyleChanged()

Specified by:

metadataStyleChanged in interface DataviewCommon

For internal use only. Application developers should not use this

Notifies the view that its metadata styles have changed. The style manager calls this method whenever the metadata style rules have been updated, in order to apply the new styles.

dataStyleChanged

public void dataStyleChanged()

Specified by:

dataStyleChanged in interface DataviewCommon

For internal use only. Application developers should not use this

Notifies the view that its data styles have changed. The style manager calls this method whenever the data style rules have been updated, in order to apply the new styles.

setWaitDataForRow

public void setWaitDataForRow(int row,
                              WaitData waitData)

Specified by:

setWaitDataForRow in interface DataviewCommon

Parameters:

row - The index of the row that is waiting for data.

waitData - The WaitData object that you want to use to display a message in each cell on the row.

For internal use only. Application developers should not use this

Marks a specified row as waiting for data through lazy data fetch.

Application developers do not need to call this method.

getWaitDataForRow

public WaitData getWaitDataForRow(int row)

Specified by:

getWaitDataForRow in interface DataviewCommon

Parameters:

row - The index of the row that you want to know about.

Returns:

If the specified row is waiting for data, then this method will return a WaitData object for the row, otherwise this method will return null.

For internal use only. Application developers should not use this

Indicates whether the specified row is waiting for data through lazy data fetch.

Application developers do not need to call this method.

getWaitData

protected WaitData[] getWaitData()

clearWaitDataForAllRows

public void clearWaitDataForAllRows()

For internal use only. Application developers should not use this

Clears the list of rows that are waiting for data through lazy data fetch.

Application developers do not need to call this method.

getDataAccess

public DataAccess getDataAccess()

For internal use only. Application developers should not use this

setDataAccess

public void setDataAccess(DataAccess dataAccess)

getDataDirector

public DataDirector getDataDirector()

For internal use only. Application developers should not use this

setDataDirector

public void setDataDirector(DataDirector dataDirector)

For internal use only. Application developers should not use this

setLocalXMLDataSource

protected void setLocalXMLDataSource(LocalXMLDataSource ds)

For internal use only. Application developers should not use this

setGridData

public boolean setGridData(java.lang.Object[] columnLabels,
                           java.lang.Object[] rowLabels,
                           java.lang.Object[][] data)

Parameters:

columnLabels - labels for the columns of data; typically Strings

rowLabels - labels for the rows of data; typically Strings

data - values to be plotted in the dataview, indexed first by column, then by row

Returns:

true if data is successfully set on the dataview, false otherwise

For internal use only. Application developers should not use this

Set data on this CommonDataview. Data is provided in grid form, where the number of rows and columns are known ahead of time.

setGridData

protected boolean setGridData(java.lang.Object[] columnLabels,
                              java.lang.Object[] rowLabels,
                              java.lang.Object[][] data,
                              boolean bAllowNoData)

Parameters:

columnLabels - labels for the columns of data; typically Strings

rowLabels - labels for the rows of data; typically Strings

data - values to be plotted in the dataview, indexed first by column, then by row

bAllowNoData - true if empty or no data can be set, false if not

Returns:

true if data is successfully set on the dataview, false otherwise

For internal use only. Application developers should not use this

Set data on this CommonDataview. Data is provided in grid form, where the number of rows and columns are known ahead of time.

setTabularData

public boolean setTabularData(java.util.List tableRows)

Specifies data for the Graph, from a table of data. Use this method to provide data row-by-row, from a file of tab-delimited or comma-separated values, or from a JDBC ResultSet.

When you use this method, you extract values from the file or ResultSet, organize them, and then pass them all in one call to this method. The graph creates a grid of data from the data that you pass in, and it uses this grid to populate itself.

For each data value in the table or result set, you construct an array of three Objects:

• The object at index 0 is the label for the column, in the grid that the graph constructs, in which the data item belongs. This is normally a String. If the graph has a time axis, then this should be a Java Date. Column labels appear as group labels in the graph, unless DataRowShownAsASeries is false.
• The object at index 1 is the label for the row, in the grid that the graph constructs, in which the data item belongs. This is normally a String. Row labels appear as series labels in the graph (usually in the legend), unless DataRowShownAsASeries is false. In this case, if the graph has a time axis, then this should be a Java Date.
• The object at index 2 is the data value, usually a Double.

You add each Object array to a List (normally an ArrayList or a Vector). You pass the complete List to this method.

The following table shows a set of data to pass to the graph through this method:

Boston	Bowties	97300
Boston	Neckties	413812
Cleveland	Bowties	48025
Cleveland	Neckties	298511

The Object arrays would look like this, if you want the types of ties to appear in the legend (assuming that data rows in the grid represent series):

 Object[] tableRow1 = {"Boston", "Bowties", new Double(97300)};
 Object[] tableRow2 = {"Boston", "Neckties", new Double(413812)};
 Object[] tableRow3 = {"Cleveland", "Bowties", new Double(48025)};
 Object[] tableRow4 = {"Cleveland", "Neckties", new Double(298511)};

 // add the arrays to a List
 ArrayList data = new ArrayList();
 data.add(tableRow1);
 data.add(tableRow2);
 data.add(tableRow3);
 data.add(tableRow4);

 // pass the List to this method
 graph.setTabularData(data);
 

The grid that this method constructs and feeds to the graph looks like this:

	Boston	Cleveland
Bowties	97300	48025
Neckties	413812	298511

Note that the data is not interactive. If you want users to be able to rotate or drill, you will have to provide a way for them to express that intention, and you must call this method again to display the rearranged data.

Parameters:

tableRows - List of data to plot in the graph.

Returns:

true if data is successfully set on the graph, false if there is a data problem.

See Also:

#isDataRowShownAsASeries

setTabularData

protected boolean setTabularData(java.util.List tableRows,
                                 boolean bAllowNoData)

Parameters:

tableRows - List of data to plot in the graph.

bAllowNoData - true if empty or no data can be set, false if not

Returns:

true if data is successfully set on the graph, false if there is a data problem.

See Also:

#isDataRowShownAsASeries

For internal use only. Application developers should not use this

Specifies data for the Graph, from a table of data. Use this method to provide data row-by-row, from a file of tab-delimited or comma-separated values, or from a JDBC ResultSet.

When you use this method, you extract values from the file or ResultSet, organize them, and then pass them all in one call to this method. The graph creates a grid of data from the data that you pass in, and it uses this grid to populate itself.

For each data value in the table or result set, you construct an array of three Objects:

• The object at index 0 is the label for the column, in the grid that the graph constructs, in which the data item belongs. This is normally a String. If the graph has a time axis, then this should be a Java Date. Column labels appear as group labels in the graph, unless DataRowShownAsASeries is false.
• The object at index 1 is the label for the row, in the grid that the graph constructs, in which the data item belongs. This is normally a String. Row labels appear as series labels in the graph (usually in the legend), unless DataRowShownAsASeries is false. In this case, if the graph has a time axis, then this should be a Java Date.
• The object at index 2 is the data value, usually a Double.

You add each Object array to a List (normally an ArrayList or a Vector). You pass the complete List to this method.

The following table shows a set of data to pass to the graph through this method:

Boston	Bowties	97300
Boston	Neckties	413812
Cleveland	Bowties	48025
Cleveland	Neckties	298511

The Object arrays would look like this, if you want the types of ties to appear in the legend (assuming that data rows in the grid represent series):

 Object[] tableRow1 = {"Boston", "Bowties", new Double(97300)};
 Object[] tableRow2 = {"Boston", "Neckties", new Double(413812)};
 Object[] tableRow3 = {"Cleveland", "Bowties", new Double(48025)};
 Object[] tableRow4 = {"Cleveland", "Neckties", new Double(298511)};

 // add the arrays to a List
 ArrayList data = new ArrayList();
 data.add(tableRow1);
 data.add(tableRow2);
 data.add(tableRow3);
 data.add(tableRow4);

 // pass the List to this method
 graph.setTabularData(data);
 

The grid that this method constructs and feeds to the graph looks like this:

	Boston	Cleveland
Bowties	97300	48025
Neckties	413812	298511

Note that the data is not interactive. If you want users to be able to rotate or drill, you will have to provide a way for them to express that intention, and you must call this method again to display the rearranged data.

fillRelationalDataArrays

protected void fillRelationalDataArrays(int colCount,
                                        int rowCount,
                                        java.util.List colLabelsList,
                                        java.util.List rowLabelsList,
                                        java.util.Hashtable dataVals,
                                        java.lang.Object[] colLabels,
                                        java.lang.Object[] rowLabels,
                                        java.lang.Object[][] data)

Parameters:

colCount - the number of columns in the data set

rowCount - the number of rows in the data set

colLabelsList - list of column labels

rowLabelsList - list of row labels

dataVals - hashtable whose keys are (row label, column label) pairs, and whose values are the data values

colLabels - array to hold the column labels

rowLabels - array to hold the row labels

data - array to hold the data values

For internal use only. Application developers should not use this

This is a helper method for setting relational static data through the API or through XML. This method fills arrays of labels and data from the lists and hashtable that originally contain them.

isLogTabularMissingDataWarning

protected boolean isLogTabularMissingDataWarning()

Determine whether the warning for missing data values should be logged when setting tabular data. This method always returns true; subclasses may override as necessary.

Returns:

true to log warning messages for missing data, false to not log them

setHTMLPagingControlAutosubmit

public void setHTMLPagingControlAutosubmit(boolean autosubmit)

Specifies whether paging control changes are automatically submitted. By default, these changes are not submitted automatically. This property is used for the thin beans only.

Specified by:

setHTMLPagingControlAutosubmit in interface DataviewAttributes

Specified by:

setHTMLPagingControlAutosubmit in interface DataviewCommon

Parameters:

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

isHTMLPagingControlAutosubmit

public boolean isHTMLPagingControlAutosubmit()

Indicates whether paging control changes are automatically submitted. This property is used for the thin beans only.

Specified by:

isHTMLPagingControlAutosubmit in interface DataviewAttributes

Specified by:

isHTMLPagingControlAutosubmit in interface DataviewCommon

Returns:

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

setHTMLPagingControlWidth

public void setHTMLPagingControlWidth(int width)

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 DataviewAttributes

Specified by:

setHTMLPagingControlWidth in interface 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()

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 DataviewAttributes

Specified by:

getHTMLPagingControlWidth in interface DataviewCommon

Returns:

The number of page items to display before wrapping.

setName

public void setName(java.lang.String name)

Specified by:

setName in interface oracle.dss.presutil.CommonViewAttributes

getName

public java.lang.String getName()

Specified by:

getName in interface oracle.dss.presutil.CommonViewAttributes

setLocalName

public void setLocalName(java.lang.String name)

Specified by:

setLocalName in interface oracle.dss.presutil.CommonViewAttributes

getLocalName

public java.lang.String getLocalName()

Specified by:

getLocalName in interface oracle.dss.presutil.CommonViewAttributes

setDescription

public void setDescription(java.lang.String desc)

Specified by:

setDescription in interface oracle.dss.presutil.CommonViewAttributes

getDescription

public java.lang.String getDescription()

Specified by:

getDescription in interface oracle.dss.presutil.CommonViewAttributes

setDrillingEnabled

public void setDrillingEnabled(boolean b)

Specified by:

setDrillingEnabled in interface DataviewAttributes

isDrillingEnabled

public boolean isDrillingEnabled()

Specified by:

isDrillingEnabled in interface DataviewAttributes

isDrillingSupported

public boolean isDrillingSupported()

Specified by:

isDrillingSupported in interface DataviewAttributes

setPagingControlVisible

public void setPagingControlVisible(boolean v)

Specified by:

setPagingControlVisible in interface DataviewAttributes

Specified by:

setPagingControlVisible in interface DataviewCommon

isPagingControlVisible

public boolean isPagingControlVisible()

Specified by:

isPagingControlVisible in interface DataviewAttributes

Specified by:

isPagingControlVisible in interface DataviewCommon

setPagingControlPosition

public void setPagingControlPosition(int loc)

Specified by:

setPagingControlPosition in interface DataviewAttributes

getPagingControlPosition

public int getPagingControlPosition()

Specified by:

getPagingControlPosition in interface DataviewAttributes

setXMLValidated

public void setXMLValidated(boolean validate)

Specifies whether this Dataview validates XML against its DTD. By default, the table does not validate the XML. If there is a parsing error in the XML, then the Dataview. 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 Dataview ignore invalid XML.

See Also:

#setXML

isXMLValidated

public boolean isXMLValidated()

Indicates whether the Dataview validates XML against its DTD.

Returns:

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

getObjectNode

protected oracle.dss.util.xml.ObjectNode getObjectNode(java.lang.String objName,
                                                       boolean allProperties)

For internal use only. Application developers should not use this

getObjectNode

protected oracle.dss.util.xml.ObjectNode getObjectNode(java.lang.String objName,
                                                       boolean allProperties,
                                                       java.lang.String version)

For internal use only. Application developers should not use this

getXML

public java.lang.String getXML(java.lang.String objName,
                               boolean allProperties)

Retrieves the XML string for this Dataview. The XML can include values for all of the properties in the Dataview, 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 Dataview.

getViewXML

protected DataviewXML getViewXML()

For internal use only. Application developers should not use this

setViewXML

protected void setViewXML(DataviewXML viewXML)

For internal use only. Application developers should not use this

setDataSource

public void setDataSource(DataSource ds)

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

Parameters:

ds - The data source for this view.

convertComponentTypeToInteger

public int convertComponentTypeToInteger(java.lang.String type)

Description copied from interface: ComponentTypeConverter

Retrieves an integer representation of a view component, from a String.

Specified by:

convertComponentTypeToInteger in interface ComponentTypeConverter

For internal use only. Application developers should not use this

Method in interface ComponentTypeConvertor

convertComponentTypeToString

public java.lang.String convertComponentTypeToString(int type)

Description copied from interface: ComponentTypeConverter

Retrieves a String representation of a view component, from an integer.

Specified by:

convertComponentTypeToString in interface ComponentTypeConverter

Parameters:

type - An identifier for a view component.

For internal use only. Application developers should not use this

Method in interface ComponentTypeConvertor

getDataSource

public DataSource getDataSource()

Retrieves the data source for this view.

Specified by:

getDataSource in interface DataviewCommon

Returns:

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

getViewType

public int getViewType()

Specified by:

getViewType in interface DataviewCommon

Returns:

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

See Also:

DataviewConstants.VIEW_TYPE_CROSSTAB, DataviewConstants.VIEW_TYPE_GRAPH, DataviewConstants.VIEW_TYPE_TABLE

getFlashPlayerDownloadMessageHTML

public java.lang.String getFlashPlayerDownloadMessageHTML(java.lang.String version,
                                                          java.lang.String url)

Parameters:

version - required version

url - URL to get the Flash player

Returns:

String message indicating that the required version of the Flash player is not installed

For internal use only. Application developers should not use this

Get the HTML message to display indicating that the required version of the Flash player is not installed. The given URL will be included as a link in the message text.

createPropertyOverrideFlags

public java.util.BitSet createPropertyOverrideFlags(int maxID)

Specified by:

createPropertyOverrideFlags in interface DataviewCommon

For internal use only. Application developers should not use this

create a property overridden flags

setPropertyOverrideFlags

public void setPropertyOverrideFlags(int attrID,
                                     java.util.BitSet userFlags,
                                     java.util.BitSet styleFlags)

Specified by:

setPropertyOverrideFlags in interface DataviewCommon

For internal use only. Application developers should not use this

set a property's overridden if userOverrideMode is true, set the property user overridden flag if styleOverrideMode is true, set the property style overridden flag

getTokenSubstitution

public TokenSubstitution getTokenSubstitution()

Description copied from interface: DataviewCommon

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 DataviewCommon

Returns:

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

For internal use only. Application developers should not use this

setTokenSubstitution

public void setTokenSubstitution(TokenSubstitution token)

Description copied from interface: DataviewCommon

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 DataviewCommon

Parameters:

token - The token substitution handler for this view.

isPropertyOverrideFlag

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

Specified by:

isPropertyOverrideFlag in interface DataviewCommon

For internal use only. Application developers should not use this

check to see if a property is overridden

clearPropertyOverrideFlag

public void clearPropertyOverrideFlag(int attrID,
                                      java.util.BitSet overrideFlags)

For internal use only. Application developers should not use this

clear a property's override flag

setStyleOverrideMode

protected void setStyleOverrideMode(boolean flag)

For internal use only. Application developers should not use this

start or stop computing styleOverrideFlags.

isStyleOverrideMode

protected boolean isStyleOverrideMode()

For internal use only. Application developers should not use this

are we computing styleOverrideFlags?

isStyleModified

protected boolean isStyleModified()

For internal use only. Application developers should not use this

is style modified?

clearStyleModified

protected void clearStyleModified()

For internal use only. Application developers should not use this

clear style modified flag

setUserOverrideMode

protected void setUserOverrideMode(boolean flag)

For internal use only. Application developers should not use this

start or stop computing userOverrideFlags.

isUserOverrideMode

protected boolean isUserOverrideMode()

For internal use only. Application developers should not use this

are we computing userOverrideFlags?

isEdgeValid

protected boolean isEdgeValid(int edge)

Determine if the given edge is valid.

Parameters:

edge - id representing the edge (constants are defined in DataDirector)

Returns:

true if the edge is valid, false if not

convertAnimationOnDataChangeToInt

public static int convertAnimationOnDataChangeToInt(java.lang.String type)

For internal use only. Application developers should not use this

convertAnimationOnDataChangeToString

public static java.lang.String convertAnimationOnDataChangeToString(int type)

For internal use only. Application developers should not use this

convertAnimationIndicatorsToInt

public static int convertAnimationIndicatorsToInt(java.lang.String type)

For internal use only. Application developers should not use this

convertAnimationIndicatorsToString

public static java.lang.String convertAnimationIndicatorsToString(int type)

For internal use only. Application developers should not use this

convertAnimationOnDisplayToInt

public static int convertAnimationOnDisplayToInt(java.lang.String type)

For internal use only. Application developers should not use this

convertAnimationOnDisplayToString

public static java.lang.String convertAnimationOnDisplayToString(int type)

For internal use only. Application developers should not use this

convertVisualEffectsToInt

public static int convertVisualEffectsToInt(java.lang.String type)

For internal use only. Application developers should not use this

convertVisualEffectsToString

public static java.lang.String convertVisualEffectsToString(int type)

For internal use only. Application developers should not use this