Package 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

    Fields
    Modifier and Type
    Field
    Description
    static final int
    AVG
     
    static final int
    COUNT
     
    static final int
    COUNTDISTINCT
     
    static final int
    DAY
     
    static final int
    FIRST
     
    static final int
    HOUR
     
    static final int
    LAST
     
    static final int
    MAX
     
    static final int
    MAX_OPS
     
    static final int
    MIN
     
    static final int
    MINUTE
     
    static final int
    MONTH
     
    static final int
    SECOND
     
    static final int
    STDDEV
     
    static final int
    SUM
     
    static final int
    SUMSQUARE
     
    static final int
    VARIANCE
     
    static final int
    WEEK
     
    static final int
    YEAR
    Constants for the Date/Time units

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    getAggregateOperator()
    Get the aggregate operator used for aggregating points along the primary value axis.
    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.
    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(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(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 Details

  • Method Details

    • 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:

    • 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:

    • 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:

    • 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

      Date getLowerBound()
      Returns the lower bound value (min value) plotted in the category axis.
      Returns:
      The lower bound value.

    • setLowerBound

      void setLowerBound(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

      Date getUpperBound()
      Returns the upper bound value (max value) plotted in the category axis.
      Returns:
      The upper bound value.
      See Also:

    • setUpperBound

      void setUpperBound(Date upperBound)
      Sets the upper bound (max) value used in zooming.
      Parameters:
      upperBound - The upper bound value used in zooming.
      See Also:

    • 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:

    • setScale

      void setScale(int value, int unit)
      Sets the unit and value of scaling to be performed.
      Parameters:
      value - The scale value to use.
      unit - The scale unit to use.
      See Also:

    • getMinScaleUnit

      int getMinScaleUnit()
      Get the minimum allowable scale unit.
      Returns:
      The minimum allowable scale unit.
      See Also:

    • getMinScaleValue

      int getMinScaleValue()
      Get the minimum allowable scale value.
      Returns:
      The minimum allowable scale value.
      See Also:

    • setMinScale

      void setMinScale(int value, int unit)
      Sets the minimum allowable scale unit and value used in zoom.
      Parameters:
      value - The minimum allowable scale value.
      unit - The minimum allowable scale unit.
      See Also:

    • getMaxScaleUnit

      int getMaxScaleUnit()
      Get the maximum allowable scale unit.
      Returns:
      The maximum allowable scale unit.
      See Also:

    • getMaxScaleValue

      int getMaxScaleValue()
      Get the maximum allowable scale value
      Returns:
      The maximum allowable scale value.
      See Also:

    • setMaxScale

      void setMaxScale(int value, int unit)
      Sets the maximum allowable scale unit and value used in zoom.
      Parameters:
      value - The maximum allowable scale value
      unit - The maximum allowable scale unit.
      See Also: