oracle.dss.graph.gui
Class UIGraphAdapter

java.lang.Object
  |
  +--oracle.dss.util.PagingControlAttributesAdapter
        |
        +--oracle.dss.dataView.UIDataviewAdapter
              |
              +--oracle.dss.graph.gui.UIGraphAdapter

All Implemented Interfaces:

ComponentTypeConverter, DataviewCommon, GraphAttribute, PagingControlAttributes, UIDataview, UIGraph

public class UIGraphAdapter

extends UIDataviewAdapter

implements UIGraph

UIGraph Adapter for a graph. Provides a proxy so that the user-interface panels can be displayed before a graph is constructed. To prevent memory leak, the application should call setDataSource(null) on this object when this object is no longer being used.

Field Summary

static int	NO_TIME_AXIS
static int	TIME_AXIS
static int	UNKNOWN

Constructor Summary

UIGraphAdapter()
Construct a graph adapter

UIGraphAdapter(Graph graph)
Construct a graph adapter

Method Summary

void	applyToGraph(Graph graph) Apply properties of this adapter to a graph.
void	applyViewStyle(ComponentHandle componentHandle, ViewStyle viewStyle) Applies a ViewStyle to a page item.
void	beginAxisChanges() Prevents calculation of axis values while the user interface panel sets axis scaling properties.
void	cleanUp() Frees memory used by this adapter.
void	endAxisChanges() Re-enables calculation of axis values after the user interface panel sets axis scaling properties.
int	getAutoLayout() Retrieves information about when the graph automatically places and sizes its components.
int	getColumnCount() Retrieves the number of columns of data that this graph displays.
ViewStyle	getComponentViewStyle(ComponentHandle componentHandle) Retrieves the ViewStyle for a selected component.
java.lang.Object	getDataAccessSliceLabel(int edge, int slice, java.lang.String type) Retrieves the label for the data slice in the DataAccess for this graph.
int	getDataDirectorType() Retrieves the the type of the current DataDirector, either a cube data director, for multidimensional data, or a relational data director, for relational data.
DataFilter	getDataFilter() Retrieves an implementation of the DataFilter interface.
DataSource	getDataSource() Retrieves the data source for this view.
int	getGraphType() Retrieves the current graph type for this graph.
GraphTypeConverter	getGraphTypeConverter() Retrieves the GraphTypeConverter that this graph uses.
int	getGroupTooltipLabelType() Retrieves the type of information about groups that this graph displays in tooltips.
int	getMarkerTooltipType() Indicates the type of information that this graph displays in tooltips for markers.
UIParetoLine	getParetoLine() Retrieves the pareto line color.
int	getRowCount() Retrieves the number of rows of data that this graph displays.
int	getSeriesObjectCount() Retrieves the number of series that this graph stores properties for.
int	getSeriesTooltipLabelType() Retrieves the type of information about series that this graph displays in tooltips.
int	getTimeAxisData() Retrives if the data provided to Graph is time axis data
interface	getUIX1ReferenceLine() Retrieves an implementation of the UIReferenceLine interface that represents the X1ReferenceLine component of a graph.
interface	getUIY1ReferenceLine() Retrieves an implementation of the UIReferenceLine interface that represents the Y1ReferenceLine component of a graph.
interface	getUIY2ReferenceLine() Retrieves an implementation of the UIReferenceLine interface that represents the Y2ReferenceLine component of a graph.
int	getViewType() Get the specific type of this view.
void	initFromGraph(Graph graph)
boolean	isDataRowShownAsASeries() Indicates whether rows of data appear as series or as groups.
boolean	isGroupSeriesTooltipSupported(int edge) Indicates whether group or series option (depending on the edge passed in) is supported in the tooltips.
boolean	isHorizontal() Indicates whether the graph has a horizontal graph type.
boolean	isLineDataLineDisplayed() Indicates whether data lines appear in a line graph.
boolean	isMarkerDisplayed() Indicates whether data markers appear in a line graph.
boolean	isO1AxisSupported() Indicates whether the current graph type has an ordinal axis.
boolean	isPagingControlVisible() Indicate whether the paging control on the graph is visible.
void	setDataDirectorType(int type) Specifies the the type of DataDirector, either a cube data director, for multidimensional data, or a relational data director, for relational data.
void	setDataRowShownAsASeries(boolean yesNo) Specifies whether to display data rows as series or as groups.
void	setDataSource(DataSource dataSource) Specifies the data source for this graph.
void	setGraphType(int graphType) Specifies the graph type for this graph.
void	setGraphTypeConverter(GraphTypeConverter graphTypeConverter) Specifies the GraphTypeConverter for the graph type to use.
void	setGroupTooltipLabelType(int groupTooltipLabelType) Specifies the type of information about groups that this graph displays in tooltips.
void	setLineDataLineDisplayed(boolean bValue) Specifies whether data lines appear in a line graph.
void	setLocale(java.util.Locale loc) Sets the Locale that this UIGraphAdapter uses.
void	setMarkerDisplayed(boolean yesNo) Specifies whether data markers appear in a line graph.
void	setMarkerTooltipType(int markerTooltipType) Specifies the type of information that this graph displays in tooltips for markers.
void	setPagingControlVisible(boolean bValue) Specifies whether to display the paging control with the graph.
void	setSeriesObjectCount(int count) Specifies the number of series that this graph stores properties for.
void	setSeriesTooltipLabelType(int seriesTooltipLabelType) Specifies the type of information about series that this graph displays in tooltips.
void	setTimeAxisData(int type) Specifies if the data provided to Graph is time axis data.
void	setTokenSubstitution(TokenSubstitution token) Specifies a handler for token substitution in this view.

