oracle.dss.thin.beans.graph
Class ThinGraph

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--javax.swing.JComponent
                    |
                    +--javax.swing.JPanel
                          |
                          +--oracle.dss.dataView.Dataview
                                |
                                +--oracle.dss.graph.Graph
                                      |
                                      +--oracle.dss.thin.beans.graph.ThinGraph

All Implemented Interfaces:

javax.accessibility.Accessible, CheckpointState, ComponentTypeConverter, DataviewCommon, ErrorHandlerCallback, GraphAttribute, java.awt.image.ImageObserver, java.awt.MenuContainer, PagingControlAttributes, Persistable, java.io.Serializable, StringXMLizable, ThinBean, ThinBeanUI, ThinDataviewCommon, UIDataview, UIGraph

public class ThinGraph

extends Graph

implements ThinDataviewCommon

The thin graph bean class. This graph uses Perspective for Java, from Three-D Graphics, to produce a graphical presentation of data.

To display data in this graph, 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.

You can set properties on the graph to customize its appearance and behavior. In addition, the graph has a number of components, whose properties you can also set in order to customize the graph.

ThinGraphs generate and handle all of the events that are defined in the ThinDataviewCommon interface.

For more information about using the thin graph, see the "Thin Graph Bean" topic in the BI Beans Help system.

See Also:

ThinDataviewCommon, Serialized Form

Inner classes inherited from class javax.swing.JComponent

javax.swing.JComponent.AccessibleJComponent

Field Summary

static int	GROUP_UNDEFINED Constant for undefined Group
static int	SERIES_UNDEFINED Constant for undefined Series

Fields inherited from class oracle.dss.graph.Graph

ACP_ALWAYS, ACP_NEVER, AL_ALWAYS, AL_AS_NEEDED, AL_NEVER, AREA_VERT_ABS, AREA_VERT_ABS_SPLIT2Y, AREA_VERT_PERCENT, AREA_VERT_STACK, AREA_VERT_STACK_SPLIT2Y, AREAMARKER, BACKGROUND, BAR_HORIZ_CLUST, BAR_HORIZ_CLUST_2Y, BAR_HORIZ_CLUST_SPLIT2Y, BAR_HORIZ_STACK, BAR_HORIZ_STACK_2Y, BAR_HORIZ_STACK_SPLIT2Y, BAR_VERT_CLUST, BAR_VERT_CLUST_SPLIT2Y, BAR_VERT_CLUST2Y, BAR_VERT_PERCENT, BAR_VERT_STACK, BAR_VERT_STACK_SPLIT2Y, BAR_VERT_STACK2Y, BUBBLE, BUBBLE_2Y, COLOR_BY_GROUP, COLOR_BY_SERIES, CONNECTOR, DATALINE, DATAMARKER, DDT_CUBE, DDT_RELATIONAL, FITLINE, GRAPH, GRAPH_TYPE, GROUPANDSERIESLIMIT, HONOR_PROPERTIES, LEGENDAREA, LEGENDMARKER, LEGENDTEXT, LINE_VERT_ABS, LINE_VERT_ABS_2Y, LINE_VERT_ABS_SPLIT2Y, LINE_VERT_PERCENT, LINE_VERT_STACK, LINE_VERT_STACK_2Y, LINE_VERT_STACK_SPLIT2Y, MAP_ALL, MAP_DATA, MAP_DATATEXT, MAP_LABELS, MAP_LEGEND, MAP_ORDINALLABELS, MAP_TITLES, MARKERTEXT, MTT_CUM_VAL, MTT_NONE, MTT_PERCENT_VAL, MTT_PERCENT_VAL_TEXT, MTT_PERCENT_VAL_VALUES, MTT_PERCENT_VAL_VALUES_TEXT, MTT_TEXT, MTT_VALUES, MTT_VALUES_TEXT, O1AXIS, O1MAJORTICK, O1TICKLABEL, O1TITLE, PARETO, PARETOLINE, PIE, PIE_BAR, PIE_MULTI, PIEFEELER, PIEFRAME, PIELABEL, PLOTAREA, POLAR, QUADRANTLINE, RADAR_LINE, REFERENCELINEMARKER, REFERENCELINETEXT, RESET_PROPERTIES, RING, RING_BAR, RING_MULTI, RINGTOTALLABEL, SCATTER, SCATTER_2Y, SERIES, SERIESOBJECTCOUNTLIMIT, SLICE, SLICELABEL, SP_ALWAYS, SP_AS_NEEDED, SP_NEVER, SPLITDIVIDER, STOCK_CANDLE, STOCK_CANDLE_VOLUME, STOCK_HILO_CLOSE, STOCK_HILO_CLOSE_VOLUME, STOCK_OHLC_CANDLE, STOCK_OHLC_CANDLE_VOLUME, STOCK_OPEN_HILO_CLOSE, STOCK_VOLUME, STOCKMARKER, TEXT_COMPONENTS_ALL, TEXT_COMPONENTS_NONE, THREED_AREA_SERIES, THREED_BAR, THREED_CUBE, THREED_RIBBON_SERIES, THREED_SURFACE, THREEDFLOOR, THREEDLEFTWALL, THREEDMARKER, THREEDRIGHTWALL, TLT_DIM_MEMBER, TLT_MEMBER, TLT_NONE, TWODMARKER, UNDEFINED, UNDEFINEDTYPE, VOLUMEMARKER, X1AXIS, X1MAJORTICK, X1REFERENCELINE, X1TICKLABEL, X1TITLE, XPANELGRID, XTICKLBL, XVALUE, Y1AXIS, Y1MAJORTICK, Y1REFERENCELINE, Y1TICKLABEL, Y1TICKLBL, Y1TITLE, Y1VALUE, Y1ZEROLINE, Y2AXIS, Y2MAJORTICK, Y2REFERENCELINE, Y2TICKLABEL, Y2TICKLBL, Y2TITLE, Y2VALUE, Y2ZEROLINE, Y3DMARKERGRID, YPANELGRID, ZPANELGRID, ZTICKLABEL, ZTITLE, ZVALUE

