oracle.dss.graph
Class DataFilterImpl

java.lang.Object
  oracle.dss.graph.DataFilterImpl

All Implemented Interfaces:

DataFilter

Direct Known Subclasses:

DataCallback

public abstract class DataFilterImpl
extends java.lang.Object
implements DataFilter

For internal use only. Application developers should not use this

Implementation of DataFilter

Field Summary

static int	BUBBLE_LABELS_TYPE
static int	BUBBLE_TYPE
protected int	d_totalMeasures
static int	FUNNEL_TYPE
protected static int	GROUP_SIZE_FIVE
protected static int	GROUP_SIZE_FOUR
protected static int	GROUP_SIZE_THREE
protected static int	GROUP_SIZE_TWO
static int	HL_TYPE
static int	HLC_TYPE
static int	HLCV_TYPE
static int	HLV_TYPE
protected int[]	m_currentArray
protected int	m_currentGroupSize
protected int	m_dataModelType
protected int[]	m_filteredParetoIndex
protected boolean	m_filterOn
protected int	m_graphCategory
protected int	m_graphType
protected boolean	m_isDirtyFlag
protected static java.lang.String	m_lessTotalMeasures
protected int[][]	m_measuresArrays
protected static java.lang.String	m_method_setMeasures2
protected static java.lang.String	m_method_setMeasures3
protected static java.lang.String	m_nonFilterArray
protected boolean	m_oneGrpLabel
protected int[]	m_paretoIndex
protected boolean	m_seriesAreRows
protected boolean	m_sortingOn
protected int	m_totalMeasures
protected static java.lang.String	m_unequalLength
static int	NON_FILTER_TYPE
static int	OC_TYPE
static int	OCV_TYPE
static int	OHLC_TYPE
static int	OHLCV_TYPE
static int	SCATTER_LABELS_TYPE
static int	SCATTER_TYPE
static int	TOTAL_CATEGORIES

Constructor Summary

DataFilterImpl()

Method Summary

int	getColumns() Retrieves the total number of columns in the data.
protected abstract DataAccess	getDataAccess()
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.
protected abstract ErrorHandler	getErrorHandler()
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.
static int	getGraphCategory(int graphType)
protected int	getGroupSize(int graphCategory)
int[][]	getMArray()
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	getRows() Retrieves the total number of rows in the data.
int	getTotalMeasures() Returns the total number of measures in the DataSource that was set using setMeasures() method.
abstract java.lang.Object	getValue(int row, int col)
boolean	isDirty() Indicates whether the graph needs to be repainted.
protected boolean	isExcelOrDeskTop()
protected abstract void	needRec()
void	refresh() The application can call this method to refresh the arrays of measure indexes that are previously set.
protected void	setDataModelType(int model)
void	setDataRowShownAsASeries(boolean seriesAreRows) Deprecated. @deprecated There is no replacement method for this. Application developers are responsible to create the relevant data set.
void	setDirty(boolean isDirty) Specifies whether the graph needs to be repainted.
void	setGraphType(int graphType)
void	setMArray(int[][] array)
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.
void	setMeasuresForCategory(int graphCategory, int[] measures, int totalMeasures)
void	setTotalMeasures(int total)
void	sortIfDirty() Sorts Pareto data if dirty

Methods inherited from class java.lang.Object

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

Field Detail

m_graphType

protected int m_graphType

m_dataModelType

protected int m_dataModelType

m_seriesAreRows

protected boolean m_seriesAreRows

m_isDirtyFlag

protected boolean m_isDirtyFlag

m_filterOn

protected boolean m_filterOn

m_sortingOn

protected boolean m_sortingOn

m_oneGrpLabel

protected boolean m_oneGrpLabel

m_measuresArrays

protected int[][] m_measuresArrays

m_totalMeasures

protected int m_totalMeasures

m_currentArray

protected int[] m_currentArray

m_paretoIndex

protected int[] m_paretoIndex

m_filteredParetoIndex

protected int[] m_filteredParetoIndex

m_graphCategory

protected int m_graphCategory

m_currentGroupSize

protected int m_currentGroupSize

NON_FILTER_TYPE

public static final int NON_FILTER_TYPE

See Also:

Constant Field Values

SCATTER_TYPE

public static final int SCATTER_TYPE

See Also:

Constant Field Values

SCATTER_LABELS_TYPE

public static final int SCATTER_LABELS_TYPE

See Also:

Constant Field Values

BUBBLE_TYPE

public static final int BUBBLE_TYPE

See Also:

Constant Field Values

BUBBLE_LABELS_TYPE

public static final int BUBBLE_LABELS_TYPE

See Also:

Constant Field Values

OHLCV_TYPE

public static final int OHLCV_TYPE

See Also:

Constant Field Values

OHLC_TYPE

public static final int OHLC_TYPE

See Also:

Constant Field Values

HLV_TYPE

public static final int HLV_TYPE

See Also:

Constant Field Values

OCV_TYPE

public static final int OCV_TYPE

See Also:

Constant Field Values

OC_TYPE

public static final int OC_TYPE

See Also:

Constant Field Values

HL_TYPE

public static final int HL_TYPE

See Also:

Constant Field Values

HLC_TYPE

public static final int HLC_TYPE

See Also:

Constant Field Values

HLCV_TYPE

public static final int HLCV_TYPE

See Also:

Constant Field Values

FUNNEL_TYPE

public static final int FUNNEL_TYPE

See Also:

Constant Field Values

