oracle.dss.graph
Interface UIGraph

All Superinterfaces:

GraphAttribute, PagingControlAttributes, UIDataview

All Known Implementing Classes:

Graph, UIGraphAdapter

public interface UIGraph

extends UIDataview, GraphAttribute

Interface for a graph. The user interface for the Graph bean calls the methods in this interface as it interacts with the graph. This interface is implemented internally and is used by the BI Beans user interface panels. Application developers should not implement this interface.

Method Summary

void	beginAxisChanges() Prevents calculation of axis values while the user interface panel sets axis scaling properties.
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.
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.
DataFilter	getDataFilter() Retrieves an implementation of the DataFilter interface.
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 an implementation of the UIParetoLine interface.
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.
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.
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	isPagingControlVisible() Indicate whether the paging control on the graph is visible.
void	setDataRowShownAsASeries(boolean yesNo) Specifies whether to display data rows as series or as groups.
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	setMarkerDisplayed(boolean yesNo) Specifies whether data markers appear in a line graph.
void	setMarkerTooltipType(int marketTooltipType) 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	setSeriesTooltipLabelType(int seriesTooltipLabelType) Specifies the type of information about series that this graph displays in tooltips.

Methods inherited from interface oracle.dss.dataView.UIDataview

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

Methods inherited from interface oracle.dss.dataView.GraphAttribute

applyViewStyle, getComponentViewStyle, getUISeriesColor

Method Detail

setDataRowShownAsASeries

public void setDataRowShownAsASeries(boolean yesNo)

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.

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.

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.

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.

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.

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.

Parameters:

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

See Also:

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

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.

Returns:

A constant that represents the current graph type.

See Also:

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

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.

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.

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.

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.

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 marketTooltipType)

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.

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.

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

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.

Parameters:

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

See Also:

GraphTypeConverter

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.

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:

GraphTypeConverter

getUIX1ReferenceLine

public getUIX1ReferenceLine()

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

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.

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.

Returns:

The implementation of the UIReferenceLine interface that represents the Y2ReferenceLine.

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.

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.

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.

Returns:

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

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 PagingControlAttributes

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 PagingControlAttributes

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.

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.

See Also:

ValueAxis

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 GraphAttribute

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.

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.

Returns:

The implementation of the DataFilter interface.

getParetoLine

public UIParetoLine getParetoLine()

Retrieves an implementation of the UIParetoLine interface.

isMarkerDisplayed

public boolean isMarkerDisplayed()

Indicates whether data markers appear in a line graph.

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.

Parameters:

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

See Also:

DataMarker

getAutoLayout

public int getAutoLayout()

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

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