public class Gauge extends Dataview implements GaugeConstants, java.beans.PropertyChangeListener, ThickGauge
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: dsstools/modules/dvt-jclient/src/oracle/dss/gauge/Gauge.java /bibeans_root/31 2016/02/11 13:21:29 ltribble Exp $
setTabularData(java.lang.Object[], java.util.List),
DataAccess,
DataDirector,
Serialized Formjavax.swing.JPanel.AccessibleJPaneljavax.swing.JComponent.AccessibleJComponentjava.awt.Container.AccessibleAWTContainerjava.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategyGaugeConstants.HorizontalAlignment| Modifier and Type | Field and Description |
|---|---|
protected GaugeController |
_gaugeController |
protected GaugeModel |
_gaugeModel |
protected GaugePanel |
_gaugePanel |
protected java.awt.Image |
_offscreenImage |
protected boolean |
_printOrPreviewMode |
protected boolean |
_stopRepaints |
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, pagingControl, printOrPreviewMode, propertyChangeListenerList, subcomponent, titlePanel, undoSupport, vetoableChangeListenerList, vetoSupportTOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOWaccessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENTa_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, VERTICALSTATUSMETERGAUGESET_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_ALIGNMENTANGLE_EXTENT, BACKGROUND_BORDERCOLOR, BACKGROUND_FILLCOLOR, BACKGROUND_SFX, BOTTOM_LABEL, BOTTOM_LABEL_ARRAY, BOTTOM_LABEL_COLOR, BOTTOM_LABEL_FONT, BOTTOM_LABEL_MAP, BOTTOM_LABEL_POSITION, BOTTOM_LABEL_TEXT, BOTTOM_LABEL_VISIBLE, CL_MAX, CL_MIN, CL_NONE, CL_OUTER_FRAME, CL_TITLE_SEPARATOR, COL_FOR_INDEX, COL_FOR_THRESHOLD_INDEX, 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, FLASH_BIDI_TEXT, 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, MAJORTICK_STEP, 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, METRIC_NAME, MIN_VALUE, MINORTICK_COLOR, MINORTICK_COUNT, MINORTICK_STEP, 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, ROW_FOR_INDEX, ROW_FOR_THRESHOLD_INDEX, 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_MAP, TOP_LABEL_POSITION, TOP_LABEL_TEXT, TOP_LABEL_VISIBLE, UPLBLFRAME_BORDERCOLOR, UPLBLFRAME_FILLCOLOR, UPLBLFRAME_SFX, UPLBLFRAME_VISIBLEabove_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_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 |
|---|
Gauge()
Constructor that does not specify a
DataSource. |
Gauge(DataSource dataSource)
Constructor that specifies a
DataSource. |
Gauge(ErrorHandler errorHandler)
Constructor that specifies a
ErrorHandler. |
| Modifier and Type | Method and Description |
|---|---|
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)
Specifies a list of
Persistable components that the
component aggregates. |
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.
|
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, getFootnotePanel, getHTMLPagingControlWidth, getIntlString, getIntlString, getLayerMetadataLabelType, getLayerMetadataLabelType, getLocalName, getMemberMetadataLabelType, getMemberMetadataLabelType, getModel, getName, getNameFromID, getObjectNode, getPagingControl, getPagingControlPosition, getPersistableComponents, getPhysicalComponents, getPopupManager, getRolloverTextManager, getStyleXML, getSubcomponent, getSubcomponent, getTitlePanel, 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, writeXMLgetAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUIaddAncestorListener, 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, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, 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, updateadd, 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, transferFocusDownCycle, validate, validateTreeaction, 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, 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, transferFocusBackward, transferFocusUpCycleclone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitgetDataviewFootnote, getDataviewSubtitle, getDataviewTitle, isEnabled, isShowing, repaint, setEnabled, setPagingControlVisiblegetHTMLPagingControlWidth, getLayerMetadataLabelType, getMemberMetadataLabelType, getPagingControlPosition, isDrillingEnabled, isDrillingSupported, isHTMLPagingControlAutosubmit, isPagingControlVisible, setDrillingEnabled, setHTMLPagingControlAutosubmit, setHTMLPagingControlWidth, setLayerMetadataLabelType, setMemberMetadataLabelType, setPagingControlPositiongetDescription, getLocalName, getName, setDescription, setLocalName, setNamerepaint@Concealed protected GaugeModel _gaugeModel
@Concealed protected GaugeController _gaugeController
protected GaugePanel _gaugePanel
@Concealed protected java.awt.Image _offscreenImage
@Concealed protected boolean _printOrPreviewMode
@Concealed protected boolean _stopRepaints
public Gauge()
DataSource.
If you use this constructor, call the setDataSource method
to specify the data that this gauge displays.public Gauge(DataSource dataSource)
DataSource.dataSource - The DataSource from which this gauge
will request data.public Gauge(ErrorHandler errorHandler)
ErrorHandler.errorHandler - The ErrorHandler to use.@Concealed public CommonGauge getCommonGauge()
protected void _initGauge(DataSource ds, ErrorHandler eh)
@Concealed protected void _createPagingControl()
public java.awt.Dimension getSize()
getSize in interface ThickGaugegetSize in class java.awt.Component@Concealed public void paint(java.awt.Graphics g)
paint in class javax.swing.JComponent@Concealed public void setPrintOrPreviewMode(boolean bool)
public void exportToPNG(java.io.OutputStream os)
os - The OutputStream that specifies the
location and name of the PNG file.exportToPNGWithException(java.io.OutputStream)public void exportToPNGWithException(java.io.OutputStream os)
throws oracle.dss.graph.pfj.png.PNGInvalidParameterException,
oracle.dss.graph.pfj.png.PNGException
os - The OutputStream that specifies the
location and name of the PNG file.oracle.dss.graph.pfj.png.PNGInvalidParameterExceptionoracle.dss.graph.pfj.png.PNGExceptionexportToPNG(java.io.OutputStream)public void exportToSVG(java.io.OutputStream os,
int mode,
java.lang.String charEnc)
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 SVGpublic void exportToFlash(java.io.OutputStream os,
boolean renderDynamic,
boolean showDrawing)
os - the outputstream associated with the flash filerenderDynamic - 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.public void exportToSVGWithException(java.io.OutputStream os,
int mode,
java.lang.String charEnc)
throws java.io.IOException,
java.lang.Exception
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 SVGjava.io.IOException - if there was a problem writing to the streamjava.lang.Exception - if another problem occurredpublic void exportToSVG(java.io.Writer writer,
int mode,
java.lang.String charEnc)
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 SVGpublic void exportToSVGWithException(java.io.Writer writer,
int mode,
java.lang.String charEnc)
throws java.io.IOException,
java.lang.Exception
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 SVGjava.io.IOException - if there was a problem writing to the writerjava.lang.Exception - if another problem occurredpublic DataSpecification getDataSpecification()
DataSpecification for this bean.DataSpecification for this bean.
If a beans data specification has not been set for this
view, this method returns null.public void setDataSpecification(DataSpecification dataSpec)
DataSpecification for this bean,
assuming it is relevant to the current
DataSource.dataSpec - The DataSpecification
for this bean.public GaugeController getGaugeController()
GaugeController for this gauge.@Concealed public void setGaugeController(GaugeController gaugeController)
gaugeController - The controller for this gauge to use.
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.
public GaugeModel getGaugeModel()
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.GaugeModel that this gauge uses.@Concealed public void setGaugeModel(GaugeModel gaugeModel)
gaugeModel - The GaugeModel for this gauge to use.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.
public java.util.Enumeration getImagemapEnumeration(int filter)
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.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_.ImagemapComponentpublic java.awt.Dimension getImageSize()
Dimension object.public void setImageSize(java.awt.Dimension d)
d - The size to make the gauge.exportToPNG(java.io.OutputStream),
exportToPNGWithException(java.io.OutputStream),
exportToSVG(java.io.OutputStream, int, java.lang.String),
exportToSVGWithException(java.io.OutputStream, int, java.lang.String)public java.util.Locale getLocale()
Locale that this Gauge uses.public java.awt.Dimension getOptimalGaugeSize(java.awt.Dimension maxSize)
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.
maxSize - Dimensions to use in determining
optimal gauge size.Dimension containing the
size of the largest gauge in this gauge set.setImageSize(java.awt.Dimension)@Concealed public oracle.dss.util.xml.ObjectNode getPagingControlXML(boolean allProperties)
getPagingControlXML in interface ThickDataviewpublic void setPagingControlXML(oracle.dss.util.xml.ObjectNode pagingControl,
java.lang.String version,
int reset)
setPagingControlXML in interface ThickDataviewpublic int getPresentationHeight()
getPresentationHeight in class Dataviewpublic int getPresentationWidth()
getPresentationWidth in class Dataviewpublic boolean selectObject(ComponentHandle id)
selectObject in class Dataviewid - A ComponentHandle that represents the component to
select.true if the component is successfully selected,
false if not.@Concealed public boolean selectObjectFromEvent(java.awt.event.MouseEvent e)
e - Instance of MouseEventTrue if the component under the point
was selected, False otherwisepublic ComponentHandle getSelectedObject()
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).
getSelectedObject in interface UIViewgetSelectedObject in class Dataview@Concealed public java.lang.String getVersion()
getVersion in interface ThickDataviewgetVersion in class Dataviewpublic int getViewType()
Dataview.
This method returns Dataview.VIEW_TYPE_GAUGE.getViewType in interface DataviewCommongetViewType in interface UIViewgetViewType in class DataviewDataview.VIEW_TYPE_GAUGEDataviewConstants.VIEW_TYPE_GAUGE@Concealed public boolean isPrintOrPreviewMode()
isPrintOrPreviewMode in class Dataviewpublic boolean isSwapAllowed()
true, then users can swap items
by clicking the two items.
When this method returns false, then users must move each
item separately.isSwapAllowed in interface ThickDataviewisSwapAllowed in class Dataviewtrue if swapping is enabled,
false if it is not.setSwapAllowed(boolean)public void setSwapAllowed(boolean swap)
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.
setSwapAllowed in interface ThickDataviewsetSwapAllowed in class Dataviewswap - true to enable swapping,
false to disable it.isSwapAllowed(),
DataDirectorpublic boolean readXML(java.io.InputStream stream,
boolean reset)
throws oracle.dss.util.xml.BIIOException,
oracle.dss.util.xml.BISAXException,
oracle.dss.util.xml.BIParseException
readXML(InputStream, int)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.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.BIIOExceptionoracle.dss.util.xml.BISAXExceptionoracle.dss.util.xml.BIParseExceptionpublic boolean readXML(java.io.InputStream stream,
int reset)
throws oracle.dss.util.xml.BIIOException,
oracle.dss.util.xml.BISAXException,
oracle.dss.util.xml.BIParseException
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:
Gauge without
resetting anything to default values
Gauge
Resetting returns property values in the Gauge to the
default values for the version that is specified in the XML.
readXML in class Dataviewstream - 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.true if the XML is successfully applied to
this Gauge,
false if an IO exception occurs.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.DataviewConstants.RESET_NONE,
DataviewConstants.RESET_XML_PROPERTIES,
DataviewConstants.RESET_EVERYTHINGpublic boolean renderGauges(java.awt.Graphics2D g)
Graphics.g - Instance of Graphics to useTrue if the gauge components rendered
successfully, False if they
could not be rendered.@Concealed public void resetEverything(int reset)
resetEverything in interface ThickDataviewreset - 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.@Concealed
public void resetSuper(int reset,
java.lang.String version)
resetSuper in interface ThickDataviewversion - the gauge XML version number, as stored in XMLpublic void resetToDefault(int reset)
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.
resetToDefault in class Dataviewreset - 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.DataviewConstants.RESET_XML_PROPERTIES,
DataviewConstants.RESET_EVERYTHING@Concealed public void resetXMLProps()
resetXMLProps in interface ThickDataviewversion - the gauge XML version number, as stored in XML@Concealed public void setContext()
setContext in class Dataviewpublic void setDataSource(DataSource ds)
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.setDataSource in interface DataviewCommonsetDataSource in interface ThickDataviewsetDataSource in class Dataviewds - The DataSource for this gauge to use.public void setDataSource(DataSource ds, DataSpecification specs)
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.ds - The DataSource for this gauge to use.specs - Instance of DataSpecification
class.@Concealed
public boolean setGridData(java.lang.Object[] specs,
java.lang.Object[] columnLabels,
java.lang.Object[] rowLabels,
java.lang.Object[][] data)
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 StringsrowLabels - labels for the rows of data;
typically Stringsdata - values to be plotted in the gauge, indexed
first by column, then by row; typically Doubles
and Date in case of TimeSeries gaugestrue if data is successfully set on the gauge,
false otherwiseGauge.
Data is provided in grid form, where the number of rows and
columns are known ahead of time.@Concealed public int getStartColumn()
@Concealed public void setStartColumn(int c)
c - The first column of data to display.public int getStartRow()
#getStartSeries or by
#getStartGroup.public void setStartRow(int r)
r - The first row of data to display.public boolean setTabularData(java.lang.Object[] specs,
java.util.List tableRows)
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.
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.true if data is successfully set on the
gauge bean, false if there is a data
problem.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
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:
Gauge without
resetting anything to default values
Gauge
Resetting returns property values in the Gauge to the
default values for the version that is specified in the XML.
setXML in class DataviewxmlString - 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.true if the XML is successfully applied to
this Gauge,
false if an IO exception occurs.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.DataviewConstants.RESET_NONE,
DataviewConstants.RESET_XML_PROPERTIES,
DataviewConstants.RESET_EVERYTHINGpublic void writeImagemapXML(java.io.OutputStream os,
int filter)
filter are defined in this class and
begin with MAP_.os - The output stream where XML will be written.filter - The kinds of gauge components whose information you
want to write in XML.getImagemapEnumeration(int),
DataviewConstants.MAP_ALL,
DataviewConstants.MAP_DATA,
DataviewConstants.MAP_LABELS,
DataviewConstants.MAP_TITLESpublic void writeImagemapXML(java.io.PrintWriter out,
int filter)
filter are defined in this class and
begin with MAP_.out - The print writer where XML will be written.filter - The kinds of gauge components whose information you
want to write in XML.getImagemapEnumeration(int),
DataviewConstants.MAP_ALL,
DataviewConstants.MAP_DATA,
DataviewConstants.MAP_LABELS,
DataviewConstants.MAP_TITLES@Concealed public void updatePageItems()
updatePageItems in interface ThickDataviewpublic GaugeSetBackground getGaugeSetBackground()
GaugeSetBackground instancepublic GaugeBackground getGaugeBackground()
GaugeBackground instancepublic GaugeFrame getGaugeFrame()
GaugeFrame instancepublic PlotArea getPlotArea()
PlotArea instancepublic TickLabel getTickLabel()
TickLabel instancepublic TickMark getTickMark()
TickMark instancepublic Indicator getIndicator()
Indicator instancepublic Threshold getThreshold()
Threshold instancepublic TopLabel getTopLabel()
TopLabel instancepublic BottomLabel getBottomLabel()
BottomLabel instancepublic MetricLabel getMetricLabel()
MetricLabel instancepublic UpperLabelFrame getUpperLabelFrame()
UpperLabelFrame instancepublic LowerLabelFrame getLowerLabelFrame()
LowerLabelFrame instancepublic LegendArea getLegendArea()
LegendArea instancepublic LegendText getLegendText()
LegendText instancepublic LegendTitle getLegendTitle()
LegendTitle instancepublic int getGaugeSetAlignment()
public void setGaugeSetAlignment(int alignment)
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_.public int getGaugeSetColumnCount()
public void setGaugeSetColumnCount(int columns)
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_.public int getGaugeSetDirection()
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_.public void setGaugeSetDirection(int direction)
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_.public int getGaugeType()
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_.public void setGaugeType(int type)
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_.public int getLEDStyle()
style - Integer representing the style of gauges
to be generated by this common gauge.
Valid values are constants in this class
beginning with LS_.public void setLEDStyle(int style)
type - Integer representing the style of gauges
to be generated by this common gauge.
Valid values are constants in this class
beginning with LS_.public int getThresholdDialStyle()
Gauge class beginning
with TDS_.public void setThresholdDialStyle(int style)
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_.public LEDStyleCallback getLEDStyleCallback()
LEDStyleCallbackpublic void setLEDStyleCallback(LEDStyleCallback callback)
callback - Instance of LEDStyleCallback@Concealed public void setBackgroundTransparent(boolean transparent)
setBackgroundTransparent in interface ThickDataviewtransparent - true to make the graph background
transparent, otherwise false@Concealed public static int convertGaugeTypeToInt(java.lang.String type)
type - Integer representation of a gauge typepublic static java.lang.String convertGaugeTypeToString(int type)
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));
type - The gauge type constant that you want to convert.String representation of current gauge type@Concealed
protected void firePropertyChange(java.lang.Object obj,
java.lang.String propName,
java.lang.Object oldValue,
java.lang.Object newValue)
firePropertyChange in class Dataviewobj - the Object which has the getter/setter for this propertypropName - String: the name of the property (minus get/set)oldValue - Object: the previous value of the propertynewValue - Object: the new value of the property@Concealed protected void refreshData()
refreshData in class Dataview@Concealed protected void setLayerMetaLongLabelSupported(boolean supported)
setLayerMetaLongLabelSupported in class Dataview@Concealed protected void setMetadataDrillSupported(boolean supported)
@Concealed protected boolean isMetadataDrillSupported()
@Concealed protected void setDataUnformattedSupported(boolean supported)
setDataUnformattedSupported in class Dataview@Concealed protected void setMetadataLongLabelSupported(boolean supported)
setMetadataLongLabelSupported in class Dataview@Concealed protected void setMetadataMediumLabelSupported(boolean supported)
setMetadataMediumLabelSupported in class Dataview@Concealed protected void setMetadataShortLabelSupported(boolean supported)
setMetadataShortLabelSupported in class Dataview@Concealed protected void setMetadataValueSupported(boolean supported)
setMetadataValueSupported in class Dataview@Concealed protected void setMetadataDrillParentDateSupported(boolean supported)
@Concealed protected boolean isMetadataDrillParentDateSupported()
@Concealed protected void setMetadataDrillParentDateSpanSupported(boolean supported)
@Concealed protected boolean isMetadataDrillParentDateSpanSupported()
@Concealed protected void setMetadataDateSupported(boolean supported)
@Concealed protected void setMetadataDateSpanSupported(boolean supported)
@Concealed protected boolean isMetadataDateSpanSupported()
@Concealed protected void setLayerMetaMediumLabelSupported(boolean supported)
setLayerMetaMediumLabelSupported in class Dataview@Concealed protected void setLayerMetaShortLabelSupported(boolean supported)
setLayerMetaShortLabelSupported in class Dataview@Concealed protected void setLayerMetaNameSupported(boolean supported)
setLayerMetaNameSupported in class Dataview@Concealed protected void metadataLabelTypeChanged()
metadataLabelTypeChanged in class Dataview@Concealed public DataviewXML getViewXML()
getViewXML in class Dataview@Concealed protected oracle.dss.util.xml.ObjectNode getObjectNode(boolean allProperties)
getObjectNode in class Dataviewprotected void processAlertEvent(int eventID)
@Concealed public void modelDataChanged(DataChangedEvent e)
ModelListenermodelDataChanged in interface ModelListenermodelDataChanged in class Dataviewe - information about the data change.ModelAdapter@Concealed public void modelDataAvailable(DataAvailableEvent e)
ModelListenermodelDataAvailable in interface ModelListenermodelDataAvailable in class Dataviewe - information about the data availabilityModelAdapterpublic void propertyChange(java.beans.PropertyChangeEvent evt)
propertyChange in interface java.beans.PropertyChangeListenerpublic boolean setXMLAsString(java.lang.String xml)
throws oracle.dss.util.persistence.BIPersistenceException
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.
setXMLAsString in interface oracle.dss.util.persistence.StringXMLizablesetXMLAsString in class Dataviewxml - The XML representation of the view.true if the XML was successfully set,
false if not.BIPersistenceException - If a problem occurs in setting the XML.oracle.dss.util.persistence.BIPersistenceException - If a problem occurs in setting the XML.readXML(java.io.InputStream, boolean),
setXML(java.lang.String, int)@Concealed public void setPersistableComponents(oracle.dss.util.persistence.AggregateInfo[] persistables)
oracle.dss.util.persistence.contract.AggregableContractPersistable components that the
component aggregates.setPersistableComponents in interface oracle.dss.util.persistence.contract.AggregableContractsetPersistableComponents in class Dataviewaggregates - a AggregateInfo[] value that represents the
components to assign to the gauge.@Concealed public oracle.dss.util.persistence.PersistableAttributes getPersistableAttributes(oracle.dss.util.persistence.PersistableAttributes oldAttrs)
DataviewDataview, 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.getPersistableAttributes in interface oracle.dss.util.persistence.SimplePersistablegetPersistableAttributes in class Dataviewattrs - a PersistableAttributes value that represents the
searchable attributes set by the user application.PersistableAttributes which represent the searchable
properties of the gauge (the ones passed into the method augmented
by gauge-specific properties).PeristableAttibutes (i.e.
search attributes associated with this gauge) which are used for searching
for this gauge in the database.@Concealed public boolean startExport()
@Concealed public void endExport()
@Concealed public boolean isExporting()