oracle.dss.gauge
Class Gauge

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JPanel
                  oracle.dss.dataView.Dataview
                      oracle.dss.gauge.Gauge

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.beans.PropertyChangeListener, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible, DataviewAttributes, DataviewCommon, DataviewConstants, ModelListener, ThickDataview, UIDataview, UIView, GaugeAttributes, GaugeConstants, GaugeSetAttributes, ThickGauge, oracle.dss.presutil.CommonViewAttributes, ComponentTypeConverter, ErrorHandlerCallback, PagingControlAttributes, oracle.dss.util.persistence.CatLinkNode, oracle.dss.util.persistence.CatNode, oracle.dss.util.persistence.contract.AggregableContract, oracle.dss.util.persistence.contract.CustomXMLContract, oracle.dss.util.persistence.contract.OptionalContract, oracle.dss.util.persistence.Persistable, oracle.dss.util.persistence.SimplePersistable, oracle.dss.util.persistence.StringXMLizable

public class Gauge
extends Dataview
implements GaugeConstants, java.beans.PropertyChangeListener, ThickGauge

The gauge bean class.

To display data in these gauges, call its setDataSource method, or use the constructor that takes a data source as an argument. You can use the BI Beans DataSource bean, or you can supply your own data source. The DataAccess and DataAccess interfaces, in the oracle.dss.util package, define the methods and constants that a data source must provide.

Alternately, you can call setTabularData to set data that you get from a comma-separated or tab-delimited file, or from a JDBC ResultSet. Note that, when you use setTabularData, the data is not dynamic.

You can set properties on these gauges to customize their appearance and behavior.

The BI Beans also provide Java-client user interface classes for setting the gauge type, configuring layout of the gauge set, and so on. The Java-client user-interface classes are in the oracle.dss.gauge.gui package. * @version $Header: Gauge.java 18-may-2007.15:18:49 bglazer Exp $

Since:

11.0

See Also:

setTabularData(java.lang.Object[], java.util.List), DataAccess, DataDirector, Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JPanel

javax.swing.JPanel.AccessibleJPanel

Nested classes/interfaces inherited from class javax.swing.JComponent

javax.swing.JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Nested classes/interfaces inherited from interface oracle.dss.gauge.GaugeConstants

GaugeConstants.HorizontalAlignment

Field Summary

protected GaugeController	_gaugeController
protected GaugeModel	_gaugeModel
protected GaugePanel	_gaugePanel
protected java.awt.Image	_offscreenImage
protected boolean	_printOrPreviewMode
protected boolean	_stopRepaints

Fields inherited from class oracle.dss.dataView.Dataview

a_description, a_localName, a_name, a_pagingControlVisible, a_swapAllowed, a_version, above_title, below_title, boundSupport, d_description, d_localName, d_name, d_pagingControlVisible, d_swapAllowed, footnotePanel, listenerList, m_attrs, m_bSuperCalled, m_commonDataview, m_context, m_customColorsEnabled, m_dataviewFootnote, m_dataViewFormatSupported, m_dataviewSubtitle, m_dataviewTitle, m_method_readXML, m_method_resetToDefault, m_method_setpagingcontrolposition, m_method_setViewStyle, m_method_setXML, m_stopRepaints, m_tokenSubstitution, MAX_TEXTFIELD_CHARS, pagingControl, printOrPreviewMode, propertyChangeListenerList, subcomponent, titlePanel, undoSupport, vetoableChangeListenerList, vetoSupport

Fields inherited from class javax.swing.JComponent

accessibleContext, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface oracle.dss.gauge.GaugeConstants

a_horizontalAlignment, CSP_BEVELED_CIRCLE, CSP_FULL_CIRCLE, CSP_ROUNDED_RECTANGLE, DIAL, GAUGE, GAUGE_TYPE, GSA_BOTTOM, GSA_BOTTOMLEFT, GSA_BOTTOMRIGHT, GSA_CENTER, GSA_LEFT, GSA_NONE, GSA_RIGHT, GSA_TOP, GSA_TOPLEFT, GSA_TOPRIGHT, GSALIGNMENT_MAX, GSALIGNMENT_MIN, GSC_AUTO, GSCOLCOUNT_MAX, GSD_ACROSS, GSD_DOWN, GSDIRECTION_MAX, GSDIRECTION_MIN, ID_BACKGROUND, ID_BOTTOMLABEL, ID_ELEMENTA, ID_ELEMENTB, ID_GAUGEFRAME, ID_GAUGESETBACKGROUND, ID_GAUGESETTITLE, ID_INDICATOR, ID_INDICATORBAR, ID_INDICATORBASE, ID_INTERSECTIONAB, ID_LEGENDAREA, ID_LEGENDTEXT, ID_LEGENDTITLE, ID_LOWERLABELFRAME, ID_LOWERREFLECTION, ID_METRICLABEL, ID_OVERLAY, ID_PLOTAREA, ID_THRESHOLD, ID_TICKLABEL, ID_TICKMARK, ID_TITLESEPARATOR, ID_TOOLTIPS, ID_TOPLABEL, ID_UPPERLABELFRAME, LABELGAUGE, LED, OFFCENTER_DISTANCE, STATUSMETER, SVG_MODE_BASIC, SVG_MODE_DRILLING, SVG_MODE_FONT_EMBEDDING, SVG_MODE_FULL, SVG_MODE_NO_HEADER, SVG_MODE_SHAPE_ATTRIBUTES, SVG_MODE_TOOLTIPS, TYPE_MAX, TYPE_MIN, UNDEFINED, VENN, VERTICALSTATUSMETER

Fields inherited from interface oracle.dss.gauge.GaugeSetAttributes

GAUGESET_ALIGNMENT, GAUGESET_COLUMNCOUNT, GAUGESET_DIRECTION, GAUGESET_TITLE_FONT, GAUGESET_TITLE_FONT_COLOR, GAUGESET_TITLE_TEXT, GRAPHIC_ANTIALIASING, GSBACKGROUND_BORDERCOLOR, GSBACKGROUND_FILLCOLOR, GSBACKGROUND_SFX, LEGEND_AREA_BORDERCOLOR, LEGEND_AREA_FILLCOLOR, LEGEND_AREA_POSITION, LEGEND_AREA_SFX, LEGEND_AREA_VISIBLE, LEGEND_TEXT_FONT, LEGEND_TEXT_FONT_COLOR, LEGEND_TEXT_MIN_LENGTH, LEGEND_TEXT_NUMBER_TYPE, LEGEND_TITLE_FONT, LEGEND_TITLE_FONT_COLOR, LEGEND_TITLE_TEXT, LEGEND_TITLE_VISIBLE, TEXT_ANTIALIASING, TOOLTIP_FONT, TOOLTIP_FONT_COLOR, TOOLTIP_HORIZONTAL_ALIGNMENT

Fields inherited from interface oracle.dss.gauge.GaugeAttributes

