Package quadbase.util

Interface IInputData

public interface IInputData
This interface defines methods to modify the chart's input data properties, including file or database information, and accessing individual records. A handle to an object that implements this interface can be obtained by calling the getInputData method defined in QbChart.

  • Method Details

    • getColumnMap

      IColumnMap getColumnMap()
      Returns the data column mapping information. i.e. which columns are used for plotting the category, series, sum-by, value, and sub-value.

      Associated QbChart property: DATACOLUMN

      Returns:
      the chart column mapping information
      See Also:

    • setColumnMap

      void setColumnMap(IColumnMap info)
      Set the chart column mapping.
      Parameters:
      info - An instance of IColumnMap containing the column mappings.
      See Also:

    • getDatabaseInfo

      IDatabaseInfo getDatabaseInfo()
      Gets the database info used for plotting the chart. Only valid if the chart was created by performing a database query.

      Associated QbChart property: PLOTDATA

      Returns:
      An object containing the database information.
      See Also:

    • setDatabaseInfo

      void setDatabaseInfo(IDatabaseInfo db) throws Exception
      Sets the input database information, which is used to create a chart.

      Associated QbChart property: PLOTDATA

      Parameters:
      db - An IDatabaseInfo implementation object containing the database connect info and search query.
      Throws:
      Exception
      See Also:

    • setDatabaseInfo

      void setDatabaseInfo(IDatabaseInfo db, boolean getNewData) throws Exception
      Sets the input database information, which is used to create a chart.

      Associated QbChart property: PLOTDATA

      Parameters:
      db - An IDatabaseInfo implementation object containing the database connect info and search query.
      getNewData - : indicate if it is required to retrieve new data from the data source.
      Throws:
      Exception

    • getQueryFilename

      String getQueryFilename()
      Gets a query file (*.qry) for plotting the chart. A query file is a hard copy of a IQueryFileInfo object, which contains database driver, url, username, password, input parameters(if applicable) and output parameters(if applicable) IQueryFileInfo is a subclass of IDatabaseInfo
      Returns:
      A query file name with extension *.qry return null if no query file is used
      See Also:

    • setQueryFilename

      void setQueryFilename(String filename) throws Exception
      Sets a query file (*.qry) for plotting the chart. A query file is a hard copy of a IQueryFileInfo object, which contains database driver, url, username, password, input parameters(if applicable) and output parameters(if applicable) IQueryFileInfo is a subclass of IDatabaseInfo
      Parameters:
      filename - A query file name with extension *.qry
      Throws:
      Exception
      See Also:

    • readQueryFile

      IQueryFileInfo readQueryFile(String filename) throws Exception
      Reads a query file (*.qry) and returns a IQueryFileInfo object.
      Parameters:
      filename - A query file name with extension *.qry
      Returns:
      A IQueryFileInfo object
      Throws:
      Exception

    • setDataFile

      void setDataFile(String fileName) throws IOException
      Sets the input data file, which is used to create a chart.

      Associated QbChart property: PLOTDATA

      Parameters:
      fileName - The name of the input data file.
      Throws:
      IOException

    • setDataFile

      void setDataFile(String fileName, String encoding) throws IOException
      Sets the input data file, which is used to create a chart.

      Parameters:
      fileName - The name of the input data file.
      encoding - The encoding of the file
      Throws:
      IOException

    • getDataFile

      String getDataFile()
      Gets the name of the input data file used to create the chart.
      Returns:
      The name of the input data file.

    • setClassFile

      void setClassFile(String className) throws IOException
      Sets the input class file, which is used to create a chart.

      Parameters:
      className - The name of the input class.
      Throws:
      IOException

    • getClassFile

      String getClassFile()
      Gets the name of the input class file used to create the chart.
      Returns:
      The name of the input class file.

    • setXMLFileQueryInfo

      void setXMLFileQueryInfo(XMLFileQueryInfo xmlInfo)
      Sets the xml file query info, which is used to create a chart.

      Parameters:
      xmlInfo - The XMLFileQueryInfo.

    • getXMLFileQueryInfo

      XMLFileQueryInfo getXMLFileQueryInfo()
      Gets the xml file query info used to create the chart.
      Returns:
      The XMLFileQueryInfo.

    • setXMLFile

      void setXMLFile(String xmlName) throws IOException
      Sets the input xml file, which is used to create a chart.

      Parameters:
      xmlName - The name of the input xml file.
      Throws:
      IOException

    • getXMLFile

      String getXMLFile()
      Gets the name of the input xml file used to create the chart.
      Returns:
      The name of the input xml file.

    • getDTDFile

      String getDTDFile()
      Gets the name of the input dtd file used to create the chart.
      Returns:
      The name of the input dtd file.

    • isSpreadSheetFormat

      boolean isSpreadSheetFormat()
      This flag notifies that the input result set should be treated as a spreadsheet. The first column in the input is assumed to be the "row label column". The other column headings (except the first) are called "column labels". The values in the remaining rows and columns are treated as cells in the spreadsheet. Before plotting the chart, data is transposed from the spreadsheet form into a tabular form. The new result set has three columns : RowLabel, ColumnLabel and Value. The RowLabel column only contains the values from the first input column. The ColumLabel column only contains values from the input column headings. Finally, each cell in the original spreadsheet is transformed into a distinct row, comprising the row label, the column label, and the value of that cell.

      Such a transformation is useful when the various columns in a result set from a spreadsheet (e.g. Excel) need to be treated as different series for the same data category (denoted by the first column in the set). Note that the data types of all the columns (except the first) must be numeric and of the same type.

    • getTransposedColumn

      int[] getTransposedColumn()
      This method returns the transposed columns for spreadsheet format

    • setSpreadSheetFormat

      void setSpreadSheetFormat(boolean b)
      This flag notifies the chart that the input result set should be treated as a spreadsheet. See ISpreadSheetFormat() for details.
      Parameters:
      b - the status of the spreadsheet format
      See Also:

    • setSpreadSheetFormat

      void setSpreadSheetFormat(boolean b, int[] transposedColumn)
      This flag notifies the chart that the input result set should be treated as a spreadsheet. See ISpreadSheetFormat() for details.
      Parameters:
      b - the status of the spreadsheet format
      transposedColumn - - transposed column index
      See Also:

    • addRow

      void addRow(IRow r)
      Adds a new row to the chart input data.

      Associated QbChart property: ADD_RECORD

      Parameters:
      r - An object of type quadbase.util.IRow
      See Also:

    • deleteRow

      void deleteRow(int rowId)
      Delete a record(row) from the chart input data.

      Associated QbChart property: DEL_RECORD

      Parameters:
      rowId - The row number to delete.

    • updateRow

      void updateRow(int rowId, IRow r)
      Update the specified row in the chart.

      Associated QbChart property: UPDATE_RECORD

      Parameters:
      rowId - The row number to update
      r - The new row values.
      See Also:

    • getRow

      IRow getRow(int rowId)
      Gets the specified row data from the chart.

      Associated QbChart property: GET_RECORD

      Parameters:
      rowId - The row number.
      Returns:
      The IRow object containing the row data.
      See Also:

    • getRowCount

      int getRowCount()
      Returns the total number of rows in the input data.

      Associated QbChart property: GET_NOOF_RECORD

      Returns:
      The total number of rows in the input data set.

    • matchRecord

      int matchRecord(IRow r)
      Get the row number containing the record that matches the input row.

      Associated QbChart property: GET_RECORDNO

      Parameters:
      r - The IRow object for which the row number is desired.
      Returns:
      The row number in the data set.
      See Also:

    • getData

      IResultSet getData()
      Returns the IResultSet object containing the input chart data.
      Returns:
      The IResultSet object.
      See Also:

    • setData

      void setData(IResultSet rs) throws Exception
      Sets the input data for the chart using an IResultSet object. Reloads data by default.
      Parameters:
      rs - The IResultSet object
      Throws:
      Exception
      See Also:

    • setData

      void setData(IResultSet rs, boolean reloadData) throws Exception
      Sets the input data for the chart using an IResultSet object.
      Parameters:
      rs - The IResultSet object
      reloadData - Should the chart data be reloaded?
      Throws:
      Exception
      See Also:

    • getSpreadSheetModel

      ISpreadSheetModel getSpreadSheetModel()
      Returns the spread sheet model for the chart, if one is set.
      See Also:

    • setSpreadSheetModel

      void setSpreadSheetModel(ISpreadSheetModel sheet)
      Sets the chart's spread sheet model to the given object.
      Parameters:
      sheet - the spreadsheet model object
      See Also:

    • getExcelFileInfo

      quadbase.common.util.internal.ExcelFileInfo getExcelFileInfo()
      Gets the Excel info used for the chart. Only valid if the chart was created from Excel data source.
      Returns:
      Excel data source information
      See Also:
      • ExcelFileInfo

    • setExcelFileInfo

      void setExcelFileInfo(quadbase.common.util.internal.ExcelFileInfo excelInfo) throws Exception
      Sets the Excel info for the chart.
      Parameters:
      excelInfo - Excel data source information
      Throws:
      Exception - if an error occurred
      See Also:
      • ExcelFileInfo