public class CommonDataview extends java.lang.Object implements DataviewCommon, DataviewConstants, DataviewAttributes
Modifier and Type | Class and Description |
---|---|
static class |
CommonDataview.DefaultAttributeFormatter |
protected static class |
CommonDataview.NullObject |
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
a_all |
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_auto |
static java.lang.String |
a_interactiveSliceBehavior |
static java.lang.String |
a_none |
static java.lang.String |
a_off |
static java.lang.String |
a_on |
static java.lang.String |
a_visualEffects |
static java.lang.String |
ad_alpha_fade |
static java.lang.String |
ad_auto |
static java.lang.String |
ad_conveyor_from_left |
static java.lang.String |
ad_conveyor_from_right |
static java.lang.String |
ad_cube_to_left |
static java.lang.String |
ad_cube_to_right |
static java.lang.String |
ad_flip_left |
static java.lang.String |
ad_flip_right |
static java.lang.String |
ad_none |
static java.lang.String |
ad_slide_to_left |
static java.lang.String |
ad_slide_to_right |
static java.lang.String |
ad_transition_to_left |
static java.lang.String |
ad_transition_to_right |
static java.lang.String |
ad_zoom |
static java.lang.String |
adc_alpha_fade |
static java.lang.String |
adc_auto |
static java.lang.String |
adc_conveyor_from_left |
static java.lang.String |
adc_conveyor_from_right |
static java.lang.String |
adc_cube_to_left |
static java.lang.String |
adc_cube_to_right |
static java.lang.String |
adc_flip_left |
static java.lang.String |
adc_flip_right |
static java.lang.String |
adc_none |
static java.lang.String |
adc_on |
static java.lang.String |
adc_slide_to_left |
static java.lang.String |
adc_slide_to_right |
static java.lang.String |
adc_transition_to_left |
static java.lang.String |
adc_transition_to_right |
static java.lang.String |
adc_zoom |
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 |
above_title, AD_ALPHA_FADE, AD_AUTO, AD_CONVEYOR_FROM_LEFT, AD_CONVEYOR_FROM_RIGHT, AD_CUBE_TO_LEFT, AD_CUBE_TO_RIGHT, AD_FLIP_LEFT, AD_FLIP_RIGHT, AD_MAX, AD_MIN, AD_NONE, AD_SLIDE_TO_LEFT, AD_SLIDE_TO_RIGHT, AD_TRANSITION_TO_LEFT, AD_TRANSITION_TO_RIGHT, AD_ZOOM, ADC_ALPHA_FADE, ADC_AUTO, ADC_CONVEYOR_FROM_LEFT, ADC_CONVEYOR_FROM_RIGHT, ADC_CUBE_TO_LEFT, ADC_CUBE_TO_RIGHT, ADC_FLIP_LEFT, ADC_FLIP_RIGHT, ADC_MAX, ADC_MIN, ADC_NONE, ADC_ON, ADC_SLIDE_TO_LEFT, ADC_SLIDE_TO_RIGHT, ADC_TRANSITION_TO_LEFT, ADC_TRANSITION_TO_RIGHT, ADC_ZOOM, 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, below_title, 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, MAX_TEXTFIELD_CHARS, 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 and Description |
---|
CommonDataview(java.util.Locale loc) |
CommonDataview(java.util.Locale loc,
ErrorHandler handler) |
Modifier and Type | Method and Description |
---|---|
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) |
AttributeFormatter |
getAttributeFormatter() |
java.util.Map<java.lang.Object,java.lang.Object> |
getContext() |
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 |
setAttributeFormatter(AttributeFormatter attributeFormatter) |
void |
setContext(java.util.Map<java.lang.Object,java.lang.Object> context) |
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() |
@Concealed protected FontList fontList
@Concealed protected transient ErrorHandler m_eh
@Concealed protected ThickDataview m_thickView
@Concealed protected DataviewXML m_viewXML
@Concealed protected java.lang.String[] m_memberMetadataLabelTypes
@Concealed protected java.lang.String[] m_layerMetadataLabelTypes
@Concealed protected WaitData[] m_waitDataForRows
@Concealed protected boolean m_dataUnformattedSupported
@Concealed protected boolean m_metaDateSupported
@Concealed protected boolean m_metaLonglabelSupported
@Concealed protected boolean m_metaMediumlabelSupported
@Concealed protected boolean m_metaShortlabelSupported
@Concealed protected boolean m_metaViewStyleSupported
@Concealed protected boolean m_metaValueSupported
@Concealed protected boolean m_layermetaShortlabelSupported
@Concealed protected boolean m_layermetaMediumlabelSupported
@Concealed protected boolean m_layermetaLonglabelSupported
@Concealed protected boolean m_layermetaNameSupported
@Concealed protected boolean m_layermetaViewStyleSupported
@Concealed protected transient oracle.dss.util.persistence.PersistableAttributes m_attrs
PersistableAttributes
component of this view.
This structure holds searchable attributes relevant to this view.protected java.util.ResourceBundle m_dvStrings
@Concealed protected boolean m_htmlPagingControlAutosubmit
@Concealed protected int m_htmlPagingControlWidth
@Concealed protected java.lang.String m_name
@Concealed protected java.lang.String m_localName
@Concealed protected java.lang.String m_description
@Concealed protected int m_pagingControlPosition
@Concealed protected boolean m_pagingVisible
@Concealed protected boolean m_validate
@Concealed public static final java.lang.String a_animationOnDataChange
@Concealed public static final java.lang.String a_animationIndicators
@Concealed public static final java.lang.String a_animationUpColor
@Concealed public static final java.lang.String a_animationDownColor
@Concealed public static final java.lang.String a_animationDuration
@Concealed public static final java.lang.String a_animationOnDisplay
@Concealed public static final java.lang.String a_visualEffects
@Concealed public static final java.lang.String a_interactiveSliceBehavior
@Concealed public static final java.lang.String adc_none
@Concealed public static final java.lang.String adc_auto
@Concealed public static final java.lang.String adc_on
@Concealed public static final java.lang.String adc_alpha_fade
@Concealed public static final java.lang.String adc_conveyor_from_right
@Concealed public static final java.lang.String adc_conveyor_from_left
@Concealed public static final java.lang.String adc_cube_to_right
@Concealed public static final java.lang.String adc_cube_to_left
@Concealed public static final java.lang.String adc_flip_right
@Concealed public static final java.lang.String adc_flip_left
@Concealed public static final java.lang.String adc_slide_to_right
@Concealed public static final java.lang.String adc_slide_to_left
@Concealed public static final java.lang.String adc_transition_to_right
@Concealed public static final java.lang.String adc_transition_to_left
@Concealed public static final java.lang.String adc_zoom
@Concealed public static final java.lang.String ai_none
@Concealed public static final java.lang.String ai_all
@Concealed public static final java.lang.String ad_none
@Concealed public static final java.lang.String ad_auto
@Concealed public static final java.lang.String ad_alpha_fade
@Concealed public static final java.lang.String ad_conveyor_from_right
@Concealed public static final java.lang.String ad_conveyor_from_left
@Concealed public static final java.lang.String ad_cube_to_right
@Concealed public static final java.lang.String ad_cube_to_left
@Concealed public static final java.lang.String ad_flip_right
@Concealed public static final java.lang.String ad_flip_left
@Concealed public static final java.lang.String ad_slide_to_right
@Concealed public static final java.lang.String ad_slide_to_left
@Concealed public static final java.lang.String ad_transition_to_right
@Concealed public static final java.lang.String ad_transition_to_left
@Concealed public static final java.lang.String ad_zoom
@Concealed public static final java.lang.String ve_none
@Concealed public static final java.lang.String ve_auto
@Concealed public static final java.lang.String ve_shadow
@Concealed public static final java.lang.String ve_glow
@Concealed public static final java.lang.String ve_bevel
@Concealed public static final java.lang.String a_none
@Concealed public static final java.lang.String a_all
@Concealed public static final java.lang.String a_auto
@Concealed public static final java.lang.String a_on
@Concealed public static final java.lang.String a_off
@Concealed protected static final java.lang.String m_method_setName
@Concealed protected static final java.lang.String m_method_setLocalName
@Concealed protected static final java.lang.String m_method_setDescription
@Concealed protected static final java.lang.String m_method_fillRelationalDataArrays
public CommonDataview(java.util.Locale loc)
public CommonDataview(java.util.Locale loc, ErrorHandler handler)
public void addErrorHandler(ErrorHandler eh)
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
.
eh
- The error handler to use.public void removeErrorHandler()
Model
.
The default error handler prints information to the console.@Concealed public ErrorHandler getErrorHandler()
DataviewCommon
getErrorHandler
in interface DataviewCommon
@Concealed public FontList getFontList()
getFontList
in interface DataviewCommon
@Concealed public int getZoomFactor()
getZoomFactor
in interface DataviewCommon
scaleFont
method.@Concealed public java.lang.String getVersion()
@Concealed public java.awt.Font scaleFont(java.awt.Font f, int zoomFactor)
scaleFont
in interface DataviewCommon
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())
.@Concealed public java.lang.String getIntlString(java.lang.String key)
getIntlString
in interface DataviewCommon
key
- the String that needs to be translated.@Concealed public java.lang.String getIntlString(java.lang.String key, java.util.ResourceBundle rBundle)
getIntlString
in interface DataviewCommon
key
- the String that needs to be translated.rBundle
- the bundle to look in@Concealed public void setThickDataview(ThickDataview view)
@Concealed public ThickDataview getThickDataview()
@Concealed protected void updateResourceBundle()
protected static java.util.ResourceBundle getDataviewResourceBundle(java.util.Locale loc) throws java.util.MissingResourceException
java.util.MissingResourceException
public java.util.Locale getLocale()
DataviewCommon
Locale
for this DataviewCommon
.getLocale
in interface DataviewCommon
public void setLocale(java.util.Locale loc)
Locale
for this Graph
.loc
- The Locale
for this Graph
.public Model getModel()
DataviewCommon
DataviewCommon
.
The model represents the data that this DataviewCommon
displays.getModel
in interface DataviewCommon
DataviewCommon
.public void setModel(Model model)
public void setPersistableAttributes(oracle.dss.util.persistence.PersistableAttributes attrs)
Dataview
itself can be used as
persistable attributes.attrs
- Any PersistableAttributes
.public oracle.dss.util.persistence.AggregateInfo[] getPersistableComponents()
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.
Dataview
, in an
AggregateInfo
array.@Concealed public void setPersistableComponents(oracle.dss.util.persistence.AggregateInfo[] persistables)
aggregates
- a AggregateInfo[]
value that represents the
components to assign to the view.public void setMemberMetadataLabelType(int edge, java.lang.String type)
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.
setMemberMetadataLabelType
in interface DataviewAttributes
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".DataDirector.COLUMN_EDGE
,
DataDirector.ROW_EDGE
,
DataDirector.PAGE_EDGE
,
MetadataMap.METADATA_LONGLABEL
,
MetadataMap.METADATA_MEDIUMLABEL
,
MetadataMap.METADATA_SHORTLABEL
,
MetadataMap.METADATA_VALUE
,
DataDirector.getSupportedMetadataMap()
public java.lang.String getMemberMetadataLabelType(int edge)
METADATA_LONGLABEL
.
Returns null
if the specified edge is invalid.getMemberMetadataLabelType
in interface DataviewAttributes
getMemberMetadataLabelType
in interface DataviewCommon
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".DataDirector.COLUMN_EDGE
,
DataDirector.ROW_EDGE
,
DataDirector.PAGE_EDGE
,
MetadataMap.METADATA_LONGLABEL
,
MetadataMap.METADATA_MEDIUMLABEL
,
MetadataMap.METADATA_SHORTLABEL
,
MetadataMap.METADATA_VALUE
@Concealed public boolean isMemberMetadataLabelTypeSupported(java.lang.String type)
isMemberMetadataLabelTypeSupported
in interface DataviewCommon
type
- type of member metadata labelpublic void setMemberMetadataLabelType(java.lang.String type)
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.
type
- A constant that represents the type of metadata label to show.
Valid constants are listed in the See Also section.setMemberMetadataLabelType(int, String)
,
MetadataMap.METADATA_LONGLABEL
,
MetadataMap.METADATA_MEDIUMLABEL
,
MetadataMap.METADATA_SHORTLABEL
,
MetadataMap.METADATA_VALUE
,
DataDirector.getSupportedMetadataMap()
public java.lang.String getMemberMetadataLabelType()
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
.null
if different
label types are used for different edges.getMemberMetadataLabelType(int)
,
MetadataMap.METADATA_LONGLABEL
,
MetadataMap.METADATA_MEDIUMLABEL
,
MetadataMap.METADATA_SHORTLABEL
,
MetadataMap.METADATA_VALUE
public void setLayerMetadataLabelType(java.lang.String type)
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.
type
- A constant that represents the type of layer metadata label to show.
Valid constants are listed in the See Also section.setLayerMetadataLabelType(int, String)
,
LayerMetadataMap.LAYER_METADATA_LONGLABEL
,
LayerMetadataMap.LAYER_METADATA_MEDIUMLABEL
,
LayerMetadataMap.LAYER_METADATA_SHORTLABEL
,
LayerMetadataMap.LAYER_METADATA_NAME
,
DataDirector.getSupportedLayerMetadataMap()
@Concealed public boolean isMetadataViewStyleSupported()
isMetadataViewStyleSupported
in interface DataviewCommon
@Concealed public void setMetadataViewStyleSupported(boolean supported)
@Concealed public void setMetadataDateSupported(boolean supported)
@Concealed public boolean isMetadataDateSupported()
public java.lang.String getLayerMetadataLabelType()
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
.null
if
different edges use different label types.getLayerMetadataLabelType(int)
,
LayerMetadataMap.LAYER_METADATA_LONGLABEL
,
LayerMetadataMap.LAYER_METADATA_MEDIUMLABEL
,
LayerMetadataMap.LAYER_METADATA_SHORTLABEL
,
LayerMetadataMap.LAYER_METADATA_NAME
public void setLayerMetadataLabelType(int edge, java.lang.String type)
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.
setLayerMetadataLabelType
in interface DataviewAttributes
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".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()
public java.lang.String getLayerMetadataLabelType(int edge)
LAYER_METADATA_LONGLABEL
.
Returns null
if the given edge is invalid.getLayerMetadataLabelType
in interface DataviewAttributes
getLayerMetadataLabelType
in interface DataviewCommon
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".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
@Concealed public void setMetadataLongLabelSupported(boolean supported)
@Concealed public boolean isMetadataLongLabelSupported()
@Concealed public void setMetadataMediumLabelSupported(boolean supported)
@Concealed public boolean isMetadataMediumLabelSupported()
@Concealed public void setMetadataShortLabelSupported(boolean supported)
@Concealed public boolean isMetadataShortLabelSupported()
isMetadataShortLabelSupported
in interface DataviewCommon
@Concealed public void setMetadataValueSupported(boolean supported)
@Concealed public boolean isMetadataValueSupported()
@Concealed public boolean isLayerMetadataLabelTypeSupported(java.lang.String type)
isLayerMetadataLabelTypeSupported
in interface DataviewCommon
type
- type of layer metadata label@Concealed public void setLayerMetaLongLabelSupported(boolean supported)
@Concealed public boolean isLayerMetaLongLabelSupported()
@Concealed public void setLayerMetaMediumLabelSupported(boolean supported)
@Concealed public boolean isLayerMetaMediumLabelSupported()
@Concealed public void setLayerMetaShortLabelSupported(boolean supported)
@Concealed public boolean isLayerMetaShortLabelSupported()
isLayerMetaShortLabelSupported
in interface DataviewCommon
@Concealed public void setLayerMetaNameSupported(boolean supported)
@Concealed public boolean isLayerMetaNameSupported()
@Concealed public void setLayerMetaViewStyleSupported(boolean supported)
@Concealed public boolean isLayerMetaViewStyleSupported()
isLayerMetaViewStyleSupported
in interface DataviewCommon
@Concealed public void setDataUnformattedSupported(boolean supported)
@Concealed public boolean isDataUnformattedSupported()
isDataUnformattedSupported
in interface DataviewCommon
@Concealed public boolean isDataViewFormatSupported()
isDataViewFormatSupported
in interface DataviewCommon
@Concealed public void repaint()
repaint
in interface DataviewCommon
public DataviewTitles getDataviewFootnote()
getDataviewFootnote
in interface DataviewCommon
public DataviewTitles getDataviewSubtitle()
getDataviewSubtitle
in interface DataviewCommon
public DataviewTitles getDataviewTitle()
getDataviewTitle
in interface DataviewCommon
@Concealed public void dataFormatChanged()
dataFormatChanged
in interface DataviewCommon
@Concealed public void metadataStyleChanged()
metadataStyleChanged
in interface DataviewCommon
@Concealed public void dataStyleChanged()
dataStyleChanged
in interface DataviewCommon
@Concealed public void setWaitDataForRow(int row, WaitData waitData)
setWaitDataForRow
in interface DataviewCommon
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.Application developers do not need to call this method.
@Concealed public WaitData getWaitDataForRow(int row)
getWaitDataForRow
in interface DataviewCommon
row
- The index of the row that you want to know about.WaitData
object for the row, otherwise this
method will return null
.Application developers do not need to call this method.
protected WaitData[] getWaitData()
@Concealed public void clearWaitDataForAllRows()
Application developers do not need to call this method.
@Concealed public DataAccess getDataAccess()
public void setDataAccess(DataAccess dataAccess)
@Concealed public DataDirector getDataDirector()
@Concealed public void setDataDirector(DataDirector dataDirector)
@Concealed protected void setLocalXMLDataSource(LocalXMLDataSource ds)
@Concealed public boolean setGridData(java.lang.Object[] columnLabels, java.lang.Object[] rowLabels, java.lang.Object[][] data)
columnLabels
- labels for the columns of data;
typically String
srowLabels
- labels for the rows of data;
typically String
sdata
- values to be plotted in the dataview, indexed
first by column, then by rowtrue
if data is successfully set on the dataview,
false
otherwiseCommonDataview
.
Data is provided in grid form, where the number of rows and
columns are known ahead of time.@Concealed protected boolean setGridData(java.lang.Object[] columnLabels, java.lang.Object[] rowLabels, java.lang.Object[][] data, boolean bAllowNoData)
columnLabels
- labels for the columns of data;
typically String
srowLabels
- labels for the rows of data;
typically String
sdata
- values to be plotted in the dataview, indexed
first by column, then by rowbAllowNoData
- true if empty or no data can be set, false if nottrue
if data is successfully set on the dataview,
false
otherwiseCommonDataview
.
Data is provided in grid form, where the number of rows and
columns are known ahead of time.public boolean setTabularData(java.util.List tableRows)
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
:
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
.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
.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 aList
ArrayList data = new ArrayList(); data.add(tableRow1); data.add(tableRow2); data.add(tableRow3); data.add(tableRow4); // pass theList
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.
tableRows
- List
of data to plot in the graph.true
if data is successfully set on the graph,
false
if there is a data problem.#isDataRowShownAsASeries
@Concealed protected boolean setTabularData(java.util.List tableRows, boolean bAllowNoData)
tableRows
- List
of data to plot in the graph.bAllowNoData
- true if empty or no data can be set, false if nottrue
if data is successfully set on the graph,
false
if there is a data problem.#isDataRowShownAsASeries
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
:
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
.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
.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 aList
ArrayList data = new ArrayList(); data.add(tableRow1); data.add(tableRow2); data.add(tableRow3); data.add(tableRow4); // pass theList
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.
@Concealed 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)
colCount
- the number of columns in the data setrowCount
- the number of rows in the data setcolLabelsList
- list of column labelsrowLabelsList
- list of row labelsdataVals
- hashtable whose keys are (row label, column label) pairs,
and whose values are the data valuescolLabels
- array to hold the column labelsrowLabels
- array to hold the row labelsdata
- array to hold the data valuesprotected boolean isLogTabularMissingDataWarning()
public void setHTMLPagingControlAutosubmit(boolean autosubmit)
setHTMLPagingControlAutosubmit
in interface DataviewAttributes
setHTMLPagingControlAutosubmit
in interface DataviewCommon
autosubmit
- true
to enable automatic submission,
false
to disable it.public boolean isHTMLPagingControlAutosubmit()
isHTMLPagingControlAutosubmit
in interface DataviewAttributes
isHTMLPagingControlAutosubmit
in interface DataviewCommon
true
if changes are automatically submitted,
false
if they are not.public void setHTMLPagingControlWidth(int width)
setHTMLPagingControlWidth
in interface DataviewAttributes
setHTMLPagingControlWidth
in interface DataviewCommon
width
- The number of page items to display before wrapping.
To display all page items on the same line, pass -1.public int getHTMLPagingControlWidth()
getHTMLPagingControlWidth
in interface DataviewAttributes
getHTMLPagingControlWidth
in interface DataviewCommon
public void setName(java.lang.String name)
setName
in interface oracle.dss.presutil.CommonViewAttributes
public java.lang.String getName()
getName
in interface oracle.dss.presutil.CommonViewAttributes
public void setLocalName(java.lang.String name)
setLocalName
in interface oracle.dss.presutil.CommonViewAttributes
public java.lang.String getLocalName()
getLocalName
in interface oracle.dss.presutil.CommonViewAttributes
public void setDescription(java.lang.String desc)
setDescription
in interface oracle.dss.presutil.CommonViewAttributes
public java.lang.String getDescription()
getDescription
in interface oracle.dss.presutil.CommonViewAttributes
public void setDrillingEnabled(boolean b)
setDrillingEnabled
in interface DataviewAttributes
public boolean isDrillingEnabled()
isDrillingEnabled
in interface DataviewAttributes
public boolean isDrillingSupported()
isDrillingSupported
in interface DataviewAttributes
public void setPagingControlVisible(boolean v)
setPagingControlVisible
in interface DataviewAttributes
setPagingControlVisible
in interface DataviewCommon
public boolean isPagingControlVisible()
isPagingControlVisible
in interface DataviewAttributes
isPagingControlVisible
in interface DataviewCommon
public void setPagingControlPosition(int loc)
setPagingControlPosition
in interface DataviewAttributes
public int getPagingControlPosition()
getPagingControlPosition
in interface DataviewAttributes
public void setXMLValidated(boolean validate)
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.validate
- true
to have XML validated,
false
to have the Dataview
ignore invalid XML.#setXML
public boolean isXMLValidated()
Dataview
validates XML against its DTD.true
if the Dataview
validates XML,
false
if the Dataview
applies XML without validation.@Concealed protected oracle.dss.util.xml.ObjectNode getObjectNode(java.lang.String objName, boolean allProperties)
@Concealed protected oracle.dss.util.xml.ObjectNode getObjectNode(java.lang.String objName, boolean allProperties, java.lang.String version)
public java.lang.String getXML(java.lang.String objName, boolean allProperties)
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.
allProperties
- true
to retrieve XML for all properties,
false
to retrieve XML only for
properties whose values are different from the
default property values.Dataview
.@Concealed protected DataviewXML getViewXML()
@Concealed protected void setViewXML(DataviewXML viewXML)
public void setDataSource(DataSource ds)
Model
class in a presentation bean represents the
DataSource
to the view, but the DataSource
is the real source of the data.setDataSource
in interface DataviewCommon
ds
- The data source for this view.@Concealed public int convertComponentTypeToInteger(java.lang.String type)
ComponentTypeConverter
String
.convertComponentTypeToInteger
in interface ComponentTypeConverter
@Concealed public java.lang.String convertComponentTypeToString(int type)
ComponentTypeConverter
String
representation of a view component,
from an integer.convertComponentTypeToString
in interface ComponentTypeConverter
type
- An identifier for a view component.public DataSource getDataSource()
getDataSource
in interface DataviewCommon
DataSource
for this view.
If no model or data source has been set for this view,
this method returns null
.public int getViewType()
getViewType
in interface DataviewCommon
DataviewConstants.VIEW_TYPE_CROSSTAB
,
DataviewConstants.VIEW_TYPE_GRAPH
,
DataviewConstants.VIEW_TYPE_TABLE
@Concealed public java.lang.String getFlashPlayerDownloadMessageHTML(java.lang.String version, java.lang.String url)
version
- required versionurl
- URL to get the Flash player@Concealed public java.util.BitSet createPropertyOverrideFlags(int maxID)
createPropertyOverrideFlags
in interface DataviewCommon
@Concealed public void setPropertyOverrideFlags(int attrID, java.util.BitSet userFlags, java.util.BitSet styleFlags)
setPropertyOverrideFlags
in interface DataviewCommon
@Concealed public TokenSubstitution getTokenSubstitution()
DataviewCommon
TokenSubstitution
.getTokenSubstitution
in interface DataviewCommon
TokenSubstitutionAdapter
.public void setTokenSubstitution(TokenSubstitution token)
DataviewCommon
TokenSubstitution
.
You need to call this method only if you provide your own handler for
allowing users to insert tokens.setTokenSubstitution
in interface DataviewCommon
token
- The token substitution handler for this view.@Concealed public boolean isPropertyOverrideFlag(int attrID, java.util.BitSet overrideFlags)
isPropertyOverrideFlag
in interface DataviewCommon
@Concealed public void clearPropertyOverrideFlag(int attrID, java.util.BitSet overrideFlags)
@Concealed protected void setStyleOverrideMode(boolean flag)
@Concealed protected boolean isStyleOverrideMode()
@Concealed protected boolean isStyleModified()
@Concealed protected void clearStyleModified()
@Concealed protected void setUserOverrideMode(boolean flag)
@Concealed protected boolean isUserOverrideMode()
protected boolean isEdgeValid(int edge)
edge
- id representing the edge (constants are defined in DataDirector)@Concealed public void setAttributeFormatter(AttributeFormatter attributeFormatter)
formatter
- to be applied.@Concealed public AttributeFormatter getAttributeFormatter()
@Concealed public java.util.Map<java.lang.Object,java.lang.Object> getContext()
@Concealed public void setContext(java.util.Map<java.lang.Object,java.lang.Object> context)
@Concealed public static int convertAnimationOnDataChangeToInt(java.lang.String type)
@Concealed public static java.lang.String convertAnimationOnDataChangeToString(int type)
@Concealed public static int convertAnimationIndicatorsToInt(java.lang.String type)
@Concealed public static java.lang.String convertAnimationIndicatorsToString(int type)
@Concealed public static int convertAnimationOnDisplayToInt(java.lang.String type)
@Concealed public static java.lang.String convertAnimationOnDisplayToString(int type)
@Concealed public static int convertVisualEffectsToInt(java.lang.String type)
@Concealed public static java.lang.String convertVisualEffectsToString(int type)