Fields inherited from class oracle.dss.dataView.Dataview

DATAVIEW_FOOTNOTE, DATAVIEW_FOOTNOTE_NAME, DATAVIEW_SUBTITLE, DATAVIEW_SUBTITLE_NAME, DATAVIEW_TITLE, DATAVIEW_TITLE_NAME, DEFAULT_ZOOM_FACTOR, FOOTNOTE, FOOTNOTE_NAME, PAGE_CONTROL, PAGE_HEADER, PAGE_HEADER_NAME, PAGE_ITEM, PAGE_ITEM_NAME, PAGING_COMPONENT_NAME, PAGING_CONTROL_ABOVE_TITLES, PAGING_CONTROL_BELOW_TITLES, RESET_EVERYTHING, RESET_NONE, RESET_XML_PROPERTIES, SUBTITLE, SUBTITLE_NAME, TITLE, TITLE_NAME, VIEW_TYPE_CROSSTAB, VIEW_TYPE_GRAPH, VIEW_TYPE_TABLE

Fields inherited from class javax.swing.JComponent

TOOL_TIP_TEXT_KEY, 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.thin.beans.dataView.ThinDataviewCommon

INLINE_ERROR_MSG, INLINE_INFO_MSG, INLINE_WARNING_MSG

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

EVENT_HANDLED, EVENT_NOT_HANDLED, EVENT_RESPONSE_DONE

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

ThinGraph()
Constructor that does not specify a DataSource.

ThinGraph(DataSource dataSource)
Constructor that specifies a DataSource.

ThinGraph(DataSource dataSource, int type)
Constructor that specifies a DataSource and the type of DataDirector that this Graph will use.

Method Summary

void	addThinViewListener(ThinViewListener l) Adds a listener for ThinDataviewCommon events, such as export events and save events.
void	applyXSS(oracle.cabo.style.StyleContext context, oracle.cabo.style.StyleMap map) Applies font and antialiasing settings from a Cabo XSS sheet to a graph instance.
void	checkpointState() Initiates tracking of checkpoint state.
java.lang.String	getCheckpointState() Retrieves state differences since the last call to checkpointState.
EventTarget	getEventTarget(java.lang.String event) Retrieves the event target for the specified event.
java.lang.String	getExportCharacterEncoding() Retrieves the character encoding that this ThinDataviewCommon uses when it exports its data.
GraphTypeConverter	getGraphTypeConverter() Overriden to always provide an instance of default GraphTypeConverter for ThinGraph
ImagemapAction	getImagemapAction(int componentID, int series, int group) Retrieves actions assigned to a an image map component or a group of components
java.lang.String	getInlineMessage() Retrieves the inline message text to display.
int	getInlineMessageType() Retrieves the type of inline message to display.
java.lang.String	getState() Retrieves the state of this thin bean.
java.lang.String	getThinBeanName() Retrieves the unique name of this thin bean.
int	handleEvent(QueryParameterProvider provider) Handles a thin-bean event.
boolean	hasImagemapActions() Deternines whether ThinGraph has any image map actions assigned
boolean	isExternalFootnoteVisible() Indicates whether a footnote appears outside the view.
boolean	isExternalSubtitleVisible() Indicates whether a subtitle appears outside the view.
boolean	isExternalTitleVisible() Indicates whether a title appears outside the view.
void	removeThinViewListener(ThinViewListener l) Removes a listener for ThinDataviewCommon events.
void	resetToDefault(int reset) Resets properties of this ThinDataview to their default values.
void	setBaseState() Establishes a base state for the ThinBean, from which state changes are tracked.
void	setCheckpointState(java.lang.String state) Sets on this thin bean the state changes since the last call to checkpointState.
void	setEventTarget(java.lang.String event, EventTarget target) Specifies an event target for an event that this ThinBeanUI generates.
void	setExportCharacterEncoding(java.lang.String encoding) Specifies the character encoding to use when exporting the view.
void	setExternalFootnoteVisible(boolean b) Specifies whether a footnote for this ThinDataviewCommon appears outside the view.
void	setExternalSubtitleVisible(boolean b) Specifies whether a subtitle for this ThinDataviewCommon appears outside the view.
void	setExternalTitleVisible(boolean b) Specifies whether a title for this ThinDataviewCommon appears outside the view.
void	setImagemapAction(int componentID, int series, int group, ImagemapAction action) Assignes actions to a an image map component or a group of components To assign actions by series and/or group ID only, use ThinGraph.UNDEFINED for componentID.
void	setImagemapAction(int componentID, int series, int group, java.lang.String href) Assignes an HREF action to an image map component or a group of components To assign an action by series and/or group ID only, use ThinGraph.UNDEFINED for componentID.
void	setInlineMessage(java.lang.String msg) Specifies the inline message text to display.
void	setInlineMessageType(int type) Specifies the type of temporary inline message to display.
void	setState(java.lang.String state) Sets the state of this ThinBean.
void	setThinBeanName(java.lang.String thinBeanName) Specifies a unique name for this thin bean.

