quadbase.ChartAPI

Class DbData

java.lang.Object

quadbase.ChartAPI.DbData

All Implemented Interfaces:

IResultSet, IRow

public class DbData
extends java.lang.Object
implements IResultSet

This class provides an implementation for the @link quadbase.util.IResultSet interface using an array of data. IResultSet is used to provide input data to a chart. DbData holds the data information necessary to plot a chart. They are (i) data type for each column (ii) name for each column (iii) a list of data records

A simple example of a DbData object would be follows :

String[] dataTypes = {"String", "int"};
String[] colNames = {"Column A", "Column B"};
String[][] records = {{"abc", "5"}, {"def", "9"}, {"ghi", "4"}};

DbData data = new DbData(dataTypes, colnames, records);

See Also:

IResultSet

Constructor Summary

Constructors

Constructor and Description
DbData(java.lang.String s) Constructs DbData by parsing the data value argument in HTML page. The format for the String is the same as the data file format, except that each line is ended by a vertical bar "|".
DbData(java.lang.String[] fieldName, java.lang.Object[][] records) Constructs a new DbData class
DbData(java.lang.String[] dataType, java.lang.String[] fieldName, java.lang.String[][] records) Constructs a new DbData class

Method Summary

Modifier and Type	Method and Description
void	close() Closes the cursor
quadbase.chart.ColData[]	getColData() This is for internal use only
java.lang.Object[][]	getData() Gets the record data, field j of record i is stored in position [i][j] of the result as an Object of that type.
java.lang.String[]	getFieldName() Deprecated. Please use the getMetaData method to obtain this information
int[]	getFieldType() Deprecated. Please use the getMetaData method to obtain this information
IRSMetaData	getMetaData() Gets the meta data object
java.lang.Object	getObject(int col) Returns the data value stored in the specified column of this row.
boolean	next() Advances cursor to next row

Methods inherited from class java.lang.Object

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

Constructor Detail

DbData

public DbData(java.lang.String[] dataType,
              java.lang.String[] fieldName,
              java.lang.String[][] records)
       throws java.lang.IllegalArgumentException

Constructs a new DbData class

Parameters:

dataType - an array of dataType specify by String. The following are valid data type recognize by the class.
integer : "int", "integer", "smallint", tinyint" or "short"
long : "long", "bigint"
numeric : "numeric"
decimal : "decimal"
float : "float", "real"
double : "double"
time : "time"
date : "date"
timestamp : "timestamp"
varchar : "string", "varchar"
longvarchar : "longvarchar"
boolean : "boolean", "logical", "bit"
Data type names are case insensitive.

fieldName - an array of name for each field in the record

records - array of record, record[i] consists of array of size n where n = size of dataType = size of fieldName. Each field j in i, i.e. record[i][j] represent the data pass as string. The class will convert the string to appropriate data type. For null field value use set record to null If there is a size mismatch or invalid record entry that can't convert to destination data type, an IllegalArgumentException is thrown.

Throws:

java.lang.IllegalArgumentException

DbData

public DbData(java.lang.String[] fieldName,
              java.lang.Object[][] records)
       throws java.lang.IllegalArgumentException

Constructs a new DbData class

Parameters:

fieldName - an array of field name for data column

records - an array of records. Each field in the record is an instance of destination type. If there is a size mismatch or the data in the records is not an instance of type known by the class, an IllegalArgumentException is thrown.

Throws:

java.lang.IllegalArgumentException

DbData

public DbData(java.lang.String s)
       throws java.lang.IllegalArgumentException

Constructs DbData by parsing the data value argument in HTML page. The format for the String is the same as the data file format, except that each line is ended by a vertical bar "|".

Parameters:

s - string value from the HTML page

Throws:

java.lang.IllegalArgumentException

Method Detail

getColData

public quadbase.chart.ColData[] getColData()

This is for internal use only

getFieldName

@Deprecated
public java.lang.String[] getFieldName()

Deprecated. Please use the getMetaData method to obtain this information

Gets the field names for the data store in this class.

Returns:

an array of field name

getFieldType

@Deprecated
public int[] getFieldType()

Deprecated. Please use the getMetaData method to obtain this information

Gets the field data type for the data store in this class.

Returns:

an array of integer represent the field data type. The integer is defined in jdbc/Types.class

getData

public java.lang.Object[][] getData()

Gets the record data, field j of record i is stored in position [i][j] of the result as an Object of that type.

Returns:

2D array of record data.

next

public final boolean next()
                   throws java.lang.Exception

Description copied from interface: IResultSet

Advances cursor to next row

Specified by:

next in interface IResultSet

Throws:

java.lang.Exception

close

public final void close()
                 throws java.lang.Exception

Description copied from interface: IResultSet

Closes the cursor

Specified by:

close in interface IResultSet

Throws:

java.lang.Exception

getMetaData

public final IRSMetaData getMetaData()
                              throws java.lang.Exception

Description copied from interface: IResultSet

Gets the meta data object

Specified by:

getMetaData in interface IResultSet

Throws:

java.lang.Exception

getObject

public final java.lang.Object getObject(int col)
                                 throws java.lang.Exception

Description copied from interface: IRow

Returns the data value stored in the specified column of this row.

Specified by:

getObject in interface IRow

Parameters:

col - The column number for the field, beginning with 1.

Returns:

The data value stored in that column field.

Throws:

java.lang.Exception