Package quadbase.ChartAPI

Class ColInfo

java.lang.Object
quadbase.ChartAPI.ColInfo
All Implemented Interfaces:
IColumnMap, IMapConstants
public class ColInfo extends Object implements IColumnMap, IMapConstants
ColInfo

This class provides an implementation for the quadbase.util.IColumnMap interface. It contains information about how the charting program utilizes different columns in the input data to plot a chart. They are:
value - column index which contains numerical values to plot the chart
category - column index which contains category data
series - column index which contains series data
sumBy - for stack bar, stack column and stack area only, it contains the column index which is used to group and sum the data in stack chart.
For xy and xyz charts, the numerical value columns are set via variables, xvalue, yvalue and zvalue; for high-low charts, the variables high, low, open, and close are used.

See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    int
    category
     
    int
    close
     
    int
    high
     
    int
    low
     
    int
    open
     
    int
    series
     
    int
    subseries
     
    int
    subvalue
     
    int
    sumBy
     
    int
    value
     
    int
    xvalue
     
    int
    yvalue
     
    int
    zvalue
     

    Fields inherited from interface quadbase.util.IMapConstants

    CATEGORY, CLOSE, END_DATE, HIGH, LOW, OPEN, SCATTER_X, SCATTER_Y, SCATTER_Z, SECONDARY_SERIES, SECONDARY_VALUE, SERIES, START_DATE, SUB_TASK, SUMBY, TASK, VALUE

  • Constructor Summary

    Constructors
    Constructor
    Description
    ColInfo()
    Creates a new ColInfo object.
    ColInfo(int series, int[] values)
    Creates a new ColInfo object for Scatter chart
    ColInfo(int series, int category, int sumBy, int value)
    Creates a new ColInfo object for Bar, Column, Stack Bar, Stack Column, 100% Column, Line, Pie, Area, Stack Area
    ColInfo(int series, int category, int sumBy, int value, int subvalue)
    Creates a new ColInfo object for Bar, Column, Stack Bar, Stack Column, 100% Column, Line, Area, Stack Area
    ColInfo(int series, int category, int high, int low, int open, int close)
    Creates a new ColInfo object for High Low, HLCO, and GANTT charts
    ColInfo(int series, int category, int high, int low, int open, int close, int subvalue)
    Creates a new ColInfo object for High Low, HLCO, and GANTT charts
    ColInfo(int series, int category, int value, int sumBy, int high, int low, int open, int close, int subvalue, int subseries)
    Creates a new ColInfo object for secondary overlay chart

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    compare(ColInfo colInfo)
     
    final int
    getColumn(int map)
    Get the column index for the given chart dimension(field).
    int
    hashCode()
     
    void
    setDataColumn(quadbase.chart.Chart chart)
    This is for internal use only.

    Methods inherited from class java.lang.Object

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

  • Field Details

    • value

      public int value

    • subvalue

      public int subvalue

    • category

      public int category

    • series

      public int series

    • subseries

      public int subseries

    • sumBy

      public int sumBy

    • xvalue

      public int xvalue

    • yvalue

      public int yvalue

    • zvalue

      public int zvalue

    • high

      public int high

    • low

      public int low

    • open

      public int open

    • close

      public int close

  • Constructor Details

    • ColInfo

      public ColInfo()
      Creates a new ColInfo object. This constructor can be used to create a default object and the mappings can then be set for the desired axes.

        ColInfo chartMapping = new ColInfo(); chartMapping.xvalue = 0; chartMapping.yvalue = 1; chartMapping.zvalue = 2;

      While the above mapping is for a Scatter chart, the mapping for any chart can be set by passing the column index to the appropriate axis. For more details, please refer to the Appexdix in the manual for the chart mapping properties for the different chart types.

      This constructor can be used for any chart.

    • ColInfo

      public ColInfo(int series, int category, int sumBy, int value)
      Creates a new ColInfo object for Bar, Column, Stack Bar, Stack Column, 100% Column, Line, Pie, Area, Stack Area
      Parameters:
      series - column index in input data used for data series, -1 if no series
      category - column index for category data
      sumBy - column index used to sum the data for stack chart, -1 for non-stack chart
      value - column index for numerical column to plot chart

    • ColInfo

      public ColInfo(int series, int category, int sumBy, int value, int subvalue)
      Creates a new ColInfo object for Bar, Column, Stack Bar, Stack Column, 100% Column, Line, Area, Stack Area
      Parameters:
      series - column index in input data use for data series, -1 if no series
      category - column index for category data
      sumBy - column index used to sum the data for stack chart, -1 for non-stack chart
      value - column index for numerical column to plot chart
      subvalue - column index for secondary value axis, -1 if not used

    • ColInfo

      public ColInfo(int series, int[] values)
      Creates a new ColInfo object for Scatter chart
      Parameters:
      series - column index for data series, -1 if no series
      values - array of two elements contain x, y numerical columns for x-axis, y-axis plotting. Or array of three elements contain x, y, z numerical columns. For Polar Chart: array of two elements contain angle, radial.

    • ColInfo

      public ColInfo(int series, int category, int high, int low, int open, int close)
      Creates a new ColInfo object for High Low, HLCO, and GANTT charts
      Parameters:
      series - column index for data series, -1 if no series
      category - column index for category data
      high - column index for high data
      low - column index for low data
      open - column index for open data, -1 if not use
      close - column index for close data, -1 if not use

    • ColInfo

      public ColInfo(int series, int category, int high, int low, int open, int close, int subvalue)
      Creates a new ColInfo object for High Low, HLCO, and GANTT charts
      Parameters:
      series - column index for data series, -1 if no series
      category - column index for category data
      high - column index for high data
      low - column index for low data
      open - column index for open data, -1 if not use
      close - column index for close data, -1 if not use
      subvalue - column index for secondary value axis, -1 if not used

    • ColInfo

      public ColInfo(int series, int category, int value, int sumBy, int high, int low, int open, int close, int subvalue, int subseries)
      Creates a new ColInfo object for secondary overlay chart
      Parameters:
      series - column index for data series, -1 if no series
      category - column index for category data
      value - column index for primary value axis, -1 if not used
      sumBy - column index used to sum the data for stack chart, -1 for non-stack chart
      high - column index for high data
      low - column index for low data
      open - column index for open data, -1 if not use
      close - column index for close data, -1 if not use
      subvalue - column index for secondary value axis, -1 if not used
      subseries - column index for secondary data series, -1 if not used

  • Method Details