Methods inherited from class oracle.dss.graph.Graph

addAlertListener, addKeyListener, addMouseListener, addMouseMotionListener, beginAxisChanges, calculatePlacement, cleanUp, convertGraphTypeToString, createExceptionalRiser, destroyAllExceptionalRisers, doAutoLayout, endAxisChanges, exportToGIF, exportToGIFWithException, exportToJPEG, exportToPNG, exportToPNGWithException, get2DMarker, get3DFloor, get3DLeftWall, get3DMarker, get3DRightWall, get3DViewMatrix, getAreaMarker, getAutoLayout, getAutomaticComponentPlacement, getColorMode, getColumnCount, getConnector, getCustomToolTipCallback, getDataAccessSliceLabel, getDataDirectorType, getDataErrorFont, getDataErrorTextCallback, getDataFilter, getDataLine, getDataMarker, getDefaultImageSize, getDepthAngle, getDepthRadius, getDisplayGroups, getDisplayGroupsLimit, getDisplaySeries, getDisplaySeriesLimit, getDrillDimension, getFitline, getFootnote, getGraphBackground, getGraphController, getGraphFormatManager, getGraphModel, getGraphStyleManager, getGraphType, getGroupSize, getGroupTooltipLabelType, getImagemapEnumeration, getImageSize, getLegendArea, getLegendMarker, getLegendScrollbarPresence, getLegendSeriesCount, getLegendSeriesStart, getLegendText, getMarkerText, getMarkerTooltipType, getMaxBarWidth, getMaxTickLabelAutoFontSize, getMinimumGroups, getMinimumSeries, getMinTickLabelAutoFontSize, getO1Axis, getO1MajorTick, getO1TickLabel, getO1Title, getParetoLine, getPieBarSeries, getPieDepth, getPieFeeler, getPieFrame, getPieLabel, getPieRotation, getPieTilt, getPlotArea, getPresentationHeight, getPresentationWidth, getQuadrantLine, getReferenceLineMarker, getReferenceLineText, getRingTotalLabel, getRowCount, getScaleFontSizeForGIF, getScrollbarPresenceGroups, getScrollbarPresenceSeries, getSelectedObject, getSeries, getSeriesObjectCount, getSeriesTooltipLabelType, getSlice, getSliceLabel, getSplitDivider, getStartColumn, getStartGroup, getStartRow, getStartSeries, getStockMarker, getSubtitle, getTimeZone, getTitle, getToolTipDelay, getViewType, getVolumeMarker, getX1Axis, getX1MajorTick, getX1ReferenceLine, getX1TickLabel, getX1Title, getXPanelGrid, getY1Axis, getY1BaseLine, getY1MajorTick, getY1ReferenceLine, getY1TickLabel, getY1Title, getY1ZeroLine, getY2Axis, getY2BaseLine, getY2MajorTick, getY2ReferenceLine, getY2TickLabel, getY2Title, getY2ZeroLine, getY3DMarkerGrid, getYPanelGrid, getZPanelGrid, getZTickLabel, getZTitle, isDataRowShownAsASeries, isFitToContainer, isFontSizeAbsolute, isFrameSizeAutomatic, isGraphicAntialiasing, isGroupSeriesTooltipSupported, isHorizontal, isLineDataLineDisplayed, isMarkerDisplayed, isMarkerShapeInLegend, isMouseMovingEnabled, isO1AxisSupported, isParetoBarsConnected, isScatterDataLineDisplayed, isSwapAllowed, isTextAntialiasing, readXML, readXML, removeAlertListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, resetToDefault, selectObject, setAutoLayout, setAutomaticComponentPlacement, setColorMode, setCustomToolTipCallback, setDataDirectorType, setDataErrorFont, setDataErrorTextCallback, setDataRowShownAsASeries, setDataSource, setDefaultImageSize, setDepthAngle, setDepthRadius, setDisplayGroups, setDisplayGroupsLimit, setDisplaySeries, setDisplaySeriesLimit, setDrillDimension, setFitToContainer, setFontName, setFontSizeAbsolute, setFrameSizeAutomatic, setGraphicAntialiasing, setGraphType, setGraphTypeConverter, setGroupTooltipLabelType, setImageSize, setLegendScrollbarPresence, setLegendSeriesCount, setLegendSeriesStart, setLineDataLineDisplayed, setLocale, setMarkerDisplayed, setMarkerShapeInLegend, setMarkerTooltipType, setMaxBarWidth, setMaxTickLabelAutoFontSize, setMinTickLabelAutoFontSize, setMouseMovingEnabled, setParetoBarsConnected, setPieBarSeries, setPieDepth, setPieRotation, setPieTilt, setScaleFontSizeForGIF, setScatterDataLineDisplayed, setScrollbarPresenceGroups, setScrollbarPresenceSeries, setSeriesObjectCount, setSeriesTooltipLabelType, setStartColumn, setStartGroup, setStartRow, setStartSeries, setSwapAllowed, setTabularData, setTextAntialiasing, setTimeZone, setToolTipDelay, setVersion, setXML, setXML, setXMLAsString, writeImagemapXML, writeImagemapXML

