Dashboard

Interface DataFillableWidget

All Known Implementing Classes:

AreaChartWidget, BarChartWidget, ChartWidget, GridExWidget, GridWidget, LineChartWidget, PieChartWidget, RingChartWidget, StackedAreaChartWidget, StackedBarChartWidget, StackedPercentageBarChartWidget, XYChartWidget

public interface DataFillableWidget

Interface that facilitates the filling of the underlying dataset of the widget

Method Summary

Modifier and Type	Method and Description
void	clearDataSet() Clears the widget's underlying dataset
void	exportData(BBjNumber p_parentX, BBjNumber p_parentY, BBjNumber p_parentWidth, BBjNumber p_parentHeight) Displays an export dialog that allows the user to export the widget's data to a CSV file with several output options
void	fill(BBjRecordSet p_rs!, BBjVector p_columns!) Fills the widget underlying dataset with data from a BBjRecordSet
void	fill(BBjString p_connectString$, BBjString p_sql$) Fills the widget's underlying dataset with data from an SQL query
BBjVector	getColumns() Returns the Columns
BBjString	getConnectString() Returns the JDBC connect String
BBjRecordSet	getRecordSet() Returns the RecordSet
BBjString	getSQL() Returns the SQL query
void	viewData() Exports the widget's data to a CSV file and displays it in the application associated with CSV files on the client's machine

Method Detail

fill

void fill(BBjString p_connectString$,
BBjString p_sql$)

Fills the widget's underlying dataset with data from an SQL query

Parameters:

p_connectString$ - The connection string to the desired database. Example: "jdbc:basis:localhost?database = ChileCompany&user = admin&password = admin123"

p_sql$ - The sql query used to populate the widget.

fill

void fill(BBjRecordSet p_rs!,
BBjVector p_columns!)

Fills the widget underlying dataset with data from a BBjRecordSet

Parameters:

p_rs! - The BBjRecordSet containing the data used to populate the widget

p_columns! - A BBjVector that contains an ordered list of the columns to be used for the widgets's data. The entries may be a string corresponding to a field name, or a 0-based index of the column number. If null() is passed in for the p_columns! vector then the first X number of columns of the BBjRecordSet will be used.

clearDataSet

void clearDataSet()

Clears the widget's underlying dataset

viewData

void viewData()

Exports the widget's data to a CSV file and displays it in the application associated with CSV files on the client's machine

exportData

void exportData(BBjNumber p_parentX,
BBjNumber p_parentY,
BBjNumber p_parentWidth,
BBjNumber p_parentHeight)

Displays an export dialog that allows the user to export the widget's data to a CSV file with several output options

Parameters:

p_parentX - X location of the parent window

p_parentY - Y location of the parent window

p_parentWidth - Width of the parent window

p_parentHeight - Height of the parent window

getConnectString

BBjString getConnectString()

Returns the JDBC connect String

Returns:

JDBC connnect string

getSQL

BBjString getSQL()

Returns the SQL query

Returns:

SQL query

getRecordSet

BBjRecordSet getRecordSet()

Returns the RecordSet

Returns:

BBjRecordSet

getColumns

BBjVector getColumns()

Returns the Columns

Returns:

BBjVector which contains the column names