ANGLE_EXTENT, BACKGROUND_BORDERCOLOR, BACKGROUND_FILLCOLOR, BACKGROUND_SFX, BOTTOM_LABEL, BOTTOM_LABEL_COLOR, BOTTOM_LABEL_FONT, BOTTOM_LABEL_POSITION, BOTTOM_LABEL_TEXT, BOTTOM_LABEL_VISIBLE, CL_MAX, CL_MIN, CL_NONE, CL_OUTER_FRAME, CL_TITLE_SEPARATOR, CS_BOTTOMLABELBOUNDS, CS_GAUGEFRAME, CS_INDICATOR, CS_INDICATORBASE, CS_INDICATORCENTER, CS_LEDFILLAREA, CS_LOWERLABELFRAME, CS_METRICLABELBOUNDS, CS_MINORTICKMARK, CS_PLOTAREA, CS_PLOTAREABOUNDS, CS_THRESHOLDFILLAREA, CS_TICKMARK, CS_TICKMARKPATH, CS_TOPLABELBOUNDS, CS_UPPERLABELFRAME, CUSTOM_LAYOUT, CUSTOM_SHAPES_PATH, DATAVIEW_END, ELEMENTA_BORDERCOLOR, ELEMENTA_BOTTOMLABEL, ELEMENTA_FILLCOLOR, ELEMENTA_SFX, ELEMENTA_TOPLABEL, ELEMENTA_VALUE, ELEMENTB_BORDERCOLOR, ELEMENTB_BOTTOMLABEL, ELEMENTB_FILLCOLOR, ELEMENTB_SFX, ELEMENTB_TOPLABEL, ELEMENTB_VALUE, GAUGEFRAME_BORDERCOLOR, GAUGEFRAME_FILLCOLOR, GAUGEFRAME_SFX, GAUGEFRAME_VISIBLE, ID_GAUGE, INDICATOR_BAR_BORDERCOLOR, INDICATOR_BAR_FILLCOLOR, INDICATOR_BAR_SFX, INDICATOR_BASE_BORDERCOLOR, INDICATOR_BASE_FILLCOLOR, INDICATOR_BASE_SFX, INDICATOR_BASE_VISIBLE, INDICATOR_BORDERCOLOR, INDICATOR_FILLCOLOR, INDICATOR_SFX, INDICATOR_TYPE, INDICATOR_TYPE_MAX, INDICATOR_TYPE_MIN, INDICATOR_USE_THRESHOLD_FILLCOLOR, INTERSECTIONAB_BORDERCOLOR, INTERSECTIONAB_BOTTOMLABEL, INTERSECTIONAB_FILLCOLOR, INTERSECTIONAB_SFX, INTERSECTIONAB_TOPLABEL, INTERSECTIONAB_VALUE, IT_FILL, IT_LINE, IT_NEEDLE, LED_STYLE, LED_STYLE_CALLBACK, LEDSTYLE_MAX, LEDSTYLE_MIN, LEGENDTEXT_NUMBER_TYPE, LEGENDTEXT_VIEWFORMAT, LINK, LOCALE, LOWLBLFRAME_BORDERCOLOR, LOWLBLFRAME_FILLCOLOR, LOWLBLFRAME_SFX, LOWLBLFRAME_VISIBLE, LP_ABOVE_GAUGE, LP_BELOW_GAUGE, LP_INSIDE_GAUGE, LP_INSIDE_GAUGE_LEFT, LP_INSIDE_GAUGE_RIGHT, LP_MAX, LP_MIN, LP_NONE, LP_WITH_BOTTOM_LABEL, LS_ARROW, LS_CUSTOM, LS_DOT, LS_KPI, LS_RECTANGLE, LS_SQUARE, LS_TRIANGLE, MAJORTICK_COLOR, MAJORTICK_COUNT, MAX_VALUE, METADATA_POINT_OF_ROTATION, METRIC, METRIC_LABEL_BACKCOLOR, METRIC_LABEL_COLOR, METRIC_LABEL_FONT, METRIC_LABEL_NUMBER_TYPE, METRIC_LABEL_POSITION, METRIC_LABEL_VIEWFORMAT, MIN_VALUE, MINORTICK_COLOR, MINORTICK_COUNT, NAME_ELEMENTA, NAME_ELEMENTB, NAME_INTERSECTIONAB, NODATA_LABEL, NT_NUMBER, NT_PERCENT, NUMBER_TYPE_MAX, NUMBER_TYPE_MIN, PLOTAREA_BORDERCOLOR, PLOTAREA_FILLCOLOR, PLOTAREA_SFX, PLOTAREA_USE_THRESHOLD_FILLCOLOR, SFX_BEVEL_ANGLE, SFX_BEVEL_BLURX, SFX_BEVEL_BLURY, SFX_BEVEL_DISTANCE, SFX_BEVEL_HIGHLIGHT_COLOR, SFX_BEVEL_QUALITY, SFX_BEVEL_SHADOW_COLOR, SFX_BEVEL_STRENGTH, SFX_BEVEL_TYPE, SFX_END_POINT, SFX_FILL_TYPE, SFX_GLOW_BLURX, SFX_GLOW_BLURY, SFX_GLOW_COLOR, SFX_GLOW_INNER, SFX_GLOW_KNOCKOUT, SFX_GLOW_QUALITY, SFX_GLOW_STRENGTH, SFX_GRADIENT_CENTER, SFX_GRADIENT_DIRECTION, SFX_GRADIENT_REVERSED, SFX_MOUSE_TRANSPARENT, SFX_NUM_STOPS, SFX_SHADOW_ANGLE, SFX_SHADOW_BLURX, SFX_SHADOW_BLURY, SFX_SHADOW_COLOR, SFX_SHADOW_DISTANCE, SFX_SHADOW_HIDE, SFX_SHADOW_INNER, SFX_SHADOW_KNOCKOUT, SFX_SHADOW_QUALITY, SFX_SHADOW_STRENGTH, SFX_START_POINT, SFX_STOP_COLORS, SFX_STOP_POSITIONS, SFX_VISUAL_EFFECTS, SH_OFF, SH_ON, SPECULAR_HIGHLIGHT, TC_INCREMENTS, TC_MAJORTICK, TC_METRIC, TC_MIN_MAX, TC_NONE, TC_THRESHOLD, TD_STYLE, TDS_MAX, TDS_MIN, TDS_PIE_FILL, TDS_RING_FILL, TDS_SEGMENTS, THRESHOLD_ATTRIBUTES, THRESHOLD_BORDERCOLOR, THRESHOLD_FILLCOLOR, THRESHOLD_SFX, THRESHOLD_TEXT, THRESHOLD_VALUES, TICK_CONTENT_MAX, TICK_CONTENT_MIN, TICK_LABEL_NUMBER_TYPE, TICKLABEL_COLOR, TICKLABEL_CONTENT, TICKLABEL_FONT, TICKLABEL_POSITION, TICKLABEL_POSITION_MAX, TICKLABEL_POSITION_MIN, TICKLABEL_VIEWFORMAT, TICKMARK_CONTENT, TLP_EXTERIOR, TLP_INTERIOR, TOOLTIP_TEXT, TOP_LABEL, TOP_LABEL_COLOR, TOP_LABEL_FONT, TOP_LABEL_POSITION, TOP_LABEL_TEXT, TOP_LABEL_VISIBLE, UPLBLFRAME_BORDERCOLOR, UPLBLFRAME_FILLCOLOR, UPLBLFRAME_SFX, UPLBLFRAME_VISIBLE

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_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

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Gauge()
Constructor that does not specify a DataSource.

Gauge(DataSource dataSource)
Constructor that specifies a DataSource.

Gauge(ErrorHandler errorHandler)
Constructor that specifies a ErrorHandler.

Method Summary