Methods inherited from class oracle.dss.dataView.Dataview

addControllerListener, addDataListener, addErrorHandler, addPropertyChangeListener, addViewFocusListener, addViewKeyListener, addViewListener, addViewMouseListener, addViewMouseMotionListener, getController, getDataDirector, getDataSource, getDataviewFootnote, getDataviewSubtitle, getDataviewTitle, getDescription, getHTMLPagingControlWidth, getInsertCallBack, getLocale, getLocalName, getModel, getName, getPagingControl, getPagingControlPosition, getPersistableAttributes, getPersistableComponents, getPhysicalComponents, getPopupManager, getRolloverTextManager, getTokenSubstitution, getXML, getXMLAsString, isDrillingEnabled, isHTMLPagingControlAutosubmit, isPagingControlVisible, isXMLValidated, removeControllerListener, removeDataListener, removeErrorHandler, removePropertyChangeListener, removeViewFocusListener, removeViewKeyListener, removeViewListener, removeViewMouseListener, removeViewMouseMotionListener, setDescription, setDrillingEnabled, setEnabled, setHTMLPagingControlAutosubmit, setHTMLPagingControlWidth, setInsertCallBack, setLocalName, setName, setPagingControlPosition, setPagingControlVisible, setPersistableAttributes, setPopupManager, setRolloverTextManager, setTokenSubstitution, setXMLValidated, writeXML

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUIClassID, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAutoscrolls, getBorder, getBounds, getClientProperty, getConditionForKeyStroke, getDebugGraphicsOptions, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getVerifyInputWhenFocusTarget, getVisibleRect, getWidth, getX, getY, grabFocus, hasFocus, hide, isDoubleBuffered, isFocusCycleRoot, isFocusTraversable, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintImmediately, paintImmediately, print, printAll, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDoubleBuffered, setFont, setForeground, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getLayout, insets, invalidate, isAncestorOf, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, remove, remove, removeAll, removeContainerListener, setLayout, validate

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, bounds, checkImage, checkImage, contains, createImage, createImage, dispatchEvent, enable, enableInputMethods, getBackground, getBounds, getColorModel, getComponentOrientation, getCursor, getDropTarget, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getInputContext, getInputMethodRequests, getLocation, getLocationOnScreen, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, imageUpdate, inside, isDisplayable, isEnabled, isLightweight, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setLocation, setLocation, setSize, setSize, show, show, size, toString, transferFocus

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface oracle.dss.thin.beans.dataView.ThinDataviewCommon

addDataListener, cleanUp, getDataviewFootnote, getDataviewSubtitle, getDataviewTitle, getLocale, getPagingControlPosition, getTokenSubstitution, getViewType, isEnabled, isPagingControlVisible, removeDataListener, setEnabled, setLocale, setPagingControlPosition, setPagingControlVisible, setTokenSubstitution, writeXML

Methods inherited from interface oracle.dss.dataView.DataviewCommon

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

Methods inherited from interface oracle.dss.rules.ComponentTypeConverter

convertComponentTypeToInteger, convertComponentTypeToString

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

getPersistableAttributes, getPersistableComponents, initialize, setPersistableAttributes, setPersistableComponents

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

getXMLAsString, setXMLAsString

