EspressReport 6.6

quadbase.util
Interface IZoomInfo


public interface IZoomInfo

This interface is used to set/get different properties associated with doing time-series zooming. Users can obtain a handle to this by calling the gethZoomInfo() function in QbChart. Note that Zooming only works with time-series data. i.e. the data type of the category column should be one of: Time, Date, or Timestamp.


Field Summary
static int AVG
           
static int COUNT
           
static int COUNTDISTINCT
           
static int DAY
           
static int FIRST
           
static int HOUR
           
static int LAST
           
static int MAX
           
static int MAX_OPS
           
static int MIN
           
static int MINUTE
           
static int MONTH
           
static int SECOND
           
static int STDDEV
           
static int SUM
           
static int SUMSQUARE
           
static int VARIANCE
           
static int WEEK
           
static int YEAR
          Constants for the Date/Time units
 
Method Summary
 int getAggregateOperator()
          Get the aggregate operator used for aggregating points along the primary value axis.
 java.util.Date getLowerBound()
          Returns the lower bound value (min value) plotted in the category axis.
 int getMaxScaleUnit()
          Get the maximum allowable scale unit.
 int getMaxScaleValue()
          Get the maximum allowable scale value
 int getMinScaleUnit()
          Get the minimum allowable scale unit.
 int getMinScaleValue()
          Get the minimum allowable scale value.
 int getScaleUnit()
          Returns the unit of the scale value being used.
 int getScaleValue()
          Get the scale value used while plotting the new data
 int getSecondaryAggregateOperator()
          This function gets the secondary aggregate operator.
 java.util.Date getUpperBound()
          Returns the upper bound value (max value) plotted in the category axis.
 boolean isLinearScale()
          Returns whether or not a linear scale is being used for the category axis.
 boolean isZoomEnabled()
          Check if the current chart contains a time-series zoom or not.
 void setAggregateOperator(int aggOp)
          This function sets the primary aggregate operator
 void setLinearScale(boolean isLinear)
          Enables/Disables drawing of a linear scale for the category axis.
 void setLowerBound(java.util.Date lowerBound)
          Sets the lower bound (min) value used in zooming.
 void setMaxScale(int value, int unit)
          Sets the maximum allowable scale unit and value used in zoom.
 void setMinScale(int value, int unit)
          Sets the minimum allowable scale unit and value used in zoom.
 void setScale(int value, int unit)
          Sets the unit and value of scaling to be performed.
 void setSecondaryAggregateOperator(int aggOp)
          This function sets the secondary aggregate operator.
 void setUpperBound(java.util.Date upperBound)
          Sets the upper bound (max) value used in zooming.
 void setZoomEnabled(boolean isZoomEnabled)
          Enable/Disable zooming along a time-series category axis.
 

Field Detail

MIN

static final int MIN
See Also:
Constant Field Values

MAX

static final int MAX
See Also:
Constant Field Values

AVG

static final int AVG
See Also:
Constant Field Values

SUM

static final int SUM
See Also:
Constant Field Values

COUNT

static final int COUNT
See Also:
Constant Field Values

FIRST

static final int FIRST
See Also:
Constant Field Values

LAST

static final int LAST
See Also:
Constant Field Values

SUMSQUARE

static final int SUMSQUARE
See Also:
Constant Field Values

VARIANCE

static final int VARIANCE
See Also:
Constant Field Values

STDDEV

static final int STDDEV
See Also:
Constant Field Values

COUNTDISTINCT

static final int COUNTDISTINCT
See Also:
Constant Field Values

MAX_OPS

static final int MAX_OPS
See Also:
Constant Field Values

YEAR

static final int YEAR
Constants for the Date/Time units

See Also:
Constant Field Values

MONTH

static final int MONTH
See Also:
Constant Field Values

WEEK

static final int WEEK
See Also:
Constant Field Values

DAY

static final int DAY
See Also:
Constant Field Values

HOUR

static final int HOUR
See Also:
Constant Field Values

MINUTE

static final int MINUTE
See Also:
Constant Field Values

SECOND

static final int SECOND
See Also:
Constant Field Values
Method Detail

isZoomEnabled

boolean isZoomEnabled()
Check if the current chart contains a time-series zoom or not.

Returns:
True if it is a zoom chart, false otherwise.

setZoomEnabled

void setZoomEnabled(boolean isZoomEnabled)
Enable/Disable zooming along a time-series category axis.