protected void	_createPagingControl()
protected void	_initGauge(DataSource ds, ErrorHandler eh)
static int	convertGaugeTypeToInt(java.lang.String type)
static java.lang.String	convertGaugeTypeToString(int type) Generates a String representation of a gauge type constant.
void	endExport()
void	exportToFlash(java.io.OutputStream os, boolean renderDynamic, boolean showDrawing) Delegates the work to CommonGauge by passing the outputstream associated with the flash file to be written and a flag indicating if it will be a static or a dynamic rendering
void	exportToPNG(java.io.OutputStream os) Exports a snapshot of the gauge set to the PNG file.
void	exportToPNGWithException(java.io.OutputStream os) Exports a snapshot of the gauge set to the PNG file.
void	exportToSVG(java.io.OutputStream os, int mode, java.lang.String charEnc) Exports a snapshot of the gauge set that is currently displayed to the given output stream.
void	exportToSVG(java.io.Writer writer, int mode, java.lang.String charEnc) Exports a snapshot of the gauge set that is currently displayed to the given writer.
void	exportToSVGWithException(java.io.OutputStream os, int mode, java.lang.String charEnc) Exports a snapshot of the gauge set that is currently displayed to the SVG file, throwing any exceptions that occur during the process.
void	exportToSVGWithException(java.io.Writer writer, int mode, java.lang.String charEnc) Exports a snapshot of the gauge set that is currently displayed to the given writer, throwing any exceptions that occur during the process.
protected void	firePropertyChange(java.lang.Object obj, java.lang.String propName, java.lang.Object oldValue, java.lang.Object newValue)
BottomLabel	getBottomLabel() Returns the BottomLabel component.
CommonGauge	getCommonGauge()
DataSpecification	getDataSpecification() Retrieves the DataSpecification for this bean.
GaugeBackground	getGaugeBackground() Returns the GaugeBackground component.
GaugeController	getGaugeController() Retrieves the controller for this gauge.
GaugeFrame	getGaugeFrame() Returns the GaugeFrame component.
GaugeModel	getGaugeModel() Retrieves the model that this gauge uses.
int	getGaugeSetAlignment() This method gets the alignment of gauges in the gauge set.
GaugeSetBackground	getGaugeSetBackground() Returns the GaugeSetBackground component.
int	getGaugeSetColumnCount() This method gets the number of columns used to layout the gauges in a gauge set.
int	getGaugeSetDirection() This method gets the layout direction of gauges in the gauge set.
int	getGaugeType() Returns the type of gauges to be generated by this instance of the Gauge bean.
java.util.Enumeration	getImagemapEnumeration(int filter) Retrieves the enumeration of specific kinds of components that are currently in use and visible on the gauge.
java.awt.Dimension	getImageSize() Retrieves the size of this gauge.
Indicator	getIndicator() Returns the Indicator component.
int	getLEDStyle() Returns the style of LED gauge to be generated by this instance of the Gauge bean.
LEDStyleCallback	getLEDStyleCallback() Gets the callback to use when rendering custom LEDs.
LegendArea	getLegendArea() Returns the LegendArea component.
LegendText	getLegendText() Returns the LegendText component.
LegendTitle	getLegendTitle() Returns the LegendTitle component.
java.util.Locale	getLocale() Retrieves the Locale that this Gauge uses.
LowerLabelFrame	getLowerLabelFrame() Returns the LowerLabelFrame component.
MetricLabel	getMetricLabel() Returns the MetricLabel component.
protected oracle.dss.util.xml.ObjectNode	getObjectNode(boolean allProperties)
java.awt.Dimension	getOptimalGaugeSize(java.awt.Dimension maxSize) This method uses the current attributes set on this gauge bean to determine the minimal size a gauge should be in this gauge set.
oracle.dss.util.xml.ObjectNode	getPagingControlXML(boolean allProperties)
oracle.dss.util.persistence.PersistableAttributes	getPersistableAttributes(oracle.dss.util.persistence.PersistableAttributes oldAttrs) Retrieves the attributes of this Dataview, for searching.
PlotArea	getPlotArea() Returns the PlotArea component.
int	getPresentationHeight() Retrieveis the height of this view, in pixels.
int	getPresentationWidth() Retrieves the width of this view, in pixels.
ComponentHandle	getSelectedObject() Retrieves the selected component.
java.awt.Dimension	getSize()
int	getStartColumn()
int	getStartRow() Deprecated. As of 2.6.0.27, replaced by #getStartSeries or by #getStartGroup.
Threshold	getThreshold() Returns the Threshold component.
int	getThresholdDialStyle() Returns the style of Threshold Dial gauge to be generated by this instance of the Gauge bean.
TickLabel	getTickLabel() Returns the TickLabel component.
TickMark	getTickMark() Returns the TickMark component.
TopLabel	getTopLabel() Returns the TopLabel component.
UpperLabelFrame	getUpperLabelFrame() Returns the UpperLabelFrame component.
java.lang.String	getVersion()
int	getViewType() Retrieves the specific type of subclass of this Dataview.
DataviewXML	getViewXML()
boolean	isExporting()
protected boolean	isMetadataDateSpanSupported()
protected boolean	isMetadataDrillParentDateSpanSupported()
protected boolean	isMetadataDrillParentDateSupported()
protected boolean	isMetadataDrillSupported()
boolean	isPrintOrPreviewMode()
boolean	isSwapAllowed() Indicates whether swapping is allowed in this view.
protected void	metadataLabelTypeChanged()
void	modelDataAvailable(DataAvailableEvent e) Inform view of changes to the data availability.
void	modelDataChanged(DataChangedEvent e) Inform view of changes to the actual data or metadata.
void	paint(java.awt.Graphics g)
protected void	processAlertEvent(int eventID)
void	propertyChange(java.beans.PropertyChangeEvent evt)
boolean	readXML(java.io.InputStream stream, boolean reset) Deprecated. As of 1.7.0.12, replaced by readXML(InputStream, int)
boolean	readXML(java.io.InputStream stream, int reset) Applies XML to this Gauge, from a String.
protected void	refreshData()
boolean	renderGauges(java.awt.Graphics2D g) This method renders the gauges in this gauge set onto the given instance of Graphics.
void	resetEverything(int reset)
void	resetSuper(int reset, java.lang.String version)
void	resetToDefault(int reset) Resets properties of this Gauge to their default values.
void	resetXMLProps()
boolean	selectObject(ComponentHandle id) Select a component.
boolean	selectObjectFromEvent(java.awt.event.MouseEvent e)
void	setBackgroundTransparent(boolean transparent)
void	setContext()
void	setDataSource(DataSource ds) Specifies the data source for this Gauge.
void	setDataSource(DataSource ds, DataSpecification specs) Specifies the data source for this Gauge.
void	setDataSpecification(DataSpecification dataSpec) Sets the DataSpecification for this bean, assuming it is relevant to the current DataSource.
protected void	setDataUnformattedSupported(boolean supported)
void	setGaugeController(GaugeController gaugeController)
void	setGaugeModel(GaugeModel gaugeModel)
void	setGaugeSetAlignment(int alignment) This method sets the alignment of gauges in the gauge set.
void	setGaugeSetColumnCount(int columns) This method sets the number of columns used to layout the gauges in a gauge set.
void	setGaugeSetDirection(int direction) This method sets the layout direction of gauges in the gauge set.
void	setGaugeType(int type) Sets the type of gauges to be generated by this instance of the Common Gauge.
boolean	setGridData(java.lang.Object[] specs, java.lang.Object[] columnLabels, java.lang.Object[] rowLabels, java.lang.Object[][] data)
void	setImageSize(java.awt.Dimension d) Specifies the size of the image that is created from this gauge when you export the gauge to a PNG or GIF file.
protected void	setLayerMetaLongLabelSupported(boolean supported)
protected void	setLayerMetaMediumLabelSupported(boolean supported)
protected void	setLayerMetaNameSupported(boolean supported)
protected void	setLayerMetaShortLabelSupported(boolean supported)
void	setLEDStyle(int style) Sets the style of LED gauges to be generated by this instance of the Common Gauge.
void	setLEDStyleCallback(LEDStyleCallback callback) Sets the callback to use when rendering custom LEDs.
protected void	setMetadataDateSpanSupported(boolean supported)
protected void	setMetadataDateSupported(boolean supported)
protected void	setMetadataDrillParentDateSpanSupported(boolean supported)
protected void	setMetadataDrillParentDateSupported(boolean supported)
protected void	setMetadataDrillSupported(boolean supported)
protected void	setMetadataLongLabelSupported(boolean supported)
protected void	setMetadataMediumLabelSupported(boolean supported)
protected void	setMetadataShortLabelSupported(boolean supported)
protected void	setMetadataValueSupported(boolean supported)
void	setPagingControlXML(oracle.dss.util.xml.ObjectNode pagingControl, java.lang.String version, int reset)
void	setPersistableComponents(oracle.dss.util.persistence.AggregateInfo[] persistables)
void	setPrintOrPreviewMode(boolean bool)
void	setStartColumn(int c)
void	setStartRow(int r) Specifies the first row of data to display in this gauge.
void	setSwapAllowed(boolean swap) Specifies whether users can swap page items in this view.
boolean	setTabularData(java.lang.Object[] specs, java.util.List tableRows) Specifies data for the GaugeBean, from a list of arrays.
void	setThresholdDialStyle(int style) Sets the style of Threshold Dial gauge to be generated by this instance of the Gauge bean.
boolean	setXML(java.lang.String xmlString, int reset) Applies XML to this Gauge, from a String.
boolean	setXMLAsString(java.lang.String xml) Specifies the XML representation of this Gauge.
boolean	startExport()
void	updatePageItems()
void	writeImagemapXML(java.io.OutputStream os, int filter) Writes an XML representation of information about specific kinds of components that are currently in use and visible on the gauge.
void	writeImagemapXML(java.io.PrintWriter out, int filter) Writes an XML representation of information about specific kinds of components that are currently in use and visible on the gauge.

Methods inherited from class oracle.dss.dataView.Dataview