Methods inherited from interface oracle.dss.util.ErrorHandlerCallback

addErrorHandler, removeErrorHandler

Methods inherited from interface oracle.dss.graph.UIGraph

getUIX1ReferenceLine, getUIY1ReferenceLine, getUIY2ReferenceLine, isPagingControlVisible, setPagingControlVisible

Methods inherited from interface oracle.dss.dataView.UIDataview

addControllerListener, getDataviewFootnote, getDataviewSubtitle, getDataviewTitle, getLocale, getTokenSubstitution, removeControllerListener, setTokenSubstitution

Methods inherited from interface oracle.dss.dataView.GraphAttribute

applyViewStyle, getComponentViewStyle, getUISeriesColor

Field Detail

SERIES_UNDEFINED

public static final int SERIES_UNDEFINED

Constant for undefined Series

See Also:

setImagemapAction(int, int, int, java.lang.String)

GROUP_UNDEFINED

public static final int GROUP_UNDEFINED

Constant for undefined Group

See Also:

setImagemapAction(int, int, int, java.lang.String)

Constructor Detail

ThinGraph

public ThinGraph()

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

ThinGraph

public ThinGraph(DataSource dataSource)

Constructor that specifies a DataSource.

Parameters:

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

ThinGraph

public ThinGraph(DataSource dataSource,
                 int type)

Constructor that specifies a DataSource and the type of DataDirector that this Graph will use.

Parameters:

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

type - A constant that represents the type of data director that dataSource implements. Constants begin with DDT_.

Method Detail

resetToDefault

public void resetToDefault(int reset)

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

When reset is RESET_EVERYTHING, then this method removes any imagemap actions and any event targets as well.

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

Specified by:

resetToDefault in interface ThinDataviewCommon

Overrides:

resetToDefault in class Graph

Parameters:

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

See Also:

Dataview.RESET_XML_PROPERTIES, Dataview.RESET_EVERYTHING

setThinBeanName

public void setThinBeanName(java.lang.String thinBeanName)

Description copied from interface: ThinBean

Specifies a unique name for this thin bean. You may have multiple instances of a thin bean in an application. Thin-bean events use the ThinBeanName as the value of the source query parameter, to identify the thin bean that should handle the event.

Specified by:

setThinBeanName in interface ThinBean

Following copied from interface: oracle.dss.thin.beans.ThinBean

Parameters:

thinBeanName - A unique name for this thin bean.

See Also:

BIConstants.SOURCE

getThinBeanName

public java.lang.String getThinBeanName()

Description copied from interface: ThinBean

Retrieves the unique name of this thin bean. The ThinBeanName uniquely identifies a thin bean in an application. Thin-bean events use the ThinBeanName as the value of the source query parameter, to identify the thin bean that should handle the event.

Specified by:

getThinBeanName in interface ThinBean

Following copied from interface: oracle.dss.thin.beans.ThinBean

Returns:

The name of this thin bean.

See Also:

BIConstants.SOURCE

setBaseState

public void setBaseState()

Description copied from interface: ThinBean

Establishes a base state for the ThinBean, from which state changes are tracked. This method clears the current state string for the thin bean.

Whenever you instantiate a thin bean, call this method. If you perform standard initialization every time you load a thin bean, then call this method after the standard initialization code. If you do custom initialization on some, but not all, thin beans, then call this method before the custom initialization code. Any changes that you make to a thin bean state after you call this method are added to the state string that the getState method returns.

Specified by:

setBaseState in interface ThinBean

setState

public void setState(java.lang.String state)

Description copied from interface: ThinBean

Sets the state of this ThinBean. This method takes the state information from a state string and sets it on this thin bean. The state string represents changes that have been made to this thin bean since the last call to the setBaseState method.

Where you get the state string depends on whether you store state information directly in the URL or in an oracle.cabo.servlet.state.State object. If you store state in the URL, then the state string comes from the URL. If you store state in a State object and store the ID of that object in the URL, then the state comes from the State object. In either case, the stored information originally should have come from a call to the getState method of this thin bean.

Setting the state of a thin bean lets you recreate a previously displayed page.

Call this method before you handle any thin-bean events. Thin-bean events often change the state of thin beans, so calling this method after you handle events causes the effects of the event handling to be overwritten.

Specified by:

setState in interface ThinBean

Following copied from interface: oracle.dss.thin.beans.ThinBean

Parameters:

state - The string that represents the state of this thin bean.

See Also:

ThinBean.getState()

getState

public java.lang.String getState()

Description copied from interface: ThinBean

Retrieves the state of this thin bean. The String that this method returns represents changes that have been made to this thin bean since the last call to its setBaseState method. Call this method after you handle any thin-bean events to get the current state of this thin bean.

You can store this state information directly in the URL, or you can store the state string in an oracle.cabo.servlet.state.State, and store the ID of the State in the URL.