Methods inherited from class oracle.dss.dataView.UIDataviewAdapter

addControllerListener, applyToDataview, convertComponentTypeToInteger, convertComponentTypeToString, getDataviewFootnote, getDataviewSubtitle, getDataviewTitle, getLocale, getModel, getSelectedObject, getTokenSubstitution, getZoomFactor, initFromDataview, removeControllerListener, selectObject

Methods inherited from class oracle.dss.util.PagingControlAttributesAdapter

applyToPagingControlAttributes, initFromPagingControlAttributes

Methods inherited from class java.lang.Object

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

Methods inherited from interface oracle.dss.dataView.UIDataview

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

Methods inherited from interface oracle.dss.dataView.GraphAttribute

getUISeriesColor

Methods inherited from interface oracle.dss.dataView.DataviewCommon

getErrorHandler, getHTMLPagingControlWidth, isHTMLPagingControlAutosubmit, setHTMLPagingControlAutosubmit, setHTMLPagingControlWidth

Field Detail

UNKNOWN

public static final int UNKNOWN

TIME_AXIS

public static final int TIME_AXIS

NO_TIME_AXIS

public static final int NO_TIME_AXIS

Constructor Detail

UIGraphAdapter

public UIGraphAdapter()

Construct a graph adapter

UIGraphAdapter

public UIGraphAdapter(Graph graph)

Construct a graph adapter

Method Detail

setLocale

public void setLocale(java.util.Locale loc)

Sets the Locale that this UIGraphAdapter uses.

Overrides:

setLocale in class UIDataviewAdapter

Parameters:

loc - The Locale for this UIGraphAdapter.

getDataSource

public DataSource getDataSource()

Retrieves the data source for this view.

Overrides:

getDataSource in class UIDataviewAdapter

Returns:

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

setDataSource

public void setDataSource(DataSource dataSource)

Specifies the data source for this graph. This method specifies the DataSource that will feed data to this graph. If you do not use the Graph(DataSource) method to create the graph, then you must call this method to specify the data that appears in the graph. To prevent memory leak, the application should call setDataSource(null) on this object after done using this object.

Overrides:

setDataSource in class UIDataviewAdapter

Parameters:

ds - The DataSource for this graph to use.

getDataDirectorType

public int getDataDirectorType()

Retrieves the the type of the current DataDirector, either a cube data director, for multidimensional data, or a relational data director, for relational data.

Returns:

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

See Also:

DataDirector

setDataDirectorType

public void setDataDirectorType(int type)

Specifies the the type of DataDirector, either a cube data director, for multidimensional data, or a relational data director, for relational data.

Parameters:

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

See Also:

DataDirector

applyToGraph

public void applyToGraph(Graph graph)

Apply properties of this adapter to a graph.

initFromGraph

public void initFromGraph(Graph graph)

setDataRowShownAsASeries

public void setDataRowShownAsASeries(boolean yesNo)

