Package quadbase.util

Interface IDrillDown

public interface IDrillDown

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    AVG
     
    static final int
    COUNT
     
    static final int
    COUNTDISTINCT
     
    static final int
    FIRST
     
    static final int
    LAST
     
    static final int
    MAX
     
    static final int
    MAX_OPS
     
    static final int
    MIN
     
    static final int
    STDDEV
     
    static final int
    SUM
     
    static final int
    SUMSQUARE
     
    static final int
    VARIANCE
     

  • Method Summary

    Modifier and Type
    Method
    Description
    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.
    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(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 Details

  • Method Details

    • setDrillName

      void setDrillName(String drillBaseName)
      Sets the base name for defining drill-down charts.
      Parameters:
      drillBaseName - The base drill name to use.

    • getDrillName

      String getDrillName()
      Returns the base drill-name
      Returns:
      The base drill-down name.

    • resetDrillDown

      void resetDrillDown() throws IOException, SQLException, ClassNotFoundException
      Resets the chart and remove all the drill down levels
      Throws:
      IOException
      SQLException
      ClassNotFoundException

    • countDrillDownLevel

      int countDrillDownLevel()
      Counts number of drill down levels If non drill-down chart return -1

    • isPreSetDrillDown

      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

      void setDynamicDrillDown(boolean b) throws IOException, SQLException, ClassNotFoundException
      Enables dynamic drill down function for chart viewer
      Parameters:
      b - True if dynamic drill down function needs to be enabled, False otherwise
      Throws:
      IOException
      SQLException
      ClassNotFoundException

    • isDynamicDrillDown

      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

      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

      int getAggregateOperator()
      Returns the primary aggregate operator used for drill-down.
      Returns:
      The primary aggregate operator used in drill-down.

    • setSecondaryAggregateOperator

      void setSecondaryAggregateOperator(int aggOp)
      Sets the secondary AggregateOperator to use when displaying summary charts.
      Parameters:
      aggOp - The input secondary aggregate operator.
      See Also:

    • addDrillDown

      void addDrillDown(int cType, int categoryIndex, int seriesIndex, int sumbyIndex, boolean isDrill2D) throws IOException, SQLException, 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.
      categoryIndex - The category index for the drill-down chart. This should be >= 0
      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.
      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
      Throws:
      IOException
      SQLException
      ClassNotFoundException

    • insertDrillDownAt

      void insertDrillDownAt(int number, int cType, int categoryIndex, int seriesIndex, int sumbyIndex, boolean isDrill2D) throws IOException, SQLException, ClassNotFoundException
      Inserts a new drill-down definition to the chart
      Parameters:
      number - Insert a new chart after that drill-down level number
      Throws:
      IOException
      SQLException
      ClassNotFoundException

    • removeDrillDown

      void removeDrillDown(int number) throws IOException, SQLException, ClassNotFoundException
      Removes a drill-down from the chart.
      Parameters:
      number - The drill-down number to remove (in the order entered).
      Throws:
      IOException
      SQLException
      ClassNotFoundException