The state information accrues as a user interacts with a thin bean, so the String that this method returns grows larger with each request that involves this thin bean. For example, the state of a Query might include information about the measures and selections in the query. If a user drills, then the drill information is added to the state string. If a user changes the layout of the query, then the new layout information is added as well. Each modification to the thin bean adds to the state string. If you store the state of all of the thin beans in your application in the URL, then you must be careful to avoid exceeding the URL limit for any browser that your application supports.

Call this method after you handle any thin-bean events.

Specified by:

getState in interface ThinBean

Following copied from interface: oracle.dss.thin.beans.ThinBean

Returns:

The state changes for this thin bean since the last call to setBaseState. Unless you use checkpointing, the returned state string represents the current state of this thin bean.

See Also:

ThinBean.setState(java.lang.String), ThinBean.setBaseState(), CheckpointState

getCheckpointState

public java.lang.String getCheckpointState()

Description copied from interface: CheckpointState

Retrieves state differences since the last call to checkpointState.

You normally store the returned String in the URL. The return value from this method, together with the return value from the getState method, describe all of the state changes that have been made to this thin bean since it was initialized (since the last call to setBaseState).

Specified by:

getCheckpointState in interface CheckpointState

Following copied from interface: oracle.dss.thin.beans.CheckpointState

Returns:

Changes that have been made to the state of this thin bean since checkpointState was last called.

See Also:

CheckpointState.checkpointState(), ThinBean.getState(), ThinBean.setBaseState()

setCheckpointState

public void setCheckpointState(java.lang.String state)

Description copied from interface: CheckpointState

Sets on this thin bean the state changes since the last call to checkpointState.

Specified by:

setCheckpointState in interface CheckpointState

Following copied from interface: oracle.dss.thin.beans.CheckpointState

Parameters:

state - The state differences from the last call to checkpointState.

Throws:

ThinException - If the state could not be set.

See Also:

ThinBean.setState(java.lang.String)

checkpointState

public void checkpointState()

Description copied from interface: CheckpointState

Initiates tracking of checkpoint state. Before you call this method, call the getState method of the thin bean. Save the state string that getState returns in an oracle.cabo.servlet.state.MutableState object. Save the MutableState to the BI Beans Catalog, by calling the saveState method of the BIStateManager. Then, call this method to keep track of changes that occur after you save the state string in the Catalog.

Specified by:

checkpointState in interface CheckpointState

Following copied from interface: oracle.dss.thin.beans.CheckpointState

See Also:

ThinBean.getState(), BIStateManager

setEventTarget

public void setEventTarget(java.lang.String event,
EventTarget target)

Description copied from interface: ThinBeanUI

Specifies an event target for an event that this ThinBeanUI generates. Call this method to specify the ThinBeanUI that should handle the event. You can also use event targets to direct an event to another part of your application, to change the target frame for an event, and to add application parameters to an event.

Specified by:

setEventTarget in interface ThinBeanUI

Following copied from interface: oracle.dss.thin.beans.ThinBeanUI

Parameters:

event - A constant that identifies the event to target. Valid constants are defined in the BIConstants interface and end with "_EVENT".

target - The event target that specifies the thin bean that should handle the event.

See Also:

BIConstants

getEventTarget

public EventTarget getEventTarget(java.lang.String event)

Description copied from interface: ThinBeanUI

Retrieves the event target for the specified event.

Specified by:

getEventTarget in interface ThinBeanUI

Following copied from interface: oracle.dss.thin.beans.ThinBeanUI

Parameters:

event - A constant that identifies the event whose target you want. Valid constants are defined in the BIConstants interface and end with "_EVENT".

Returns:

The event target that has been set for event.

See Also:

BIConstants

setExportCharacterEncoding

public void setExportCharacterEncoding(java.lang.String encoding)

Description copied from interface: ThinDataviewCommon

Specifies the character encoding to use when exporting the view. For a list of standard character sets, see http://www.iana.org/assignments/character-sets.

Specified by:

setExportCharacterEncoding in interface ThinDataviewCommon

Following copied from interface: oracle.dss.thin.beans.dataView.ThinDataviewCommon

Parameters:

encoding - The character encoding for export.

getExportCharacterEncoding

public java.lang.String getExportCharacterEncoding()

Description copied from interface: ThinDataviewCommon

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

Specified by:

getExportCharacterEncoding in interface ThinDataviewCommon

Following copied from interface: oracle.dss.thin.beans.dataView.ThinDataviewCommon

Returns:

The character encoding for export.

setExternalTitleVisible

public void setExternalTitleVisible(boolean b)

Description copied from interface: ThinDataviewCommon

Specifies whether a title for this ThinDataviewCommon appears outside the view. For example, if you display a title for this view in a UIX HeaderBean, then set this property to true. If you want the title to appear with exported data, then you should get the internal title and set its text, as well.