Description copied from interface: UIGraph

Specifies whether to display data rows as series or as groups. Perspective for Java (PFJ) arranges data in terms of series and groups. This method indicates the way that data from the DataSource is translated to PFJ. For example, in a pie graph, series labels appear in the graph legend, and group labels appear under each pie. When data rows are shown as PFJ series, the labels for the data rows appear in the graph legend. When data rows are not shown as PFJ series, but rather as PFJ groups, the row labels appear under each pie, and the column labels appear in the graph legend.

Specified by:

setDataRowShownAsASeries in interface UIGraph

Following copied from interface: oracle.dss.graph.UIGraph

Parameters:

yesNo - true to have data rows shown as PFJ series (and data columns shown as groups), false to have data rows shown as PFJ groups (and data columns shown as series).

isDataRowShownAsASeries

public boolean isDataRowShownAsASeries()

Indicates whether rows of data appear as series or as groups. Perspective for Java (PFJ) arranges data in terms of series and groups. This method indicates the way that data from the DataSource is translated to PFJ. For example, in a pie graph, series labels appear in the graph legend, and group labels appear under each pie. When data rows are shown as PFJ series, the labels for the data rows appear in the graph legend. When data rows are not shown as PFJ series, but rather as PFJ groups, the row labels appear under each pie, and the column labels appear in the graph legend.

Specified by:

isDataRowShownAsASeries in interface UIGraph

Returns:

true if data rows are shown as series, false if data rows are shown as groups.

getColumnCount

public int getColumnCount()
                   throws EdgeOutOfRangeException

Retrieves the number of columns of data that this graph displays.

Specified by:

getColumnCount in interface UIGraph

Returns:

The number of data columns that this graph displays.

Throws:

EdgeOutOfRangeException - If the data source does not support the the column edge.

See Also:

isDataRowShownAsASeries()

getRowCount

public int getRowCount()
                throws EdgeOutOfRangeException

Retrieves the number of rows of data that this graph displays.

Specified by:

getRowCount in interface UIGraph

Returns:

The number of data rows that this graph displays.

Throws:

EdgeOutOfRangeException - If the data source does not support the row edge.

See Also:

isDataRowShownAsASeries()

getDataAccessSliceLabel

public java.lang.Object getDataAccessSliceLabel(int edge,
                                                int slice,
                                                java.lang.String type)
                                         throws EdgeOutOfRangeException,
SliceOutOfRangeException

Retrieves the label for the data slice in the DataAccess for this graph. The UI calls this method to get information about the series when it displays the plot area panel.

Specified by:

getDataAccessSliceLabel in interface UIGraph

Parameters:

edge - The edge that you want labels for. Series.java calls this with DataAccess.ROW_EDGE.

slice - The slice of data that you want labels for.

type - The type of data that you want from the DataAccess. Series.java calls this method with MetadataMap.METADATA_LONGLABEL as the type.

Returns:

The label for the specified slice of data.

Throws:

EdgeOutOfRangeException - If edge is not a valid edge.

SliceOutOfRangeException - If slice is not a valid slice.

See Also:

DataAccess.getSliceLabel(int, int, java.lang.String)

setGraphType

public void setGraphType(int graphType)

Specifies the graph type for this graph. The constants are defined in the Graph class and begin with the following:

• Bar graphs: BAR_
• Line graphs: LINE_
• Area graphs: AREA_
• Pie graphs: PIE_
• Ring (doughnut) graphs: RING_
• Scatter graphs: SCATTER_
• Bubble graphs: BUBBLE_
• Stock market graphs: STOCK_
• Radar graphs: RADAR_
• Polar graphs: POLAR_
• 3-D graphs: THREED_

A point graph, as exposed in the default UI, is a line graph in which isLineDataLineDisplayed returns false. A combination graph is a bar graph in which getMarkerType for one or more series returns anything other than MT_DEFAULT.

Specified by:

setGraphType in interface UIGraph

Parameters:

graphType - A constant that represents the graph type for this graph.

See Also:

isLineDataLineDisplayed(), Series.getMarkerType(int), GraphTypeConverterAdapter

getGraphType

public int getGraphType()

Retrieves the current graph type for this graph. The constants begin with the following:

