quadbase.util
Interface IDrillDown

public interface IDrillDown

Field Summary

static int	AVG
static int	COUNT
static int	MAX
static int	MAX_OPS
static int	MIN
static int	SUM

Method Summary

void	addDrillDown(int cType, int categoryIndex, int seriesIndex, int sumbyIndex, boolean isDrill2D) Adds a new drill-down definition to the end of the drill down list.
int	countDrillDownLevel() Counts number of drill down levels If non drill-down chart return -1
int	getAggregateOperator() Returns the primary aggregate operator used for drill-down.
java.lang.String	getDrillName() Returns the base drill-name
void	insertDrillDownAt(int number, int cType, int categoryIndex, int seriesIndex, int sumbyIndex, boolean isDrill2D) Inserts a new drill-down definition to the chart
boolean	isDynamicDrillDown() This function is used to check if the dynamic drill down function is enabled or not
boolean	isPreSetDrillDown() This function is used to check if the pre-set drill down function is enabled or not
void	removeDrillDown(int number) Removes a drill-down from the chart.
void	resetDrillDown() Resets the chart and remove all the drill down levels
void	setAggregateOperator(int aggOp) Sets the primary aggregate operator to use when displaying summary charts.
void	setDrillName(java.lang.String drillBaseName) Sets the base name for defining drill-down charts.
void	setDynamicDrillDown(boolean b) Enables dynamic drill down function for chart viewer
void	setSecondaryAggregateOperator(int aggOp) Sets the secondary AggregateOperator to use when displaying summary charts.

Field Detail

MIN

public static final int MIN

MAX

public static final int MAX

AVG

public static final int AVG

SUM

public static final int SUM

COUNT

public static final int COUNT

MAX_OPS

public static final int MAX_OPS

Method Detail

setDrillName

public void setDrillName(java.lang.String drillBaseName)

Sets the base name for defining drill-down charts.

Parameters:

drillBaseName - The base drill name to use.

getDrillName

public java.lang.String getDrillName()

Returns the base drill-name

Returns:

The base drill-down name.

resetDrillDown

public void resetDrillDown()
                    throws java.io.IOException,
                           java.sql.SQLException,
                           java.lang.ClassNotFoundException

Resets the chart and remove all the drill down levels

countDrillDownLevel

public int countDrillDownLevel()

Counts number of drill down levels If non drill-down chart return -1

isPreSetDrillDown

public boolean isPreSetDrillDown()

This function is used to check if the pre-set drill down function is enabled or not

Returns:

True if pre-set drill down is enabled, False otherwise

setDynamicDrillDown

public void setDynamicDrillDown(boolean b)
                         throws java.io.IOException,
                                java.sql.SQLException,
                                java.lang.ClassNotFoundException

Enables dynamic drill down function for chart viewer

Parameters:

b - True if dynamic drill down function needs to be enabled, False otherwise

isDynamicDrillDown

public boolean isDynamicDrillDown()

This function is used to check if the dynamic drill down function is enabled or not

Returns:

True if dynamic drill down is enabled, False otherwise

setAggregateOperator

public void setAggregateOperator(int aggOp)

Sets the primary aggregate operator to use when displaying summary charts.

Parameters:

aggOp - The input primary aggregate operator, one of:

	IDrillDown.SUM
  	IDrillDown.AVG
	IDrillDown.MIN
	IDrillDown.MAX
	IDrillDown.COUNT
 

getAggregateOperator

public int getAggregateOperator()

Returns the primary aggregate operator used for drill-down.

Returns:

The primary aggregate operator used in drill-down.

setSecondaryAggregateOperator

public void setSecondaryAggregateOperator(int aggOp)

Sets the secondary AggregateOperator to use when displaying summary charts.

Parameters:

aggOp - The input secondary aggregate operator.

See Also:

setAggregateOperator(int)

addDrillDown

public void addDrillDown(int cType,
                         int categoryIndex,
                         int seriesIndex,
                         int sumbyIndex,
                         boolean isDrill2D)
                  throws java.io.IOException,
                         java.sql.SQLException,
                         java.lang.ClassNotFoundException

Adds a new drill-down definition to the end of the drill down list.

Parameters:

cType - The chartType to use for the new drill-down.

seriesIndex - The series index for the new drill-down chart. This can be set to -1 if no series is desired.

sumbyIndex - The sumBy column index for the drill-down chart. This can be set to -1 if no sumBy column is desired.

categoryIndex - The category index for the drill-down chart. This should be >= 0

isDrill2D - The dimension for the drill-down chart. This can be set to true if drill-down chart is 2D else it can be set to false if drill-down chart is 3D

insertDrillDownAt

public void insertDrillDownAt(int number,
                              int cType,
                              int categoryIndex,
                              int seriesIndex,
                              int sumbyIndex,
                              boolean isDrill2D)
                       throws java.io.IOException,
                              java.sql.SQLException,
                              java.lang.ClassNotFoundException

Inserts a new drill-down definition to the chart

Parameters:

number - Insert a new chart after that drill-down level number

removeDrillDown

public void removeDrillDown(int number)
                     throws java.io.IOException,
                            java.sql.SQLException,
                            java.lang.ClassNotFoundException

Removes a drill-down from the chart.

Parameters:

number - The drill-down number to remove (in the order entered).