addControllerListener, addDataListener, addErrorHandler, addPropertyChangeListener, addSubcomponent, addVetoableChangeListener, addViewFocusListener, addViewKeyListener, addViewListener, addViewMouseListener, addViewMouseMotionListener, cleanUp, clearPropertyOverrideFlag, clearStyleModified, clearWaitDataForAllRows, convertComponentTypeToInteger, convertComponentTypeToString, copyAdornment, createFootnote, createPropertyOverrideFlags, createTitles, dataFormatChanged, dataStyleChanged, firePrintBegin, firePrintEnd, getComponentFromID, getController, getDataDirector, getDataSource, getDataviewFootnote, getDataviewSubtitle, getDataviewTitle, getDescription, getErrorHandler, getFontList, getHTMLPagingControlWidth, getIntlString, getIntlString, getLayerMetadataLabelType, getLayerMetadataLabelType, getLocalName, getMemberMetadataLabelType, getMemberMetadataLabelType, getModel, getName, getNameFromID, getObjectNode, getPagingControl, getPagingControlPosition, getPersistableComponents, getPhysicalComponents, getPopupManager, getRolloverTextManager, getStyleXML, getSubcomponent, getSubcomponent, getTokenSubstitution, getWaitData, getWaitDataForRow, getXML, getXMLAsString, getZoomFactor, initialize, isCustomColorsEnabled, isDataUnavailable, isDataUnformattedSupported, isDataViewFormatSupported, isDrillingEnabled, isDrillingSupported, isHTMLPagingControlAutosubmit, isJavaComponent, isLayerMetadataLabelTypeSupported, isLayerMetaLongLabelSupported, isLayerMetaMediumLabelSupported, isLayerMetaNameSupported, isLayerMetaShortLabelSupported, isLayerMetaViewStyleSupported, isLoadingDataSourceFromPersistence, isMemberMetadataLabelTypeSupported, isMetadataLongLabelSupported, isMetadataMediumLabelSupported, isMetadataShortLabelSupported, isMetadataValueSupported, isMetadataViewStyleSupported, isPagingControlVisible, isPropertyOverrideFlag, isStyleModified, isStyleOverrideMode, isUserOverrideMode, isXMLValidated, metadataStyleChanged, modelWaitDataAvailable, positionPagingControl, removeControllerListener, removeDataListener, removeErrorHandler, removeListeners, removePropertyChangeListener, removeVetoableChangeListener, removeViewFocusListener, removeViewKeyListener, removeViewListener, removeViewMouseListener, removeViewMouseMotionListener, resetToDefault, scaleFont, setCommonDataview, setController, setCustomColorsEnabled, setDataDirector, setDescription, setDrillingEnabled, setEnabled, setHTMLPagingControlAutosubmit, setHTMLPagingControlWidth, setLayerMetadataLabelType, setLayerMetadataLabelType, setLayerMetaViewStyleSupported, setLoadingDataSourceFromPersistence, setLocale, setLocalName, setMemberMetadataLabelType, setMemberMetadataLabelType, setMetadataViewStyleSupported, setModel, setName, setPagingControlPosition, setPagingControlVisible, setPersistableAttributes, setPopupManager, setPropertyOverrideFlags, setRolloverTextManager, setStyleOverrideMode, setStyleXML, setTokenSubstitution, setUserOverrideMode, setWaitDataForRow, setXML, setXMLValidated, updatePagingControlStyles, writeXML

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusBackward, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocation, setLocation, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Methods inherited from interface oracle.dss.dataView.ThickDataview

getDataviewFootnote, getDataviewSubtitle, getDataviewTitle, isEnabled, isShowing, repaint, setEnabled, setPagingControlVisible

Methods inherited from interface oracle.dss.dataView.DataviewAttributes

getHTMLPagingControlWidth, getLayerMetadataLabelType, getMemberMetadataLabelType, getPagingControlPosition, isDrillingEnabled, isDrillingSupported, isHTMLPagingControlAutosubmit, isPagingControlVisible, setDrillingEnabled, setHTMLPagingControlAutosubmit, setHTMLPagingControlWidth, setLayerMetadataLabelType, setMemberMetadataLabelType, setPagingControlPosition

Methods inherited from interface oracle.dss.presutil.CommonViewAttributes

getDescription, getLocalName, getName, setDescription, setLocalName, setName

Methods inherited from interface oracle.dss.dataView.DataviewCommon

repaint

Field Detail

_gaugeModel

protected GaugeModel _gaugeModel

For internal use only. Application developers should not use this

_gaugeController

protected GaugeController _gaugeController

For internal use only. Application developers should not use this

_gaugePanel

protected GaugePanel _gaugePanel

_offscreenImage

protected java.awt.Image _offscreenImage

For internal use only. Application developers should not use this

_printOrPreviewMode

protected boolean _printOrPreviewMode

For internal use only. Application developers should not use this

_stopRepaints

protected boolean _stopRepaints

For internal use only. Application developers should not use this

Constructor Detail

Gauge

public Gauge()

Constructor that does not specify a DataSource. If you use this constructor, call the setDataSource method to specify the data that this gauge displays.

Gauge

public Gauge(DataSource dataSource)

Constructor that specifies a DataSource.

Parameters:

dataSource - The DataSource from which this gauge will request data.

Gauge

public Gauge(ErrorHandler errorHandler)

Constructor that specifies a ErrorHandler.

Parameters:

errorHandler - The ErrorHandler to use.

Method Detail

getCommonGauge

public CommonGauge getCommonGauge()

For internal use only. Application developers should not use this

_initGauge

protected void _initGauge(DataSource ds,
                          ErrorHandler eh)

_createPagingControl

protected void _createPagingControl()

For internal use only. Application developers should not use this

getSize

public java.awt.Dimension getSize()

Specified by:

getSize in interface ThickGauge

Overrides:

getSize in class java.awt.Component

paint

public void paint(java.awt.Graphics g)

Overrides:

paint in class javax.swing.JComponent

For internal use only. Application developers should not use this

Override to show the offscreen image when printing or previewing

setPrintOrPreviewMode

public void setPrintOrPreviewMode(boolean bool)

For internal use only. Application developers should not use this

Sets whether table is in print or print preview mode. When in print or preview mode, offscreen image is displayed. This is used by GraphPrinter class.

exportToPNG

public void exportToPNG(java.io.OutputStream os)

Exports a snapshot of the gauge set to the PNG file.

Parameters:

os - The OutputStream that specifies the location and name of the PNG file.

See Also:

exportToPNGWithException(java.io.OutputStream)

exportToPNGWithException

public void exportToPNGWithException(java.io.OutputStream os)
                              throws oracle.dss.graph.pfj.png.PNGInvalidParameterException,
                                     oracle.dss.graph.pfj.png.PNGException

Exports a snapshot of the gauge set to the PNG file.

Parameters:

os - The OutputStream that specifies the location and name of the PNG file.

Throws:

oracle.dss.graph.pfj.png.PNGInvalidParameterException

oracle.dss.graph.pfj.png.PNGException

See Also:

exportToPNG(java.io.OutputStream)

exportToSVG

public void exportToSVG(java.io.OutputStream os,
                        int mode,
                        java.lang.String charEnc)

Exports a snapshot of the gauge set that is currently displayed to the given output stream.

Parameters:

os - The OutputStream to write SVG to.

mode - specifies what to include in SVG; constants are defined in this class and begin with SVG_MODE_

charEnc - character encoding to use for SVG

exportToFlash

public void exportToFlash(java.io.OutputStream os,
                          boolean renderDynamic,
                          boolean showDrawing)

Delegates the work to CommonGauge by passing the outputstream associated with the flash file to be written and a flag indicating if it will be a static or a dynamic rendering

Parameters:

os - the outputstream associated with the flash file

renderDynamic - Flag indicating if the rendering is dynamic or static. For static charts, the value is false.

showDrawing - Only applicable for static charts and indicates if the drawing of the chart should be shown.

exportToSVGWithException

public void exportToSVGWithException(java.io.OutputStream os,
                                     int mode,
                                     java.lang.String charEnc)
                              throws java.io.IOException,
                                     java.lang.Exception

Exports a snapshot of the gauge set that is currently displayed to the SVG file, throwing any exceptions that occur during the process.

Parameters:

os - The OutputStream to write SVG to.

mode - specifies what to include in SVG; constants are defined in this class and begin with SVG_MODE_

charEnc - character encoding to use for SVG

Throws:

java.io.IOException - if there was a problem writing to the stream

java.lang.Exception - if another problem occurred

exportToSVG

public void exportToSVG(java.io.Writer writer,
                        int mode,
                        java.lang.String charEnc)

Exports a snapshot of the gauge set that is currently displayed to the given writer.

Parameters:

writer - The Writer to write SVG to.

mode - specifies what to include in SVG; constants are defined in this class and begin with SVG_MODE_

charEnc - character encoding to use for SVG

exportToSVGWithException