• Bar graphs: BAR_
• Line graphs: LINE_
• Area graphs: AREA_
• Pie graphs: PIE_
• Ring (doughnut) graphs: RING_
• Scatter graphs: SCATTER_
• Bubble graphs: BUBBLE_
• Stock market graphs: STOCK_
• Radar graphs: RADAR_
• Polar graphs: POLAR_
• 3-D graphs: THREED_

A point graph, as exposed in the default UI, is a line graph in which getLineDataLineDisplayed returns false. A combination graph is a bar graph in which getMarkerType for one or more series returns anything other than MT_DEFAULT.

Specified by:

getGraphType in interface UIGraph

Returns:

A constant that represents the current graph type.

See Also:

isLineDataLineDisplayed(), Series.getMarkerType(int), GraphTypeConverterAdapter

setSeriesTooltipLabelType

public void setSeriesTooltipLabelType(int seriesTooltipLabelType)

Specifies the type of information about series that this graph displays in tooltips. The information can be the dimension name, the dimension name and the dimension member, or neither. Constants are defined in the Graph class and start with TLT_. The default value for SeriesTooltipLabelType is Graph.TLT_MEMBER.

In order for the series labels to be displayed, the Graph.MarkerTooltipType property must be set to include text.

Specified by:

setSeriesTooltipLabelType in interface UIGraph

Parameters:

seriesTooltipLabelType - A constant that represents the type of information that the graph should display for series.

See Also:

Graph.TLT_MEMBER, Graph.TLT_DIM_MEMBER, Graph.TLT_NONE, Graph.setMarkerTooltipType(int)

getSeriesTooltipLabelType

public int getSeriesTooltipLabelType()

Retrieves the type of information about series that this graph displays in tooltips. The information can be the dimension name, the dimension name and the dimension member, or neither. Constants are defined in the Graph class and start with TLT_. The default value for SeriesTooltipLabelType is Graph.TLT_MEMBER.

In order for the series labels to be displayed, the MarkerTooltipType property must be set to include text.

Specified by:

getSeriesTooltipLabelType in interface UIGraph

Returns:

A constant that represents the type of information that the graph displays for series.

See Also:

Graph.TLT_MEMBER, Graph.TLT_DIM_MEMBER, Graph.TLT_NONE, Graph.setMarkerTooltipType(int)

setGroupTooltipLabelType

public void setGroupTooltipLabelType(int groupTooltipLabelType)

Specifies the type of information about groups that this graph displays in tooltips. The information can be the dimension name, the dimension name and the dimension member, or neither. Constants are defined in the Graph and start with TLT_. The default value for GroupTooltipLabelType is Graph.TLT_MEMBER.

Specified by:

setGroupTooltipLabelType in interface UIGraph

Parameters:

groupTooltipLabelType - A constant that represents the type of information that the graph should display for groups.

See Also:

Graph.TLT_MEMBER, Graph.TLT_DIM_MEMBER, Graph.TLT_NONE, Graph.setMarkerTooltipType(int)

getGroupTooltipLabelType

public int getGroupTooltipLabelType()

Retrieves the type of information about groups that this graph displays in tooltips. The information can be the dimension name, the dimension name and the dimension member, or neither. Constants are defined in the Graph class and start with TLT_. The default value for GroupTooltipLabelType is Graph.TLT_MEMBER.

Specified by:

getGroupTooltipLabelType in interface UIGraph

Returns:

A constant that represents the type of information that the graph displays for groups.

See Also:

Graph.TLT_MEMBER, Graph.TLT_DIM_MEMBER, Graph.TLT_NONE, Graph.setMarkerTooltipType(int)

setMarkerTooltipType

public void setMarkerTooltipType(int markerTooltipType)

Specifies the type of information that this graph displays in tooltips for markers. The information can be the value that the marker represents, the percent value (for pie graphs), the cumulative value (for stacked graphs), text that identifies the group or series, or a combination of information, such as the value, the group, and the series. Constants are defined in the Graph class and start with MTT_.

The default value for MarkerTooltipType is Graph.MTT_VALUES.

If you set MarkerTooltipType to include Graph.MTT_TEXT, then the content of the text is specified by the setSeriesTooltipLabelType and setGroupTooltipLabelType methods.

Specified by:

setMarkerTooltipType in interface UIGraph

Parameters:

marketTooltipType - A constant that represents the type of information that the graph should display for markers. Except for MTT_NONE, the constants can be combined by using a bitwise OR (|).

