oracle.dss.graph

Interface DataFilter

All Known Implementing Classes:

DataCallback, DataFilterImpl

public interface DataFilter

Interface for setting the measures to use in the Graph. Applications should not implement this interface.

Method Summary

Methods

Modifier and Type	Method and Description
int	getDataAccessColumn(int filteredColumn) Retrieves the dataAccess column if filtered column is given.
int	getDataAccessRow(int filteredRow) Retrieves the dataAccess row if filtered row is given.
int	getFilteredColumn(int dataAccessColumn) Retrieves the filtered column if dataAccess column is given.
int	getFilteredRow(int dataAccessRow) Retrieves the filtered row if dataAccess row is given.
int[]	getMeasures() Retrieves the array of measure indexes to use from the DataSource for the current Graph type.
int[]	getMeasures(int graphType) Retrieves the array of measure indexes to use from the DataSource for the specified Graph type.
int	getTotalMeasures() Returns the total number of measures in the DataSource that was set using setMeasures() method.
void	refresh() The application can call this method to refresh the arrays of measure indexes that are previously set.
void	setMeasures(int[] measures, int totalMeasures) Specifies the array of measure indexes to use from the DataSource and the total number of measures available in the DataSource for the current Graph type.
void	setMeasures(int graphType, int[] measures, int totalMeasures) Specifies the array of measure indexes to use from the DataSource for the given Graph type and the total number of measures in the DataSource.

Method Detail

getMeasures

int[] getMeasures()

Retrieves the array of measure indexes to use from the DataSource for the current Graph type.

Returns:

the array of measure indexes.

getMeasures

int[] getMeasures(int graphType)

Retrieves the array of measure indexes to use from the DataSource for the specified Graph type.

Parameters:

graphType - the GraphType for which the array is needed.

Returns:

the array of measure indexes.

getDataAccessColumn

int getDataAccessColumn(int filteredColumn)

Retrieves the dataAccess column if filtered column is given. For example if the DataAccess has 10 columns and only 4 columns are used by the Graph and column 0 of Graph corresponds to column 3 of DataAccess, then passing 0 to this method returns 3.

Parameters:

filteredColumn - the filtered column

Returns:

the dataAccess column corresponding to the filtered column

getDataAccessRow

int getDataAccessRow(int filteredRow)

Retrieves the dataAccess row if filtered row is given. For example if the DataAccess has 10 rows and only 4 rows are used by the Graph and row 0 of Graph corresponds to row 3 of DataAccess, then passing 0 to this method returns 3.

Parameters:

filteredRow - the filtered row

Returns:

the dataAccess row corresponding to the filtered row

getFilteredColumn

int getFilteredColumn(int dataAccessColumn)

Retrieves the filtered column if dataAccess column is given. For example if the DataAccess has 10 columns and only 4 columns are used by the Graph and column 0 of Graph corresponds to column 3 of DataAccess, then passing 3 to this method returns 0. If column 2 of DataAccess is not used by the Graph, then passing 2 to this method will return -1.

Parameters:

dataAccessColumn - the column in the DataAccess

Returns:

the filtered column corresponding to the dataAccess column

getFilteredRow

int getFilteredRow(int dataAccessRow)

Retrieves the filtered row if dataAccess row is given. For example if the DataAccess has 10 rows and only 4 rows are used by the Graph and row 0 of Graph corresponds to row 3 of DataAccess, then passing 3 to this method returns 0. If row 2 of DataAccess is not used by the Graph, then passing 2 to this method will return -1.

Parameters:

dataAccessRow - the row in the DataAccess

Returns:

the filtered row corresponding to the DataAccess row

setMeasures

void setMeasures(int[] measures,
               int totalMeasures)

Specifies the array of measure indexes to use from the DataSource and the total number of measures available in the DataSource for the current Graph type. For example the datasource has 5 measures and only two measures 4 and 2 should be used then the array should have 4,2. The array elements are 0 based. This method is typically called from the GraphLayout panel. The array of measure indexes are shared among similar graph types. The array specified for SCATTER graph is shared by SCATTER_2Y, POLAR and POLAR_2Y. The array for SCATTER_LABELS is shared by SCATTER_LABELS_2Y. The array for BUBBLE is shared by BUBBLE_2Y. The array for BUBBLE_LABELS is shared by BUBBLE_LABELS_2Y. The array for STOCK_OHLC_CANDLE_VOLUME is shared by STOCK_VOLUME. The array for STOCK_OHLC_CANDLE is shared by STOCK_OPEN_HILO_CLOSE, STOCK_2Y STOCK_SPLIT_2Y. The array for STOCK_HILO is shared by STOCK_HILO_2Y and STOCK_HILO_SPLIT2Y. The array for STOCK_HILO_CLOSE is shared by STOCK_HILO_CLOSE2Y and STOCK_HILO_CLOSE_SPLIT2Y.

Parameters:

measures - the array of measure indexes

totalMeasures - the total number measures in the dataSource

setMeasures

void setMeasures(int graphType,
               int[] measures,
               int totalMeasures)

Specifies the array of measure indexes to use from the DataSource for the given Graph type and the total number of measures in the DataSource. The application can call this method and set different array of measure indexes for certain Graph types. The only Graph types for which the arrays should be set are Bubble graphs, Scatter graphs, polar graphs and Stock Graphs. The array of measure indexes are shared among similar graph types. The array specified for SCATTER graph is shared by SCATTER_2Y, POLAR and POLAR_2Y. The array for SCATTER_LABELS is shared by SCATTER_LABELS_2Y. The array for BUBBLE is shared by BUBBLE_2Y. The array for BUBBLE_LABELS is shared by BUBBLE_LABELS_2Y. The array for STOCK_OHLC_CANDLE_VOLUME is shared by STOCK_VOLUME. The array for STOCK_OHLC_CANDLE is shared by STOCK_OPEN_HILO_CLOSE, STOCK_2Y STOCK_SPLIT_2Y. The array for STOCK_HILO is shared by STOCK_HILO_2Y and STOCK_HILO_SPLIT2Y. The array for STOCK_HILO_CLOSE is shared by STOCK_HILO_CLOSE2Y and STOCK_HILO_CLOSE_SPLIT2Y. For example the datasource has 5 measures and only two measures 4 and 2 should be used then the array should have 4,2. The array elements are 0 based.

Parameters:

graphType - the graph type for which the array of measure indexes should be used

measures - the array of measure indexes

totalMeasures - the total number measures in the dataSource

getTotalMeasures

int getTotalMeasures()

Returns the total number of measures in the DataSource that was set using setMeasures() method.

Returns:

the total number of measures.

refresh

void refresh()

The application can call this method to refresh the arrays of measure indexes that are previously set. The application can call this when DataSource is changed or when the DataRowShownAsASeries property is changed on Graph and different set arrays of measure indexes need to be used.