If this property is true, then the internal title component for the view does not appear. This property is set to false by default.

Specified by:

setExternalTitleVisible in interface ThinDataviewCommon

Following copied from interface: oracle.dss.thin.beans.dataView.ThinDataviewCommon

Parameters:

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

See Also:

ThinDataviewCommon.getDataviewTitle()

isExternalTitleVisible

public boolean isExternalTitleVisible()

Description copied from interface: ThinDataviewCommon

Indicates whether a title appears outside the view.

If this property is true, then the internal title component for the view does not appear. This property is set to false by default.

Specified by:

isExternalTitleVisible in interface ThinDataviewCommon

Following copied from interface: oracle.dss.thin.beans.dataView.ThinDataviewCommon

Returns:

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

setExternalSubtitleVisible

public void setExternalSubtitleVisible(boolean b)

Description copied from interface: ThinDataviewCommon

Specifies whether a subtitle for this ThinDataviewCommon appears outside the view. If you want the subtitle to appear with exported data, then you should get the internal subtitle and set its text, as well.

If this property is true, then the internal subtitle component for the view does not appear. This property is set to false by default.

Specified by:

setExternalSubtitleVisible in interface ThinDataviewCommon

Following copied from interface: oracle.dss.thin.beans.dataView.ThinDataviewCommon

Parameters:

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

See Also:

ThinDataviewCommon.getDataviewSubtitle()

isExternalSubtitleVisible

public boolean isExternalSubtitleVisible()

Description copied from interface: ThinDataviewCommon

Indicates whether a subtitle appears outside the view.

If this property is true, then the internal subtitle component for the view does not appear. This property is set to false by default.

Specified by:

isExternalSubtitleVisible in interface ThinDataviewCommon

Following copied from interface: oracle.dss.thin.beans.dataView.ThinDataviewCommon

Returns:

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

setExternalFootnoteVisible

public void setExternalFootnoteVisible(boolean b)

Description copied from interface: ThinDataviewCommon

Specifies whether a footnote for this ThinDataviewCommon appears outside the view. If you want the footnote to appear with exported data, then you should get the internal footnote and set its text, as well.

If this property is true, then the internal footnote component for the view does not appear. This property is set to false by default.

Specified by:

setExternalFootnoteVisible in interface ThinDataviewCommon

Following copied from interface: oracle.dss.thin.beans.dataView.ThinDataviewCommon

Parameters:

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

See Also:

ThinDataviewCommon.getDataviewFootnote()

isExternalFootnoteVisible

public boolean isExternalFootnoteVisible()

Description copied from interface: ThinDataviewCommon

Indicates whether a footnote appears outside the view.

If this property is true, then the internal footnote component for the view does not appear. This property is set to false by default.

Specified by:

isExternalFootnoteVisible in interface ThinDataviewCommon

Following copied from interface: oracle.dss.thin.beans.dataView.ThinDataviewCommon

Returns:

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

setInlineMessageType

public void setInlineMessageType(int type)

Description copied from interface: ThinDataviewCommon

Specifies the type of temporary inline message to display. The InlineMessage property determines the text of the message.

Note: The ThinDataviewCommon calls this method when it displays messages. Application developers can use it to display custom messages as well.

Specified by:

setInlineMessageType in interface ThinDataviewCommon

Following copied from interface: oracle.dss.thin.beans.dataView.ThinDataviewCommon

Parameters:

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

See Also:

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

getInlineMessageType

public int getInlineMessageType()

Description copied from interface: ThinDataviewCommon

Retrieves the type of inline message to display. The InlineMessage property determines the text of the message. The inline message conveys errors, warnings, or informational messages that are related to actions on the view.

Note: The ThinDataviewCommon calls this method when it displays messages. Application developers can also use it in displaying custom messages.

Specified by:

getInlineMessageType in interface ThinDataviewCommon

Following copied from interface: oracle.dss.thin.beans.dataView.ThinDataviewCommon

Returns:

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

See Also:

ThinDataviewCommon.INLINE_ERROR_MSG, ThinDataviewCommon.INLINE_WARNING_MSG, ThinDataviewCommon.INLINE_INFO_MSG, ThinDataviewCommon.getInlineMessage()

setInlineMessage

public void setInlineMessage(java.lang.String msg)

Description copied from interface: ThinDataviewCommon

Specifies the inline message text to display. If the message is null, then no message is displayed. The message is reset to null after the message is displayed once or when the view's data source is updated. The InlineMessageType property controls the type of message.

Note: The ThinDataviewCommon calls this method when it displays messages. Application developers can also use it to display custom messages.

Specified by:

setInlineMessage in interface ThinDataviewCommon

Following copied from interface: oracle.dss.thin.beans.dataView.ThinDataviewCommon

Parameters:

msg - The message to display.

See Also:

ThinDataviewCommon.setInlineMessageType(int)

getInlineMessage

public java.lang.String getInlineMessage()