See Also:

setGroupTooltipLabelType(int), setSeriesTooltipLabelType(int), Graph.MTT_TEXT, Graph.MTT_VALUES, Graph.MTT_NONE, Graph.MTT_PERCENT_VAL, Graph.MTT_CUM_VAL

getMarkerTooltipType

public int getMarkerTooltipType()

Indicates the type of information that this graph displays in tooltips for markers. The information can be the value that the marker represents, the percent value (for pie graphs), the cumulative value (for stacked graphs), text that identifies the group or series, or a combination of information, such as the value, the group, and the series. Constants are defined in the Graph class and start with MTT_.

The default value for MarkerTooltipType is Graph.MTT_VALUES.

If MarkerTooltipType includes Graph.MTT_TEXT, then the content of the text is specified in the SeriesTooltipLabelType and GroupTooltipLabelType properties.

Specified by:

getMarkerTooltipType in interface UIGraph

Returns:

A constant that represents the type of information that the graph displays for markers. The constant can be a combination of constants that have been combined using a bitwise OR (|).

See Also:

getGroupTooltipLabelType(), getSeriesTooltipLabelType(), Graph.MTT_TEXT, Graph.MTT_VALUES, Graph.MTT_NONE, Graph.MTT_PERCENT_VAL, Graph.MTT_CUM_VAL

getAutoLayout

public int getAutoLayout()

Retrieves information about when the graph automatically places and sizes its components.

Specified by:

getAutoLayout in interface UIGraph

Returns:

A constant that represents when the graph automatically places and sizes its components. Constants are listed in the See Also section.

See Also:

Graph.AL_ALWAYS, Graph.AL_AS_NEEDED, Graph.AL_NEVER

setLineDataLineDisplayed

public void setLineDataLineDisplayed(boolean bValue)

Specifies whether data lines appear in a line graph. This method essentially specifies whether a line graph appears as a a line graph or as a point graph. Perspective For Java (PFJ) does not expose a separate point graph, but the default UI for the BI Beans manufactures a point graph by presenting a line graph and passing false to this method.

Specified by:

setLineDataLineDisplayed in interface UIGraph

Parameters:

bValue - true for a line graph, false to create a point graph.

See Also:

GraphTypeConverterAdapter

isLineDataLineDisplayed

public boolean isLineDataLineDisplayed()

Indicates whether data lines appear in a line graph. This method essentially discriminates between a line graph and a point graph. Perspective For Java (PFJ) does not expose a separate point graph, but the default UI for the BI Beans manufactures a point graph by presenting a line graph in which this method returns false.

Specified by:

isLineDataLineDisplayed in interface UIGraph

Returns:

true if a line graph displays lines, false if the line graph does not display lines (presents itself as a point graph).

See Also:

GraphTypeConverterAdapter

setTokenSubstitution

public void setTokenSubstitution(TokenSubstitution token)

Specifies a handler for token substitution in this view. Token substitution handlers make it possible for users to insert tokens (such as a token for the current dimension member) in the title, subtitle, and footnote of this view. Most application developers will use the default TokenSubstitution. You need to call this method only if you provide your own handler for allowing users to insert tokens.

Specified by:

setTokenSubstitution in interface UIDataview

Overrides:

setTokenSubstitution in class UIDataviewAdapter

Parameters:

token - The token substitution handler for this view.

getGraphTypeConverter

public GraphTypeConverter getGraphTypeConverter()

Retrieves the GraphTypeConverter that this graph uses. The GraphTypeConverter translates the base graph types for a user interface (UI). For example, the default UI for this graph exposes a point graph type. To Perspective for Java, this is really a line graph without the lines. The GraphTypeConverter maintains the information about the UI version of the graph and the Perspective for Java version.

Specified by:

getGraphTypeConverter in interface UIGraph

Returns:

The GraphTypeConverter that this graph uses.

setGraphTypeConverter

public void setGraphTypeConverter(GraphTypeConverter graphTypeConverter)

Specifies the GraphTypeConverter for the graph type to use. The GraphTypeConverter translates the base graph types for a user interface (UI). For example, the default UI for this graph exposes a point graph type. To Perspective for Java, this is really a line graph without the lines. The GraphTypeConverter maintains the information about the UI version of the graph and the Perspective for Java version.