public void exportToSVGWithException(java.io.Writer writer,
                                     int mode,
                                     java.lang.String charEnc)
                              throws java.io.IOException,
                                     java.lang.Exception

Exports a snapshot of the gauge set that is currently displayed to the given writer, throwing any exceptions that occur during the process.

Parameters:

writer - The Writer to write SVG to.

mode - specifies what to include in SVG; constants are defined in this class and begin with SVG_MODE_

charEnc - character encoding to use for SVG

Throws:

java.io.IOException - if there was a problem writing to the writer

java.lang.Exception - if another problem occurred

getDataSpecification

public DataSpecification getDataSpecification()

Retrieves the DataSpecification for this bean.

Returns:

The DataSpecification for this bean. If a beans data specification has not been set for this view, this method returns null.

setDataSpecification

public void setDataSpecification(DataSpecification dataSpec)

Sets the DataSpecification for this bean, assuming it is relevant to the current DataSource.

Parameters:

dataSpec - The DataSpecification for this bean.

getGaugeController

public GaugeController getGaugeController()

Retrieves the controller for this gauge. In the Model-View-Controller architecture, the controller is responsible for attending to user gestures, such as mouse clicks.

Returns:

The GaugeController for this gauge.

setGaugeController

public void setGaugeController(GaugeController gaugeController)

Parameters:

gaugeController - The controller for this gauge to use.

For internal use only. Application developers should not use this

Specifies the controller for this gauge. In the Model-View-Controller architecture, the controller is responsible for attending to user gestures, such as mouse clicks.

Application developers normally do not need to call this method. Call it only if you are providing your own implementation of the GaugeController interface, rather than using the default BI Beans GaugeController.

getGaugeModel

public GaugeModel getGaugeModel()

Retrieves the model that this gauge uses. In the Model-View-Controller architecture, the model is responsible for handling the data that is displayed in a view. In the full BI Beans set, the DataSource is the "big" model. The model that this method returns interacts with the DataSource, retrieving data and having the data formatted so that the view can display it.

Returns:

The GaugeModel that this gauge uses.

setGaugeModel

public void setGaugeModel(GaugeModel gaugeModel)

Parameters:

gaugeModel - The GaugeModel for this gauge to use.

For internal use only. Application developers should not use this

Specifies the model for this gauge. In the Model-View-Controller architecture, the model is responsible for handling the data that is displayed in a view. In the full BI Beans set, the DataSource is the "big" model. The model that this method returns interacts with the DataSource, retrieving data and having the data formatted so that the view can display it.

Application developers normally do not need to call this method. Call it only if you are providing your own implementation of the GaugeModel interface, rather than using the default BI Beans GaugeModel.

getImagemapEnumeration

public java.util.Enumeration getImagemapEnumeration(int filter)

Retrieves the enumeration of specific kinds of components that are currently in use and visible on the gauge. The enumeration provides an ImagemapComponent object for each gauge object. Each ImagemapComponent object contains the ComponentHandle and the Polygon for that gauge component. The ComponentHandle contains information about the component, and the Polygon contains information about the component's position on the gauge.

Parameters:

filter - One or more bitwise values specifying the kinds of gauge components to enumerate. Valid values are constants in this class and begin with MAP_.

Returns:

Enumeration of the specified kinds of gauge components.

See Also:

ImagemapComponent

getImageSize

public java.awt.Dimension getImageSize()

Retrieves the size of this gauge.

Returns:

The size of the gauge, in a Dimension object.

setImageSize

public void setImageSize(java.awt.Dimension d)

Specifies the size of the image that is created from this gauge when you export the gauge to a PNG or GIF file.

Parameters:

d - The size to make the gauge.

See Also:

exportToPNG(java.io.OutputStream), exportToPNGWithException(java.io.OutputStream), exportToSVG(java.io.OutputStream, int, java.lang.String), exportToSVGWithException(java.io.OutputStream, int, java.lang.String)

getLocale

public java.util.Locale getLocale()

Retrieves the Locale that this Gauge uses.

Specified by:

getLocale in interface DataviewCommon

Specified by:

getLocale in interface UIView

Overrides:

getLocale in class Dataview

Returns:

loc The Locale for this Gauge.

getOptimalGaugeSize

public java.awt.Dimension getOptimalGaugeSize(java.awt.Dimension maxSize)

This method uses the current attributes set on this gauge bean to determine the minimal size a gauge should be in this gauge set. The return value can be used to optimize the space allocated to the Graphics object supplied to the render method.

The size returned from this method is used when exporting the gauge set to a PNG image with the exportToPNG method.

Parameters:

maxSize - Dimensions to use in determining optimal gauge size.

Returns:

Instance of Dimension containing the size of the largest gauge in this gauge set.

See Also:

setImageSize(java.awt.Dimension)

getPagingControlXML

public oracle.dss.util.xml.ObjectNode getPagingControlXML(boolean allProperties)

Specified by:

getPagingControlXML in interface ThickDataview

For internal use only. Application developers should not use this

setPagingControlXML

public void setPagingControlXML(oracle.dss.util.xml.ObjectNode pagingControl,
                                java.lang.String version,
                                int reset)

Specified by:

setPagingControlXML in interface ThickDataview

getPresentationHeight

public int getPresentationHeight()

Retrieveis the height of this view, in pixels.

Specified by:

getPresentationHeight in class Dataview

Returns:

The height of the this view, in pixels.

getPresentationWidth

public int getPresentationWidth()

Retrieves the width of this view, in pixels.

Specified by:

getPresentationWidth in class Dataview

Returns:

The width of the this view, in pixels.

selectObject

public boolean selectObject(ComponentHandle id)

Select a component.

Specified by:

selectObject in class Dataview

Parameters:

id - A ComponentHandle that represents the component to select.

Returns:

true if the component is successfully selected, false if not.

selectObjectFromEvent

public boolean selectObjectFromEvent(java.awt.event.MouseEvent e)

Parameters:

e - Instance of MouseEvent

Returns:

True if the component under the point was selected, False otherwise

For internal use only. Application developers should not use this

Selects the component using the given event.

getSelectedObject

public ComponentHandle getSelectedObject()

Retrieves the selected component. This method retrieves a handle for the graph component that has most recently selected by a user. It returns a concrete subclass of the ComponentHandle class.

The subclass that is returned depends on the component that is selected. For example, an AreaMarker represents a series of data, so if an AreaMarker is selected, this method returns a SeriesComponentHandle. If a TwoDMarker (a bar in a bar graph) is selected, then this method returns a DataComponentHandle, because a TwoDMarker represents a data value that belongs in both a series (such as May 1999) and a group (such as Shoes).

Specified by:

getSelectedObject in interface UIView

Specified by:

getSelectedObject in class Dataview

Returns:

The handle for the selected component.

getVersion

public java.lang.String getVersion()

Specified by:

getVersion in interface ThickDataview

Specified by:

getVersion in class Dataview

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.

getViewType

public int getViewType()

Retrieves the specific type of subclass of this Dataview. This method returns Dataview.VIEW_TYPE_GAUGE.

Specified by:

getViewType in interface DataviewCommon

Specified by:

getViewType in interface UIView

Specified by:

getViewType in class Dataview

Returns:

The constant Dataview.VIEW_TYPE_GAUGE

See Also:

DataviewConstants.VIEW_TYPE_GAUGE

isPrintOrPreviewMode

public boolean isPrintOrPreviewMode()

Specified by:

isPrintOrPreviewMode in class Dataview

For internal use only. Application developers should not use this

Indicates whether print or preview is happening.

isSwapAllowed

public boolean isSwapAllowed()

Indicates whether swapping is allowed in this view. When this method returns true, then users can swap items by clicking the two items. When this method returns false, then users must move each item separately.

Specified by:

isSwapAllowed in interface ThickDataview

Specified by:

isSwapAllowed in class Dataview

Returns:

true if swapping is enabled, false if it is not.

See Also:

setSwapAllowed(boolean)

setSwapAllowed

public void setSwapAllowed(boolean swap)

Specifies whether users can swap page items in this view. When SwapAllowed is true, then users can click the two page items that they want to swap, in order to swap the items. The view will then ask the data source to perform a pivot of type DataDirector.PIVOT_SWAP.

When SwapAllowed is false, then users must move the two page items separately, and the view will ask for two separate pivot actions of type DataDirector.PIVOT_MOVE_BEFORE or DataDirector.PIVOT_MOVE_AFTER. By default, swapping is disabled.

Specified by:

setSwapAllowed in interface ThickDataview