TOTAL_CATEGORIES

public static final int TOTAL_CATEGORIES

See Also:

Constant Field Values

GROUP_SIZE_TWO

protected static final int GROUP_SIZE_TWO

See Also:

Constant Field Values

GROUP_SIZE_THREE

protected static final int GROUP_SIZE_THREE

See Also:

Constant Field Values

GROUP_SIZE_FOUR

protected static final int GROUP_SIZE_FOUR

See Also:

Constant Field Values

GROUP_SIZE_FIVE

protected static final int GROUP_SIZE_FIVE

See Also:

Constant Field Values

d_totalMeasures

protected int d_totalMeasures

m_method_setMeasures2

protected static final java.lang.String m_method_setMeasures2

See Also:

Constant Field Values

m_method_setMeasures3

protected static final java.lang.String m_method_setMeasures3

See Also:

Constant Field Values

m_unequalLength

protected static final java.lang.String m_unequalLength

See Also:

Constant Field Values

m_nonFilterArray

protected static final java.lang.String m_nonFilterArray

See Also:

Constant Field Values

m_lessTotalMeasures

protected static final java.lang.String m_lessTotalMeasures

See Also:

Constant Field Values

Constructor Detail

DataFilterImpl

public DataFilterImpl()

Method Detail

setGraphType

public void setGraphType(int graphType)

For internal use only. Application developers should not use this

setDataRowShownAsASeries

@Deprecated
public void setDataRowShownAsASeries(boolean seriesAreRows)

Deprecated. @deprecated There is no replacement method for this. Application developers are responsible to create the relevant data set.

For internal use only. Application developers should not use this

For internal use only. Application developers should not use this

getMeasures

public int[] getMeasures()

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

Specified by:

getMeasures in interface DataFilter

Returns:

the array of measure indexes.

getMeasures

public int[] getMeasures(int graphType)

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

Specified by:

getMeasures in interface DataFilter

Parameters:

graphType - the GraphType for which the array is needed.

Returns:

the array of measure indexes.

setMeasures

public 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.

Specified by:

setMeasures in interface DataFilter

Parameters:

measures - the array of measure indexes

totalMeasures - the total number measures in the dataSource

setMeasures

public 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.

Specified by:

setMeasures in interface DataFilter

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

setMeasuresForCategory

public void setMeasuresForCategory(int graphCategory,
                                   int[] measures,
                                   int totalMeasures)

refresh

public 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.

Specified by:

refresh in interface DataFilter

getColumns

public int getColumns()

Retrieves the total number of columns in the data. A column corresponds to a series or to a group, depending on the value that the Graph.isDataRowShownAsASeries method returns.

Returns:

The number of columns in the data.

See Also:

Graph.isDataRowShownAsASeries(), DataAccess

getRows

public int getRows()

Retrieves the total number of rows in the data. A row corresponds to a series or to a group, depending on the value that the Graph.isDataRowShownAsASeries method returns.

Returns:

The number of rows in the data.

See Also:

Graph.isDataRowShownAsASeries(), DataAccess

isDirty

public boolean isDirty()

Indicates whether the graph needs to be repainted.

Returns:

true if the data needs to be repainted, false if the data has not changed since the graph was painted.

sortIfDirty

public void sortIfDirty()

Sorts Pareto data if dirty

setDirty

public void setDirty(boolean isDirty)

Specifies whether the graph needs to be repainted. Normally, when the graph is repainted, then this method is called, with false as the isDirty parameter. Then, when a change occurs, this method is called, with true as the isDirty parameter.

Parameters:

isDirty - true if the a change has occurred that requires the graph to be repainted, false if the graph has just been repainted.

getDataAccessColumn

public 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.

Specified by:

getDataAccessColumn in interface DataFilter

Parameters:

filteredColumn - the filtered column

Returns:

the dataAccess column corresponding to the filtered column

getDataAccessRow

public 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.

Specified by:

getDataAccessRow in interface DataFilter

Parameters:

filteredRow - the filtered row

Returns:

the dataAccess row corresponding to the filtered row

getFilteredColumn

public 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.

Specified by:

getFilteredColumn in interface DataFilter

Parameters:

dataAccessColumn - the column in the DataAccess

Returns:

the filtered column corresponding to the dataAccess column

getFilteredRow

public 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.

Specified by:

getFilteredRow in interface DataFilter

Parameters:

dataAccessRow - the row in the DataAccess

Returns:

the filtered row corresponding to the DataAccess row

getTotalMeasures

public int getTotalMeasures()

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

Specified by:

getTotalMeasures in interface DataFilter

Returns:

the total number of measures.

setTotalMeasures

public void setTotalMeasures(int total)

For internal use only. Application developers should not use this

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

getMArray

public int[][] getMArray()

For internal use only. Application developers should not use this

setMArray

public void setMArray(int[][] array)

For internal use only. Application developers should not use this

setDataModelType

protected void setDataModelType(int model)

getValue

public abstract java.lang.Object getValue(int row,
                                          int col)

For internal use only. Application developers should not use this

needRec

protected abstract void needRec()

getDataAccess

protected abstract DataAccess getDataAccess()

getErrorHandler

protected abstract ErrorHandler getErrorHandler()

getGroupSize

protected int getGroupSize(int graphCategory)

getGraphCategory

public static int getGraphCategory(int graphType)

For internal use only. Application developers should not use this

isExcelOrDeskTop

protected boolean isExcelOrDeskTop()