The default UI for the graph sets a default GraphTypeConverter. You do not have to call this method unless you provide your own UI and your UI exposes graph types that do not correspond directly to the graph type constants in this class.

Specified by:

setGraphTypeConverter in interface UIGraph

Parameters:

graphTypeConverter - The GraphTypeConverter for this graph to use.

isHorizontal

public boolean isHorizontal()

Indicates whether the graph has a horizontal graph type. In a horizontal graph, the O1Axis and its tick labels are vertical. Otherwise, they are horizontal. The plot area panel in the default UI calls this method in order to translate "horizontal" and "vertical" for the end user.

Specified by:

isHorizontal in interface UIGraph

Returns:

true if the graph is horizontal, false if it is vertical.

isO1AxisSupported

public boolean isO1AxisSupported()

Indicates whether the current graph type has an ordinal axis. An ordinal axis is the axis that shows group titles rather than a scaled set of values. For example, a bar, line, point, or area graph has ordinal axes, normally across the bottom of the plot area. Scatter graphs and bubble graphs do not have an ordinal axis. Instead, the axis across the bottom of the plot area is an X1Axis, which shows a scale of data values. Also, graphs such as a pie graph or a ring graph do not have ordinal axes.

Returns:

true if the current graph type has an ordinal axis, false if not.

isPagingControlVisible

public boolean isPagingControlVisible()

Indicate whether the paging control on the graph is visible. The paging control allows users to change the logical page of data that the graph displays.

Specified by:

isPagingControlVisible in interface UIGraph

Overrides:

isPagingControlVisible in class PagingControlAttributesAdapter

Returns:

true if the paging control appears with the graph, false if it does not.

See Also:

PagingControl

setPagingControlVisible

public void setPagingControlVisible(boolean bValue)

Specifies whether to display the paging control with the graph. The paging control allows users to change the logical page of data that the graph displays.

Specified by:

setPagingControlVisible in interface UIGraph

Overrides:

setPagingControlVisible in class PagingControlAttributesAdapter

Parameters:

bValue - true to display the paging control, false to hide it.

See Also:

PagingControl

beginAxisChanges

public void beginAxisChanges()

Prevents calculation of axis values while the user interface panel sets axis scaling properties. The ValueAxis class calls this method before it applies the settings of axis scaling options.

Specified by:

beginAxisChanges in interface UIGraph

See Also:

ValueAxis

endAxisChanges

public void endAxisChanges()

Re-enables calculation of axis values after the user interface panel sets axis scaling properties. The ValueAxis class calls this method after it applies the settings of axis scaling options.

Specified by:

endAxisChanges in interface UIGraph

See Also:

ValueAxis

setSeriesObjectCount

public void setSeriesObjectCount(int count)

Specifies the number of series that this graph stores properties for. The graph stores properties, such as colors, for a number of series. Beyond that number, the graph repeats series properties. For example, if you pass 4 to this method, then:

• Series 5 has the same color as series 1
• Series 6 has the same color as series 2
• Series 7 has the same color as series 3
• and so on

Parameters:

count - The number of series that this graph should store properties for before it repeats properties. Valid values are 1 - Graph.SERIESOBJECTCOUNTLIMIT.

See Also:

Series

getSeriesObjectCount

public int getSeriesObjectCount()

Retrieves the number of series that this graph stores properties for. The graph stores properties, such as colors, for a number of series. Beyond that number, the graph repeats series properties. For example, if this method returns 4, then:

• Series 5 has the same color as series 1
• Series 6 has the same color as series 2
• Series 7 has the same color as series 3
• and so on

Specified by:

getSeriesObjectCount in interface UIGraph

Returns:

The number of series that this graph stores properties for before it repeats properties.

See Also:

Series

isGroupSeriesTooltipSupported

public boolean isGroupSeriesTooltipSupported(int edge)

Indicates whether group or series option (depending on the edge passed in) is supported in the tooltips. If it is, then the PlotArea panel enables the appropriate checkbox. If it is not, then the checkbox is disabled. This method works for the row edge and the column edge only.

Application developers should not need to call this method.

Specified by:

isGroupSeriesTooltipSupported in interface UIGraph

Parameters:

edge - DataDirector.ROW_EDGE for the row edge, or DataDirector.COLUMN_EDGE for the column edge.