Specified by:

setSwapAllowed in class Dataview

Parameters:

swap - true to enable swapping, false to disable it.

See Also:

isSwapAllowed(), DataDirector

readXML

public boolean readXML(java.io.InputStream stream,
                       boolean reset)
                throws oracle.dss.util.xml.BIIOException,
                       oracle.dss.util.xml.BISAXException,
                       oracle.dss.util.xml.BIParseException

Deprecated. As of 1.7.0.12, replaced by readXML(InputStream, int)

The readXML method that takes an int for the reset parameter allows you to specify how much and how far to reset the view before you apply XML.

Throws:

BIIOException - If an error occurs in reading xmlString.

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

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

oracle.dss.util.xml.BIIOException

oracle.dss.util.xml.BISAXException

oracle.dss.util.xml.BIParseException

readXML

public boolean readXML(java.io.InputStream stream,
                       int reset)
                throws oracle.dss.util.xml.BIIOException,
                       oracle.dss.util.xml.BISAXException,
                       oracle.dss.util.xml.BIParseException

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

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

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

Specified by:

readXML in class Dataview

Parameters:

stream - The XML to apply to this Gauge.

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

Returns:

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

Throws:

BIIOException - If an error occurs in reading xmlString.

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

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

oracle.dss.util.xml.BIIOException - If an error occurs in reading xmlString.

oracle.dss.util.xml.BISAXException - If a general SAX exception occurs in parsing the XML.

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

See Also:

DataviewConstants.RESET_NONE, DataviewConstants.RESET_XML_PROPERTIES, DataviewConstants.RESET_EVERYTHING

renderGauges

public boolean renderGauges(java.awt.Graphics2D g)

This method renders the gauges in this gauge set onto the given instance of Graphics.

Parameters:

g - Instance of Graphics to use

Returns:

True if the gauge components rendered successfully, False if they could not be rendered.

resetEverything

public void resetEverything(int reset)

Specified by:

resetEverything in interface ThickDataview

Parameters:

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

For internal use only. Application developers should not use this

Reset the properties of the gauge to their default values for the specified Gauge XML version. If the version is invalid, then default values for the latest Gauge XML version are used.

resetSuper

public void resetSuper(int reset,
                       java.lang.String version)

Specified by:

resetSuper in interface ThickDataview

Parameters:

version - the gauge XML version number, as stored in XML

For internal use only. Application developers should not use this

Reset the properties of the gauge to their default values for the specified gauge XML version. If the version is invalid, then default values for the latest gauge XML version are used.

resetToDefault

public void resetToDefault(int reset)

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

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

Overrides:

resetToDefault in class Dataview

Parameters:

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

See Also:

DataviewConstants.RESET_XML_PROPERTIES, DataviewConstants.RESET_EVERYTHING

resetXMLProps

public void resetXMLProps()

Specified by:

resetXMLProps in interface ThickDataview

Parameters:

version - the gauge XML version number, as stored in XML

For internal use only. Application developers should not use this

Reset the properties of the gauge to their default values for the specified gauge XML version. If the version is invalid, then default values for the latest gauge XML version are used.

setContext

public void setContext()

Specified by:

setContext in class Dataview

For internal use only. Application developers should not use this

set the context

setDataSource

public void setDataSource(DataSource ds)

Specifies the data source for this Gauge. This method specifies the DataSource that will feed data to this Gauge. If you do not use the Gauge(DataSource) method to create the gauge, then you must call this method to specify the data that appears in the gauges, or specify XML or tabular data via the setXML and setTabularData methods, respectively. This version of setDataSource doesn't accept an instance of DataSpecification, and will therefore result in a gauge for every cell in the DataSource. Use the setDataSource(DataSource, DataSpecification) version to map the data in the DataSource to the various data-related components in the gauges.

Specified by:

setDataSource in interface DataviewCommon

Specified by:

setDataSource in interface ThickDataview

Overrides:

setDataSource in class Dataview

Parameters:

ds - The DataSource for this gauge to use.

setDataSource

public void setDataSource(DataSource ds,
                          DataSpecification specs)

Specifies the data source for this Gauge. This method specifies the DataSource that will feed data to this Gauge. If you do not use the Gauge(DataSource, DataSpecification) method to create the gauge, then you must call this method to specify the data that appears in the gauges, or specify XML or tabular data via the setXML and setTabularData methods, respectively.

Parameters:

ds - The DataSource for this gauge to use.

specs - Instance of DataSpecification class.

setGridData

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

Parameters:

specs - Array of Objects indicating the order in which the data appears in the columnLabels parameter. Valid values are in the DataSpecification class and begin with DST_.

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 gauge, indexed first by column, then by row; typically Doubles and Date in case of TimeSeries gauges

Returns:

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

For internal use only. Application developers should not use this

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

getStartColumn

public int getStartColumn()

Returns:

The index of the first column that is displayed. The index is zero-based.

For internal use only. Application developers should not use this

Retrieves the first column of data that this gauge currently displays.

setStartColumn

public void setStartColumn(int c)

Parameters:

c - The first column of data to display.

For internal use only. Application developers should not use this

Specifies the first column of data that this gauge currently displays.

getStartRow

public int getStartRow()

Deprecated. As of 2.6.0.27, replaced by #getStartSeries or by #getStartGroup.

Retrieves the first row of data that this gauge currently displays.

Returns:

The index of the first row that is displayed. The index is zero-based.

setStartRow

public void setStartRow(int r)

Specifies the first row of data to display in this gauge.

Parameters:

r - The first row of data to display.

setTabularData

public boolean setTabularData(java.lang.Object[] specs,
                              java.util.List tableRows)

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

The data specification parameter should be an array of Objects, mapping how the data values are organized in the data list. Valid values are constants in this class and begin with MAP_. Column labels, displayed at the top of a gauge, and row labels, displayed at the bottom of a gauge, are always positioned as the first and second elements of each row but are not included in the tableRows argument.

The list of arrays containing data must conform to the specification outlined in the specs parameter. The number of entries in the list should equal the number of gauges to display.

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

	All Channels
	Sales	Quota	Target
Boston	12	11	13
Chicago	14	14	17
Phoenix	8	10	12
New York	21	16	20

The specification array would look like this if you wanted the column labels to appear at the top of each gauge and the row labels to appear at the bottom of each gauge, and you didn't specify min or max values:

 Object[] specs = {DataSpecification.DST_METRIC,
                   DataSpecification.DST_THRESHOLD,
                   DataSpecification.DST_THRESHOLD};
 

This would tell the Gauge bean to expect the metric and 2 threshold values in the first three elements of each row array element. Given this specification, the data list for the data above would look something like this:

 Object[] row1 = {"All Channels, Sales", "Boston",
                  new Double(12), new Double(11),
                  new Double(13)};
 Object[] row2 = {"All Channels, Sales", "Chicago",
                  new Double(14), new Double(14),
                  new Double(17)};
 Object[] row3 = {"All Channels, Sales", "Phoenix",
                  new Double(8), new Double(10),
                  new Double(12)};
 Object[] row4 = {"All Channels, Sales", "New York",
                  new Double(21), new Double(16),
                  new Double(20)};

 // add the arrays to a List
 ArrayList dataRows = new ArrayList();
 dataRows.add(row1);
 dataRows.add(row2);
 dataRows.add(row3);
 dataRows.add(row4);

 // pass the List to this method
 gaugeBean.setTabularData(specs, dataRows);
 

The tabular data provided above would result in a gauge set with four gauges running vertically to best match the layout of the original grid.

Parameters:

specs - Array of Objects indicating the order in which the data appears in the tableRows parameter. Valid values are constants in the DataSpecification class and begin with DST_.

tableRows - List of data to plot in the gauge bean.

Returns:

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

setXML

public boolean setXML(java.lang.String xmlString,
                      int reset)
               throws oracle.dss.util.xml.BIIOException,
                      oracle.dss.util.xml.BISAXException,
                      oracle.dss.util.xml.BIParseException

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

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

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

Specified by:

setXML in class Dataview

Parameters:

xmlString - The XML to apply to this Gauge.

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

Returns:

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

Throws:

BIIOException - If an error occurs in reading xmlString.

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

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

oracle.dss.util.xml.BIIOException - If an error occurs in reading xmlString.

oracle.dss.util.xml.BISAXException - If a general SAX exception occurs in parsing the XML.

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

See Also:

