com.aquafold.openapi.data

Interface AQDataFactory

public interface AQDataFactory

An object implementing this interface is available to aquascript via aqua.data alias.

Method Summary

Modifier and Type	Method and Description
AQExcelSpreadsheet	excelSpreadsheet(java.lang.String filename) This factory method returns a new in-memory Excel spreadsheet.
AQDataSet	newDataSet() Factory method returns a new empty data set.
AQDataSet	newDataSet(AQColumnStructure columnStructure) Creates a new data set with the specified column structure information.
AQDataSet	newDataSet(int rowCount, int columnCount) Creates a new data set with the specified dimensions.
AQDataSet	newDataSet(int rowCount, int columnCount, java.lang.Object[] data) Creates a new data set with the specified dimensions.
AQDataSet	newDataSet(java.lang.String[] columnNames) Factory method returns a new empty data set with the specified column names.
AQDataSetSettings	newDataSetSettings() Factory method returns a new empty setting instance for formatting an AQDataSet or an AQPivotDataSet in a 2-dimension grid.
AQExcelSpreadsheet	newExcelSpreadsheet(java.lang.String filename) This factory method returns a new in-memory Excel spreadsheet.
AQPivotDataSet	newPivotDataSet() Factory method returns a new empty pivot data set.

Method Detail

newDataSet

AQDataSet newDataSet()

Factory method returns a new empty data set.

Returns:

the data set

newDataSet

AQDataSet newDataSet(java.lang.String[] columnNames)

Factory method returns a new empty data set with the specified column names.

Parameters:

columnNames - Array of column names.

Returns:

the data set

newDataSet

AQDataSet newDataSet(int rowCount,
                     int columnCount)

Creates a new data set with the specified dimensions.

Parameters:

rowCount - Number of rows in the data set.

columnCount - Number of columns in the data set.

Returns:

the data set

newDataSet

AQDataSet newDataSet(int rowCount,
                     int columnCount,
                     java.lang.Object[] data)

Creates a new data set with the specified dimensions. This method allows to initialize the data set with provided values: the first element of the data array will be placed into row 0, column 0, the second element into row 0, column 1, and so on. If the number of elements in data array is greater than the dataset can hold, the remaining elements will be ignored. If the number of elements is less than the size of the data set, the remaining data cells in the dataset will be set to null.

Parameters:

rowCount - Number of rows in the data set.

columnCount - Number of columns in the data set.

data - An array of values to populate the data set.

Returns:

the data set

newDataSet

AQDataSet newDataSet(AQColumnStructure columnStructure)

Creates a new data set with the specified column structure information.

Parameters:

columnStructure - the column structure

Returns:

the data set

newPivotDataSet

AQPivotDataSet newPivotDataSet()

Factory method returns a new empty pivot data set.

Returns:

the pivot data set

newDataSetSettings

AQDataSetSettings newDataSetSettings()

Factory method returns a new empty setting instance for formatting an AQDataSet or an AQPivotDataSet in a 2-dimension grid.

Returns:

the data set settings

excelSpreadsheet

AQExcelSpreadsheet excelSpreadsheet(java.lang.String filename)

This factory method returns a new in-memory Excel spreadsheet. If the corresponding file exists, its contents will be loaded into memory. The format of the spreadsheet is determined from the filename extension: XLS for an Excel 2003 format, XLSX for an Excel 2007 format.

Parameters:

filename - The filename

Returns:

the Excel spreadsheet

newExcelSpreadsheet

AQExcelSpreadsheet newExcelSpreadsheet(java.lang.String filename)

This factory method returns a new in-memory Excel spreadsheet. The format of the spreadsheet is determined from the filename extension: XLS for an Excel 2003 format, XLSX for an Excel 2007 format.

Parameters:

filename - The filename

Returns:

the Excel spreadsheet