Returns:

true If the the option is supported false If the option is not supported and the checkbox should be disabled.

See Also:

DataDirector.COLUMN_EDGE, DataDirector.ROW_EDGE

getDataFilter

public DataFilter getDataFilter()

Retrieves an implementation of the DataFilter interface.

Specified by:

getDataFilter in interface UIGraph

Returns:

The implementation of the DataFilter interface.

getComponentViewStyle

public ViewStyle getComponentViewStyle(ComponentHandle componentHandle)

Description copied from interface: GraphAttribute

Retrieves the ViewStyle for a selected component. The graph supports a ViewStyle for page items only.

Specified by:

getComponentViewStyle in interface GraphAttribute

Following copied from interface: oracle.dss.dataView.GraphAttribute

Parameters:

componentHandle - The ComponentHandle for the component whose ViewStyle you want. Implementers should screen for the PageItemComponentHandle.

Returns:

The ViewStyle for page items.

See Also:

PageItemComponentHandle

applyViewStyle

public void applyViewStyle(ComponentHandle componentHandle,
ViewStyle viewStyle)

Description copied from interface: GraphAttribute

Applies a ViewStyle to a page item.

Specified by:

applyViewStyle in interface GraphAttribute

Following copied from interface: oracle.dss.dataView.GraphAttribute

Parameters:

componentHandle - The ComponentHandle for the page item that you want to format.

viewStyle - The ViewStyle that specifies formatting for the page item.

getViewType

public int getViewType()

Get the specific type of this view. This method returns Dataview.VIEW_TYPE_GRAPH.

Specified by:

getViewType in interface UIDataview

Overrides:

getViewType in class UIDataviewAdapter

Returns:

the constant Dataview.VIEW_TYPE_GRAPH

See Also:

Dataview.VIEW_TYPE_GRAPH

getParetoLine

public UIParetoLine getParetoLine()

Retrieves the pareto line color.

Specified by:

getParetoLine in interface UIGraph

Returns:

pareto line color

getUIX1ReferenceLine

public getUIX1ReferenceLine()

Retrieves an implementation of the UIReferenceLine interface that represents the X1ReferenceLine component of a graph.

Specified by:

getUIX1ReferenceLine in interface UIGraph

Returns:

The implementation of the UIReferenceLine interface that represents the X1ReferenceLine.

getUIY1ReferenceLine

public getUIY1ReferenceLine()

Retrieves an implementation of the UIReferenceLine interface that represents the Y1ReferenceLine component of a graph.

Specified by:

getUIY1ReferenceLine in interface UIGraph

Returns:

The implementation of the UIReferenceLine interface that represents the Y1ReferenceLine.

getUIY2ReferenceLine

public getUIY2ReferenceLine()

Retrieves an implementation of the UIReferenceLine interface that represents the Y2ReferenceLine component of a graph.

Specified by:

getUIY2ReferenceLine in interface UIGraph

Returns:

The implementation of the UIReferenceLine interface that represents the Y2ReferenceLine.

isMarkerDisplayed

public boolean isMarkerDisplayed()

Indicates whether data markers appear in a line graph.

Specified by:

isMarkerDisplayed in interface UIGraph

Returns:

true if the line graph displays data markers, false if it does not.

See Also:

DataMarker

setMarkerDisplayed

public void setMarkerDisplayed(boolean yesNo)

Specifies whether data markers appear in a line graph.

Specified by:

setMarkerDisplayed in interface UIGraph

Parameters:

yesNo - true to display data markers, false to hide data markers.

See Also:

DataMarker

setTimeAxisData

public void setTimeAxisData(int type)

Specifies if the data provided to Graph is time axis data. (the group edge should have data type java.sql.Date for the layer 0, should have one layer in case of vertical Bar, Line Area graphs and two layers in case of stock graphs.) The valid values are UNKNOWN, TIME_AXIS and NO_TIME_AXIS. The default value is UNKNOWN. When initFromGraph() is called on this class, the value will be reset to UNKNOWN. The value will be used by GroupAxis panel to hide the skipping and rotation options in case of TimeAxis.

getTimeAxisData

public int getTimeAxisData()

Retrives if the data provided to Graph is time axis data

cleanUp

public void cleanUp()

Frees memory used by this adapter. Call this method when you no longer need this adapter.