DataviewConstants.RESET_NONE, DataviewConstants.RESET_XML_PROPERTIES, DataviewConstants.RESET_EVERYTHING

writeImagemapXML

public void writeImagemapXML(java.io.OutputStream os,
                             int filter)

Writes an XML representation of information about specific kinds of components that are currently in use and visible on the gauge. The constants for filter are defined in this class and begin with MAP_.

Parameters:

os - The output stream where XML will be written.

filter - The kinds of gauge components whose information you want to write in XML.

See Also:

getImagemapEnumeration(int), DataviewConstants.MAP_ALL, DataviewConstants.MAP_DATA, DataviewConstants.MAP_LABELS, DataviewConstants.MAP_TITLES

writeImagemapXML

public void writeImagemapXML(java.io.PrintWriter out,
                             int filter)

Writes an XML representation of information about specific kinds of components that are currently in use and visible on the gauge. The constants for filter are defined in this class and begin with MAP_.

Parameters:

out - The print writer where XML will be written.

filter - The kinds of gauge components whose information you want to write in XML.

See Also:

getImagemapEnumeration(int), DataviewConstants.MAP_ALL, DataviewConstants.MAP_DATA, DataviewConstants.MAP_LABELS, DataviewConstants.MAP_TITLES

updatePageItems

public void updatePageItems()

Specified by:

updatePageItems in interface ThickDataview

For internal use only. Application developers should not use this

getGaugeSetBackground

public GaugeSetBackground getGaugeSetBackground()

Returns the GaugeSetBackground component.

Returns:

GaugeSetBackground instance

getGaugeBackground

public GaugeBackground getGaugeBackground()

Returns the GaugeBackground component.

Returns:

GaugeBackground instance

getGaugeFrame

public GaugeFrame getGaugeFrame()

Returns the GaugeFrame component.

Returns:

GaugeFrame instance

getPlotArea

public PlotArea getPlotArea()

Returns the PlotArea component.

Returns:

PlotArea instance

getTickLabel

public TickLabel getTickLabel()

Returns the TickLabel component.

Returns:

TickLabel instance

getTickMark

public TickMark getTickMark()

Returns the TickMark component.

Returns:

TickMark instance

getIndicator

public Indicator getIndicator()

Returns the Indicator component.

Returns:

Indicator instance

getThreshold

public Threshold getThreshold()

Returns the Threshold component.

Returns:

Threshold instance

getTopLabel

public TopLabel getTopLabel()

Returns the TopLabel component.

Returns:

TopLabel instance

getBottomLabel

public BottomLabel getBottomLabel()

Returns the BottomLabel component.

Returns:

BottomLabel instance

getMetricLabel

public MetricLabel getMetricLabel()

Returns the MetricLabel component.

Returns:

MetricLabel instance

getUpperLabelFrame

public UpperLabelFrame getUpperLabelFrame()

Returns the UpperLabelFrame component.

Returns:

UpperLabelFrame instance

getLowerLabelFrame

public LowerLabelFrame getLowerLabelFrame()

Returns the LowerLabelFrame component.

Returns:

LowerLabelFrame instance

getLegendArea

public LegendArea getLegendArea()

Returns the LegendArea component.

Returns:

LegendArea instance

getLegendText

public LegendText getLegendText()

Returns the LegendText component.

Returns:

LegendText instance

getLegendTitle

public LegendTitle getLegendTitle()

Returns the LegendTitle component.

Returns:

LegendTitle instance

getGaugeSetAlignment

public int getGaugeSetAlignment()

This method gets the alignment of gauges in the gauge set.

Returns:

Integer representing the alignment followed when laying out the gauges in the gauge set. Valid values are constants in this class starting with GAUGESET_ALIGNMENT_.

setGaugeSetAlignment

public void setGaugeSetAlignment(int alignment)

This method sets the alignment of gauges in the gauge set.

Parameters:

alignment - Integer representing the alignment followed when laying out the gauges in the gauge set. Valid values are constants in this class starting with GAUGESET_ALIGNMENT_.

getGaugeSetColumnCount

public int getGaugeSetColumnCount()

This method gets the number of columns used to layout the gauges in a gauge set.

Returns:

Integer representing the means by which gauges are laid out in a gauge set. Valid values are numbers greater than or equal to 1 and constants in this class starting with GAUGESET_COLUMNS_.

setGaugeSetColumnCount

public void setGaugeSetColumnCount(int columns)

This method sets the number of columns used to layout the gauges in a gauge set.

Parameters:

columns - Integer representing the means by which gauges are laid out in a gauge set. Valid values are numbers greater than or equal to 1 and constants in this class starting with GAUGESET_COLUMNS_.

getGaugeSetDirection

public int getGaugeSetDirection()

This method gets the layout direction of gauges in the gauge set.

Parameters:

Integer - representing the direction used when laying out the gauges in the gauge set. Valid values are constants in this class starting with GAUGESET_DIRECTION_.

setGaugeSetDirection

public void setGaugeSetDirection(int direction)

This method sets the layout direction of gauges in the gauge set.

Parameters:

direction - Integer representing the direction used when laying out the gauges in the gauge set. Valid values are constants in this class starting with GAUGESET_DIRECTION_.

getGaugeType

public int getGaugeType()

Returns the type of gauges to be generated by this instance of the Gauge bean.

Parameters:

type - Integer representing the type of gauges to be generated by this common gauge. Valid values are constants in the GaugeType class beginning with TYPE_.

setGaugeType

public void setGaugeType(int type)

Sets the type of gauges to be generated by this instance of the Common Gauge.

Parameters:

type - Integer representing the type of gauges to be generated by this common gauge. Valid values are constants in the GaugeType class beginning with TYPE_.

getLEDStyle

public int getLEDStyle()

Returns the style of LED gauge to be generated by this instance of the Gauge bean.

Parameters:

style - Integer representing the style of gauges to be generated by this common gauge. Valid values are constants in this class beginning with LS_.

setLEDStyle

public void setLEDStyle(int style)

Sets the style of LED gauges to be generated by this instance of the Common Gauge.

Parameters:

type - Integer representing the style of gauges to be generated by this common gauge. Valid values are constants in this class beginning with LS_.

getThresholdDialStyle

public int getThresholdDialStyle()

Returns the style of Threshold Dial gauge to be generated by this instance of the Gauge bean.

Returns:

style Integer representing the style of gauges to be generated by this common gauge. Valid values are constants in the Gauge class beginning with TDS_.

setThresholdDialStyle

public void setThresholdDialStyle(int style)

Sets the style of Threshold Dial gauge to be generated by this instance of the Gauge bean.

Parameters:

style - Integer representing the style of gauges to be generated by this common gauge. Valid values are constants in the Gauge class beginning with TDS_.

getLEDStyleCallback

public LEDStyleCallback getLEDStyleCallback()

Gets the callback to use when rendering custom LEDs.

Returns:

Instance of LEDStyleCallback

setLEDStyleCallback

public void setLEDStyleCallback(LEDStyleCallback callback)

Sets the callback to use when rendering custom LEDs.

Parameters:

callback - Instance of LEDStyleCallback

setBackgroundTransparent

public void setBackgroundTransparent(boolean transparent)

Specified by:

setBackgroundTransparent in interface ThickDataview

Parameters:

transparent - true to make the graph background transparent, otherwise false

For internal use only. Application developers should not use this

Sets the transparency of the graph background depending on the boolean argument passed.

convertGaugeTypeToInt

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

Parameters:

type - Integer representation of a gauge type

For internal use only. Application developers should not use this

Converts Gauge type String constants to Integer constants. This is used by get/setXML() and the ADF Faces Gauge tag library class.

convertGaugeTypeToString

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

Generates a String representation of a gauge type constant. This method takes a gauge type constant and produces a String that is appropriate to use as an attribute value when you use the BI Beans persistence service and search for gauges that have a particular gauge type.

For example:

 //pmMyFolder is the PersistenceManager for MyFolder
 BasicAttributes _attrs = new BasicAttributes();
 _attrs.put(PSRConstants.Attributes.OBJECT_TYPE, PSRConstants.GAUGE);
 _attrs.put(Gauge.GAUGE_TYPE, Gauge.convertGaugeTypeToString(Gauge.DIAL));
 

Parameters:

type - The gauge type constant that you want to convert.

Returns:

String representation of current gauge type

firePropertyChange

protected void firePropertyChange(java.lang.Object obj,
                                  java.lang.String propName,
                                  java.lang.Object oldValue,
                                  java.lang.Object newValue)