Parameters:
isZoomEnabled - Set it to true if zooming is required, false otherwise.

getAggregateOperator

int getAggregateOperator()
Get the aggregate operator used for aggregating points along the primary value axis.


setAggregateOperator

void setAggregateOperator(int aggOp)
This function sets the primary aggregate operator

Parameters:
aggOp - The aggregate operator used for displaying points along the primary value axis. Valid aggregate operators are MIN, MAX, AVG, SUM, and COUNT.
See Also:
getAggregateOperator()

getSecondaryAggregateOperator

int getSecondaryAggregateOperator()
This function gets the secondary aggregate operator. Only valid if a secondary column exists in the chart.

Returns:
The secondary aggregate operator.
See Also:
getAggregateOperator()

setSecondaryAggregateOperator

void setSecondaryAggregateOperator(int aggOp)
This function sets the secondary aggregate operator. Only valid if a secondary column exists in the chart

Parameters:
aggOp - The secondary aggregate Operator. Valid aggregate operators are MIN, MAX, AVG, SUM, and COUNT.
See Also:
setAggregateOperator(int)

isLinearScale

boolean isLinearScale()
Returns whether or not a linear scale is being used for the category axis.

Returns:
True if a linear scale has been plotted, false otherwise.

setLinearScale

void setLinearScale(boolean isLinear)
Enables/Disables drawing of a linear scale for the category axis.

Parameters:
isLinear - Set it to true if a linear scale is desired, false otherwise.

getLowerBound

java.util.Date getLowerBound()
Returns the lower bound value (min value) plotted in the category axis.

Returns:
The lower bound value.

setLowerBound

void setLowerBound(java.util.Date lowerBound)
Sets the lower bound (min) value used in zooming.

Parameters:
lowerBound - The lower bound used in zooming. The type of the lower bound parameter should be one of:
   java.sql.Date
   java.sql.Time
   java.sql.Timestamp
 

getUpperBound

java.util.Date getUpperBound()
Returns the upper bound value (max value) plotted in the category axis.

Returns:
The upper bound value.
See Also:
getLowerBound()

setUpperBound

void setUpperBound(java.util.Date upperBound)
Sets the upper bound (max) value used in zooming.

Parameters:
upperBound - The upper bound value used in zooming.
See Also:
setLowerBound(java.util.Date)

getScaleUnit

int getScaleUnit()
Returns the unit of the scale value being used.

Returns:
The scale unit being used. It can be one of:
   IZoomInfo.YEAR
   IZoomInfo.MONTH
   IZoomInfo.WEEK
   IZoomInfo.DAY
   IZoomInfo.HOUR
   IZoomInfo.MINUTE
   IZoomInfo.SECOND
 

getScaleValue

int getScaleValue()
Get the scale value used while plotting the new data

Returns:
The scale value used in Zooming.
See Also:
getScaleUnit(), setScale(int, int)

setScale

void setScale(int value,
              int unit)
Sets the unit and value of scaling to be performed.

Parameters:
unit - The scale unit to use.
value - The scale value to use.
See Also:
getScaleUnit(), getScaleValue()

getMinScaleUnit

int getMinScaleUnit()
Get the minimum allowable scale unit.

Returns:
The minimum allowable scale unit.
See Also:
getScaleUnit()

getMinScaleValue

int getMinScaleValue()
Get the minimum allowable scale value.

Returns:
The minimum allowable scale value.
See Also:
getScaleValue()

setMinScale

void setMinScale(int value,
                 int unit)
Sets the minimum allowable scale unit and value used in zoom.

Parameters:
unit - The minimum allowable scale unit.
value - The minimum allowable scale value.
See Also:
setScale(int, int)

getMaxScaleUnit

int getMaxScaleUnit()
Get the maximum allowable scale unit.

Returns:
The maximum allowable scale unit.
See Also:
getMinScaleUnit()

getMaxScaleValue

int getMaxScaleValue()
Get the maximum allowable scale value

Returns:
The maximum allowable scale value.
See Also:
getMinScaleValue()

setMaxScale

void setMaxScale(int value,
                 int unit)
Sets the maximum allowable scale unit and value used in zoom.

Parameters:
unit - The maximum allowable scale unit.
value - The maximum allowable scale value
See Also:
setMinScale(int, int)

EspressReport 6.6