Description copied from interface: ThinDataviewCommon

Retrieves the inline message text to display. If the message is null, then the ThinDataviewCommon displays no message. The message is reset to null after the message is displayed once and whenever the view's data source is updated. The InlineMessageType property controls the type of message that is displayed.

Note: The ThinDataviewCommon calls this method when it displays messages. Application developers can also use it in displaying custom messages.

Specified by:

getInlineMessage in interface ThinDataviewCommon

Following copied from interface: oracle.dss.thin.beans.dataView.ThinDataviewCommon

Returns:

The message to display.

See Also:

ThinDataviewCommon.setInlineMessageType(int)

handleEvent

public int handleEvent(QueryParameterProvider provider)
                throws ThinException

Description copied from interface: ThinBeanUI

Handles a thin-bean event. This ThinBeanUI handles events where the value of the source query parameter is the ThinBeanName for this thin bean.

You can examine the source query parameter to determine the thin bean whose handleEvent to call. Or you can call the handleEvent for each thin bean, checking the return from this method to discover which thin bean handled the event. Alternately, you can register thin beans with the ServletRequestHandler and call the handleEvent method of the ServletRequestHandler. The ServletRequestHandler will then route the event to the proper thin bean.

For more information about thin-bean events, see the BI Beans Help system.

Specified by:

handleEvent in interface ThinBeanUI

Following copied from interface: oracle.dss.thin.beans.ThinBeanUI

Parameters:

provider - The QueryParameterProvider for the HTTPServletRequest that is being handled.

Returns:

A constant that indicates whether this ThinBeanUI handled any events. Constants are listed in the See Also section.

Throws:

ThinException - If an error occurs that interrupts event handling.

See Also:

ThinBeanUI.EVENT_NOT_HANDLED, ThinBeanUI.EVENT_HANDLED, ThinBeanUI.EVENT_RESPONSE_DONE, ServletRequestHandler

addThinViewListener

public void addThinViewListener(ThinViewListener l)

Description copied from interface: ThinDataviewCommon

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

Specified by:

addThinViewListener in interface ThinDataviewCommon

Following copied from interface: oracle.dss.thin.beans.dataView.ThinDataviewCommon

Parameters:

l - The listener to add.

See Also:

ThinViewListenerAdapter

removeThinViewListener

public void removeThinViewListener(ThinViewListener l)

Description copied from interface: ThinDataviewCommon

Removes a listener for ThinDataviewCommon events.

Specified by:

removeThinViewListener in interface ThinDataviewCommon

Following copied from interface: oracle.dss.thin.beans.dataView.ThinDataviewCommon

Parameters:

l - The listener to remove.

setImagemapAction

public void setImagemapAction(int componentID,
                              int series,
                              int group,
                              java.lang.String href)

Assignes an HREF action to an image map component or a group of components To assign an action by series and/or group ID only, use ThinGraph.UNDEFINED for componentID. For components that don't have association with series and/or group, use ThinGraph.SERIES_UNDEFINED and/or ThinGraph.GROUP_UNDEFINED

Parameters:

componentID - Component ID sopecifying the type of component

series - Series ID

group - Group ID

href - A string that is going to be used for an "href" attribute

setImagemapAction

public void setImagemapAction(int componentID,
                              int series,
                              int group,
ImagemapAction action)

Assignes actions to a an image map component or a group of components To assign actions by series and/or group ID only, use ThinGraph.UNDEFINED for componentID. For components that don't have association with series and/or group, use ThinGraph.SERIES_UNDEFINED and/or ThinGraph.GROUP_UNDEFINED

Parameters:

componentID - Component ID sopecifying the type of component

series - Series ID

group - Group ID

action - Image map actions

See Also:

ImagemapAction

getImagemapAction

public ImagemapAction getImagemapAction(int componentID,
                                        int series,
                                        int group)

Retrieves actions assigned to a an image map component or a group of components

Parameters:

componentID - Component ID sopecifying the type of component

series - Series ID

group - Group ID

Returns:

Image map actions

See Also:

ImagemapAction

hasImagemapActions

public boolean hasImagemapActions()

Deternines whether ThinGraph has any image map actions assigned

Returns:

Boolean falg

getGraphTypeConverter

public GraphTypeConverter getGraphTypeConverter()

Overriden to always provide an instance of default GraphTypeConverter for ThinGraph

Overrides:

getGraphTypeConverter in class Graph

See Also:

Graph.getGraphTypeConverter()

applyXSS

public void applyXSS(oracle.cabo.style.StyleContext context,
                     oracle.cabo.style.StyleMap map)

Applies font and antialiasing settings from a Cabo XSS sheet to a graph instance. Properties will be affected only if their default values were never altered before this method was called.

Parameters:

context - UIX StyleContext

See Also:

oracle.dss.thin.beans.graph.ThinGraph#restorePreXSSDefaults