Specified by:

firePropertyChange in class Dataview

Parameters:

obj - the Object which has the getter/setter for this property

propName - String: the name of the property (minus get/set)

oldValue - Object: the previous value of the property

newValue - Object: the new value of the property

For internal use only. Application developers should not use this

Handle a property change for the entire bean.

refreshData

protected void refreshData()

Specified by:

refreshData in class Dataview

For internal use only. Application developers should not use this

Refreshes the gauge display.

setLayerMetaLongLabelSupported

protected void setLayerMetaLongLabelSupported(boolean supported)

Overrides:

setLayerMetaLongLabelSupported in class Dataview

For internal use only. Application developers should not use this

set the flag for LAYER_METADATA_LONGLABEL type true or false

setMetadataDrillSupported

protected void setMetadataDrillSupported(boolean supported)

For internal use only. Application developers should not use this

set the flag for METADATA_DRILLSTATE type true or false

isMetadataDrillSupported

protected boolean isMetadataDrillSupported()

Returns:

true if METADATA_DRILLSTATE is supported, else false

For internal use only. Application developers should not use this

setDataUnformattedSupported

protected void setDataUnformattedSupported(boolean supported)

Overrides:

setDataUnformattedSupported in class Dataview

For internal use only. Application developers should not use this

set DATA_UNFORMATTED type to true or false

setMetadataLongLabelSupported

protected void setMetadataLongLabelSupported(boolean supported)

Overrides:

setMetadataLongLabelSupported in class Dataview

For internal use only. Application developers should not use this

set METADATA_LONGLABEL type to true or false

setMetadataMediumLabelSupported

protected void setMetadataMediumLabelSupported(boolean supported)

Overrides:

setMetadataMediumLabelSupported in class Dataview

For internal use only. Application developers should not use this

set flag for METADATA_MEDIUMLABEL type to true or false

setMetadataShortLabelSupported

protected void setMetadataShortLabelSupported(boolean supported)

Overrides:

setMetadataShortLabelSupported in class Dataview

For internal use only. Application developers should not use this

set METADATA_SHORTLABEL type to true or false

setMetadataValueSupported

protected void setMetadataValueSupported(boolean supported)

Overrides:

setMetadataValueSupported in class Dataview

For internal use only. Application developers should not use this

set METADATA_VALUE type to true or false

setMetadataDrillParentDateSupported

protected void setMetadataDrillParentDateSupported(boolean supported)

For internal use only. Application developers should not use this

set the flag for METADATA_DRILL_PARENT_DATE type true or false

isMetadataDrillParentDateSupported

protected boolean isMetadataDrillParentDateSupported()

For internal use only. Application developers should not use this

set the flag for METADATA_DRILL_PARENT_DATE type true or false

setMetadataDrillParentDateSpanSupported

protected void setMetadataDrillParentDateSpanSupported(boolean supported)

For internal use only. Application developers should not use this

set the flag for METADATA_DRILL_PARENT_DATESPAN type true or false

isMetadataDrillParentDateSpanSupported

protected boolean isMetadataDrillParentDateSpanSupported()

For internal use only. Application developers should not use this

set the flag for METADATA_DRILL_PARENT_DATESPAN type true or false

setMetadataDateSupported

protected void setMetadataDateSupported(boolean supported)

For internal use only. Application developers should not use this

set the flag for METADATA_DATE type true or false

setMetadataDateSpanSupported

protected void setMetadataDateSpanSupported(boolean supported)

For internal use only. Application developers should not use this

set the flag for METADATA_DATESPAN type true or false

isMetadataDateSpanSupported

protected boolean isMetadataDateSpanSupported()

For internal use only. Application developers should not use this

set the flag for METADATA_DATESPAN type true or false

setLayerMetaMediumLabelSupported

protected void setLayerMetaMediumLabelSupported(boolean supported)

Overrides:

setLayerMetaMediumLabelSupported in class Dataview

For internal use only. Application developers should not use this

set flag for LAYER_METADATA_MEDIUMLABEL type to true or false

setLayerMetaShortLabelSupported

protected void setLayerMetaShortLabelSupported(boolean supported)

Overrides:

setLayerMetaShortLabelSupported in class Dataview

For internal use only. Application developers should not use this

set LAYER_METADATA_SHORTLABEL type to true or false

setLayerMetaNameSupported

protected void setLayerMetaNameSupported(boolean supported)

Overrides:

setLayerMetaNameSupported in class Dataview

For internal use only. Application developers should not use this

set LAYER_METADATA_NAME type to true or false

metadataLabelTypeChanged

protected void metadataLabelTypeChanged()

Overrides:

metadataLabelTypeChanged in class Dataview

For internal use only. Application developers should not use this

Update the view after the metadata label type has changed.

getViewXML

public DataviewXML getViewXML()

Specified by:

getViewXML in class Dataview

For internal use only. Application developers should not use this

getObjectNode

protected oracle.dss.util.xml.ObjectNode getObjectNode(boolean allProperties)

Specified by:

getObjectNode in class Dataview

For internal use only. Application developers should not use this

processAlertEvent

protected void processAlertEvent(int eventID)

modelDataChanged

public void modelDataChanged(DataChangedEvent e)

Description copied from interface: ModelListener

Inform view of changes to the actual data or metadata. This method is called by the ModelAdapter in response to data changes. Application developers do not need to call it.

Specified by:

modelDataChanged in interface ModelListener

Overrides:

modelDataChanged in class Dataview

Parameters:

e - information about the data change.

See Also:

ModelAdapter

For internal use only. Application developers should not use this

Inform view of changes to the actual data or metadata. Restricted to use by dataView code.

modelDataAvailable

public void modelDataAvailable(DataAvailableEvent e)

Description copied from interface: ModelListener

Inform view of changes to the data availability. This method is called by the ModelAdapter in response to data availability changes. Application developers do not need to call it.

Specified by:

modelDataAvailable in interface ModelListener

Overrides:

modelDataAvailable in class Dataview

Parameters:

e - information about the data availability

See Also:

ModelAdapter

For internal use only. Application developers should not use this

Inform view of changes to the data availability.

propertyChange

public void propertyChange(java.beans.PropertyChangeEvent evt)

Specified by:

propertyChange in interface java.beans.PropertyChangeListener

setXMLAsString

public boolean setXMLAsString(java.lang.String xml)
                       throws oracle.dss.util.persistence.BIPersistenceException

Specifies the XML representation of this Gauge. The persistence service calls this method when the view is restored from the BI Beans Catalog. This method does not reset any properties before applying the XML to this Graph.

Application developers should not call this method. To load XML from a file, call setXML or readXML.

Specified by:

setXMLAsString in interface oracle.dss.util.persistence.StringXMLizable

Specified by:

setXMLAsString in class Dataview

Parameters:

xml - The XML representation of the view.

Returns:

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

Throws:

BIPersistenceException - If a problem occurs in setting the XML.

oracle.dss.util.persistence.BIPersistenceException - If a problem occurs in setting the XML.

See Also:

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

setPersistableComponents

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

Specified by:

setPersistableComponents in interface oracle.dss.util.persistence.contract.AggregableContract

Overrides:

setPersistableComponents in class Dataview

Parameters:

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

For internal use only. Application developers should not use this

Specifies the components associated with the gauge

getPersistableAttributes

public oracle.dss.util.persistence.PersistableAttributes getPersistableAttributes(oracle.dss.util.persistence.PersistableAttributes oldAttrs)

Description copied from class: Dataview

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

Specified by:

getPersistableAttributes in interface oracle.dss.util.persistence.SimplePersistable

Specified by:

getPersistableAttributes in class Dataview

Parameters:

attrs - a PersistableAttributes value that represents the searchable attributes set by the user application.

Returns:

PersistableAttributes which represent the searchable properties of the gauge (the ones passed into the method augmented by gauge-specific properties).

For internal use only. Application developers should not use this

Reterun a structure consisting of PeristableAttibutes (i.e. search attributes associated with this gauge) which are used for searching for this gauge in the database.

startExport

public boolean startExport()

Returns:

true if the view can begin exporting, false if not

For internal use only. Application developers should not use this

Inform the view that an export has started.

endExport

public void endExport()

For internal use only. Application developers should not use this

Inform the view that an export has ended.

isExporting

public boolean isExporting()

Returns:

true if exporting, false if not

For internal use only. Application developers should not use this

Determine if this view is currently exporting to Excel.