OpenAPI 1.0

com.aquafold.openapi.data
Interface AQPivotDataSet


public interface AQPivotDataSet

This interface provides a means to represent a AQDataSet in a pivot table.

Sorting is supported and can be applied to the following areas:

Please note that the sortDataColumn methods will override the sorting specification of the inner most row field in the pivot table.

When rendering in HTML, custom hyperlinks can be defined and attached to the most of cells contained in the pivot table. Trend charts can also be generated for values contained in each row. Please see AQDataSetSettings for more information.

An instance of the object that implements the AQPivotDataSet interface can be instantiated via aqua.data.newPivotDataSet() alias.


Method Summary
 void addColumnField(String fieldName)
          Adds a column field to the pivot table.
 void addColumnFieldSubtotalCount(String fieldName)
          Includes showing subtotal as the number of records stored in the database for the specified field when it is defined as a column field.
 void addColumnFieldSubtotalMax(String fieldName)
          Includes showing subtotal as the maximum value among all pivot values for the specified field when it is defined as a column field.
 void addColumnFieldSubtotalMean(String fieldName)
          Includes showing subtotal as the average of all pivot values for the specified field when it is defined as a column field.
 void addColumnFieldSubtotalMin(String fieldName)
          Includes showing subtotal as the minimum value among all pivot values for the specified field when it is defined as a column field.
 void addColumnFieldSubtotalStdDev(String fieldName)
          Includes showing subtotal as the standard deviation of all pivot values for the specified field when it is defined as a column field.
 void addColumnFieldSubtotalSum(String fieldName)
          Includes showing subtotal as the sum of all pivot values for the specified field when it is defined as a column field.
 void addColumnFieldSubtotalVar(String fieldName)
          Includes showing subtotal as the variance of all pivot values for the specified field when it is defined as a column field.
 void addDataField(String fieldName)
          Adds a data field to the pivot table.
 void addFieldSubtotalCount(String fieldName)
          Includes showing subtotal as the number of records stored in the database for the specified field when it is defined as either a row field or a column field.
 void addFieldSubtotalMax(String fieldName)
          Includes showing subtotal as the maximum value among all pivot values for the specified field when it is defined as either a row field or a column field.
 void addFieldSubtotalMean(String fieldName)
          Includes showing subtotal as the average of all pivot values for the specified field when it is defined as either a row field or a column field.
 void addFieldSubtotalMin(String fieldName)
          Includes showing subtotal as the minimum value among all pivot values for the specified field when it is defined as either a row field or a column field.
 void addFieldSubtotalStdDev(String fieldName)
          Includes showing subtotal as the standard deviation of all pivot values for the specified field when it is defined as either a row field or a column field.
 void addFieldSubtotalSum(String fieldName)
          Includes showing subtotal as the sum of all pivot values for the specified field when it is defined as either a row field or a column field.
 void addFieldSubtotalVar(String fieldName)
          Includes showing subtotal as the variance of all pivot values for the specified field when it is defined as either a row field or a column field.
 void addRowField(String fieldName)
          Adds a row field to the pivot table.
 void addRowFieldSubtotalCount(String fieldName)
          Includes showing subtotal as the number of records stored in the database for the specified field when it is defined as a row field.
 void addRowFieldSubtotalMax(String fieldName)
          Includes showing subtotal as the maximum value among all pivot values for the specified field when it is defined as a row field.
 void addRowFieldSubtotalMean(String fieldName)
          Includes showing subtotal as the average of all pivot values for the specified field when it is defined as a row field.
 void addRowFieldSubtotalMin(String fieldName)
          Includes showing subtotal as the minimum value among all pivot values for the specified field when it is defined as a row field.
 void addRowFieldSubtotalStdDev(String fieldName)
          Includes showing subtotal as the standard deviation of all pivot values for the specified field when it is defined as a row field.
 void addRowFieldSubtotalSum(String fieldName)
          Includes showing subtotal as the sum of all pivot values for the specified field when it is defined as a row field.
 void addRowFieldSubtotalVar(String fieldName)
          Includes showing subtotal as the variance of all pivot values for the specified field when it is defined as a row field.
 void calculateGrid()
          Calculates the pivot data.
 void clearColumnFields()
          Removes all of the column fields from the pivot table.
 void clearColumnFieldSortOrderSettings()
          Removes sorting related settings for all of the column fields.
 void clearDataColumnSortSettings()
          Removes sorting related settings for all data columns.
 void clearDataFields()
          Removes all of the data fields from the pivot table.
 void clearDataFieldSummaryTypeSettings()
          Removes summary type related settings for all data fields.
 void clearGrandTotalColumnSortSettings()
          Removes all sorting related settings on the grand total column.
 void clearRowFields()
          Removes all row fields from the pivot table.
 void clearRowFieldSortOrderSettings()
          Removes sorting related settings for all row fields.
 byte[] getAsExcel2003()
          Returns the pivot data as a byte array representing an Excel 2003 file.
 byte[] getAsExcel2003(AQDataSetSettings settings, AQChart chart)
          Returns the pivot data, with chart enabled, as a byte array representing an Excel 2003 file.
 byte[] getAsExcel2007()
          Returns the pivot data as a byte array representing an Excel 2007 file.
 byte[] getAsExcel2007(AQDataSetSettings settings, AQChart chart)
          Returns the pivot data, with chart enabled, as a byte array representing an Excel 2007 file.
 String[] getColumnFields()
          Returns column field names as an array.
 String[] getDataFields()
          Returns data field names as an array.
 AQDataSet getDataSet()
          Returns the application data used to create this pivot table.
 String getGrandTotalColumnSortName()
          Returns the data field name used to sort the grand total column.
 String[] getRowFields()
          Returns row field names as an array.
 int getSortDataColumnIndex()
          Returns the column index that is used for sorting on data column.
 boolean isCalculated()
          Returns true if the pivot data has been successfully calculated.
 boolean isColumnFieldSortAscending(String fieldName)
          Returns true if the specified column field is sorted in ascending order.
 boolean isColumnFieldSortDescending(String fieldName)
          Returns true if the specified column field is sorted in descending order.
 boolean isColumnFieldSortNone(String fieldName)
          Returns true if the values that correspond to the specified column field are present in the order defined in the application data.
 boolean isDataFieldSummaryCount(String fieldName)
          Returns true if the summary type of the specified data field is count which would show pivot grand total value as the number of records stored in the application data.
 boolean isDataFieldSummaryMax(String fieldName)
          Returns true if the summary type of the specified data field is maximum which would show pivot grand total value as the maximum value amongst all pivot values.
 boolean isDataFieldSummaryMean(String fieldName)
          Returns true if the summary type of the specified data field is mean which would show pivot grand total value as the average of all pivot values.
 boolean isDataFieldSummaryMin(String fieldName)
          Returns true if the summary type of the specified data field is minimum which would show pivot grand total value as the minimum value amongst all pivot values.
 boolean isDataFieldSummaryStdDev(String fieldName)
          Returns true if the summary type of the specified data field is standard deviation which would show pivot grand total value as the standard deviation of all pivot values.
 boolean isDataFieldSummarySum(String fieldName)
          Returns true if the summary type of the specified data field is sum which would show pivot grand total value as the sum of all pivot values.
 boolean isDataFieldSummaryVar(String fieldName)
          Returns true if the summary type of the specified data field is variance which would show pivot grand total value as the variance of all pivot values.
 boolean isRowFieldSortAscending(String fieldName)
          Returns true if the specified row field is sorted in ascending order.
 boolean isRowFieldSortDescending(String fieldName)
          Returns true if the specified row field is sorted in descending order.
 boolean isRowFieldSortNone(String fieldName)
          Returns true if the values that correspond to the specified row field are present in the order defined in the application data.
 boolean isShowGrandTotalForColumn()
          Returns true if grand totals for columns will be displayed upon rendering.
 boolean isShowGrandTotalForRow()
          Returns true if grand totals for rows will be displayed upon rendering.
 boolean isShowSubtotalForLastColumn()
          Returns true if subtotal for the last column will be shown.
 boolean isShowSubtotalForLastRow()
          Returns true if subtotal for the last row will be shown.
 boolean isShowSubtotalUsingSystemDefault()
          Returns true if subtotals for rows and columns will be calculated using system default method.
 boolean isSortByDataColumn()
          Returns true if sorting on data column is defined.
 boolean isSortByGrandTotalColumn()
          Returns true if sorting on the grand total column is defined.
 boolean isSortDataColumnAscending()
          Returns true if sorting on data column is defined and is in ascending order.
 boolean isSortDataColumnDescending()
          Returns true if sorting on data column is defined and is in descending order.
 boolean isSortGrandTotalColumnAscending()
          Returns true if sorting on the grand total column is defined and is in ascending order.
 boolean isSortGrandTotalColumnDescending()
          Returns true if sorting on the grand total column is defined and is in descending order.
 void removeColumnField(String fieldName)
          Removes a column field from the pivot table.
 void removeColumnFieldSubtotalCount(String fieldName)
          Excludes showing subtotal as the number of records stored in the database for the specified field when it is defined as a column field.
 void removeColumnFieldSubtotalMax(String fieldName)
          Excludes showing subtotal as the maximum value among all pivot values for the specified field when it is defined as a column field.
 void removeColumnFieldSubtotalMean(String fieldName)
          Excludes showing subtotal as the average of all pivot values for the specified field when it is defined as a column field.
 void removeColumnFieldSubtotalMin(String fieldName)
          Excludes showing subtotal as the minimum value among all pivot values for the specified field when it is defined as a column field.
 void removeColumnFieldSubtotalStdDev(String fieldName)
          Excludes showing subtotal as the standard deviation of all pivot values for the specified field when it is defined as a column field.
 void removeColumnFieldSubtotalSum(String fieldName)
          Excludes showing subtotal as the sum of all pivot values for the specified field when it is defined as a column field.
 void removeColumnFieldSubtotalVar(String fieldName)
          Excludes showing subtotal as the variance of all pivot values for the specified field when it is defined as a column field.
 void removeDataField(String fieldName)
          Removes a data field from the pivot table.
 void removeFieldSubtotalCount(String fieldName)
          Excludes showing subtotal as the number of records stored in the database for the specified field when it is defined as either a row field or a column field.
 void removeFieldSubtotalMax(String fieldName)
          Excludes showing subtotal as the maximum value among all pivot values for the specified field when it is defined as either a row field or a column field.
 void removeFieldSubtotalMean(String fieldName)
          Excludes showing subtotal as the average of all pivot values for the specified field when it is defined as either a row field or a column field.
 void removeFieldSubtotalMin(String fieldName)
          Excludes showing subtotal as the minimum value among all pivot values for the specified field when it is defined as either a row field or a column field.
 void removeFieldSubtotalStdDev(String fieldName)
          Excludes showing subtotal as the standard deviation of all pivot values for the specified field when it is defined as either a row field or a column field.
 void removeFieldSubtotalSum(String fieldName)
          Excludes showing subtotal as the sum of all pivot values for the specified field when it is defined as either a row field or a column field.
 void removeFieldSubtotalVar(String fieldName)
          Excludes showing subtotal as the variance of all pivot values for the specified field when it is defined as either a row field or a column field.
 void removeRowField(String fieldName)
          Removes a row field from the pivot table.
 void removeRowFieldSubtotalCount(String fieldName)
          Excludes showing subtotal as the number of records stored in the database for the specified field when it is defined as a row field.
 void removeRowFieldSubtotalMax(String fieldName)
          Excludes showing subtotal as the maximum value among all pivot values for the specified field when it is defined as a row field.
 void removeRowFieldSubtotalMean(String fieldName)
          Excludes showing subtotal as the average of all pivot values for the specified field when it is defined as a row field.
 void removeRowFieldSubtotalMin(String fieldName)
          Excludes showing subtotal as the minimum value among all pivot values for the specified field when it is defined as a row field.
 void removeRowFieldSubtotalStdDev(String fieldName)
          Excludes showing subtotal as the standard deviation of all pivot values for the specified field when it is defined as a row field.
 void removeRowFieldSubtotalSum(String fieldName)
          Excludes showing subtotal as the sum of all pivot values for the specified field when it is defined as a row field.
 void removeRowFieldSubtotalVar(String fieldName)
          Excludes showing subtotal as the variance of all pivot values for the specified field when it is defined as a row field.
 String renderHtml()
          Converts the pivot data to a HTML document using the default grid settings.
 String renderHtml(AQDataSetSettings settings)
          Converts the pivot data to a HTML document using the specified grid settings.
 String renderHtml(AQDataSetSettings settings, AQChart chart)
          Converts the pivot data to a HTML document, with chart enabled, using the specified grid settings.
 String renderText()
          Converts the pivot data to a formatted plain text grid using the default grid settings.
 String renderText(AQDataSetSettings settings)
          Converts the pivot data to a formatted plain text grid using the specified grid settings.
 String renderText(int lineCount)
          Converts the pivot data, up to lineCount rows, to a formatted plain text grid using the default grid settings.
 void saveAsExcel2003(String fileName)
          Saves the pivot data as an Excel 2003 file.
 void saveAsExcel2003(String fileName, AQDataSetSettings settings, AQChart chart)
          Saves the pivot data, with chart enabled, as an Excel 2003 file.
 void saveAsExcel2007(String fileName)
          Saves the pivot data as an Excel 2007 file.
 void saveAsExcel2007(String fileName, AQDataSetSettings settings, AQChart chart)
          Saves the pivot data, with chart enabled, as an Excel 2007 file.
 void setColumnFieldSortAscending(String fieldName)
          Sorts a column field in ascending order.
 void setColumnFieldSortDescending(String fieldName)
          Sorts a column field in descending order.
 void setColumnFieldSortNone(String fieldName)
          Sorts the values that correspond to a column field in the order defined in the application data.
 void setColumnFieldSubtotalCount(String fieldName)
          Shows subtotal as the number of records stored in the database for the specified field when it is defined as a column field.
 void setColumnFieldSubtotalDefault(String fieldName)
          Shows subtotal using system default calculation method for the specified field when it is defined as a column field.
 void setColumnFieldSubtotalMax(String fieldName)
          Shows subtotal as the maximum value among all pivot values for the specified field when it is defined as a column field.
 void setColumnFieldSubtotalMean(String fieldName)
          Shows subtotal as the average of all pivot values for the specified field when it is defined as a column field.
 void setColumnFieldSubtotalMin(String fieldName)
          Shows subtotal as the minimum value among all pivot values for the specified field when it is defined as a column field.
 void setColumnFieldSubtotalNone(String fieldName)
          Hides subtotal for the specified field when it is defined as a column field.
 void setColumnFieldSubtotalStdDev(String fieldName)
          Shows subtotal as the standard deviation of all pivot values for the specified field when it is defined as a column field.
 void setColumnFieldSubtotalSum(String fieldName)
          Shows subtotal as the sum of all pivot values for the specified field when it is defined as a column field.
 void setColumnFieldSubtotalVar(String fieldName)
          Shows subtotal as the variance of all pivot values for the specified field when it is defined as a column field.
 void setDataFieldSummaryCount(String fieldName)
          Sets the summary type for a data field to count which would show pivot grand total value as the number of records stored in the application data.
 void setDataFieldSummaryMax(String fieldName)
          Sets the summary type for a data field to maximum which would show pivot grand total value as the maximum value amongst all pivot values.
 void setDataFieldSummaryMean(String fieldName)
          Sets the summary type for a data field to mean which would show pivot grand total value as the average of all pivot values.
 void setDataFieldSummaryMin(String fieldName)
          Sets the summary type for a data field to minimum which would show pivot grand total value as the minimum value amongst all pivot values.
 void setDataFieldSummaryStdDev(String fieldName)
          Sets the summary type for a data field to standard deviation which would show pivot grand total value as the standard deviation of all pivot values.
 void setDataFieldSummarySum(String fieldName)
          Sets the summary type for a data field to sum which would show pivot grand total value as the sum of all pivot values.
 void setDataFieldSummaryVar(String fieldName)
          Sets the summary type for a data field to variance which would show pivot grand total value as the variance of all pivot values.
 void setDataSet(AQDataSet dataSet)
          Sets the application data to be presented in the pivot table.
 void setFieldSubtotalCount(String fieldName)
          Shows subtotal as the number of records stored in the database for the specified field when it is defined as either a row field or a column field.
 void setFieldSubtotalDefault(String fieldName)
          Shows subtotal using system default calculation method for the specified field when it is defined as either a row field or a column field.
 void setFieldSubtotalMax(String fieldName)
          Shows subtotal as the maximum value among all pivot values for the specified field when it is defined as either a row field or a column field.
 void setFieldSubtotalMean(String fieldName)
          Shows subtotal as the average of all pivot values for the specified field when it is defined as either a row field or a column field.
 void setFieldSubtotalMin(String fieldName)
          Shows subtotal as the minimum value among all pivot values for the specified field when it is defined as either a row field or a column field.
 void setFieldSubtotalNone(String fieldName)
          Hides subtotal for the specified field when it is defined as either a row field or a column field.
 void setFieldSubtotalStdDev(String fieldName)
          Shows subtotal as the standard deviation of all pivot values for the specified field when it is defined as either a row field or a column field.
 void setFieldSubtotalSum(String fieldName)
          Shows subtotal as the sum of all pivot values for the specified field when it is defined as either a row field or a column field.
 void setFieldSubtotalVar(String fieldName)
          Shows subtotal as the variance of all pivot values for the specified field when it is defined as either a row field or a column field.
 void setRowFieldSortAscending(String fieldName)
          Sorts a row field in ascending order.
 void setRowFieldSortDescending(String fieldName)
          Sorts a row field in descending order.
 void setRowFieldSortNone(String fieldName)
          Sorts the values that correspond to a row field in the order defined in the application data.
 void setRowFieldSubtotalCount(String fieldName)
          Shows subtotal as the number of records stored in the database for the specified field when it is defined as a row field.
 void setRowFieldSubtotalDefault(String fieldName)
          Shows subtotal using system default calculation method for the specified field when it is defined as a row field.
 void setRowFieldSubtotalMax(String fieldName)
          Shows subtotal as the maximum value among all pivot values for the specified field when it is defined as a row field.
 void setRowFieldSubtotalMean(String fieldName)
          Shows subtotal as the average of all pivot values for the specified field when it is defined as a row field.
 void setRowFieldSubtotalMin(String fieldName)
          Shows subtotal as the minimum value among all pivot values for the specified field when it is defined as a row field.
 void setRowFieldSubtotalNone(String fieldName)
          Hides subtotal for the specified field when it is defined as a row field.
 void setRowFieldSubtotalStdDev(String fieldName)
          Shows subtotal as the standard deviation of all pivot values for the specified field when it is defined as a row field.
 void setRowFieldSubtotalSum(String fieldName)
          Shows subtotal as the sum of all pivot values for the specified field when it is defined as a row field.
 void setRowFieldSubtotalVar(String fieldName)
          Shows subtotal as the variance of all pivot values for the specified field when it is defined as a row field.
 void setShowSubtotal(boolean flag)
          Shows subtotals for rows and columns using system default calculation method, or clears previous subtotal settings for all of rows and columns.
 void setShowSubtotalForLastColumn(boolean flag)
          Shows or hides the subtotal for the last column.
 void setShowSubtotalForLastRow(boolean flag)
          Shows or hides the subtotal for the last row.
 void setShowSubtotalForLastRowAndColumn(boolean flag)
          Shows or hides subtotals for the last row and the last column.
 void sortDataColumnAscending(int columnIndex)
          Sorts pivot values belong to the specified column in ascending order.
 void sortDataColumnDescending(int columnIndex)
          Sorts pivot values belong to the specified column in descending order.
 void sortGrandTotalColumnAscending(String dataFieldName)
          Sorts values belong to the grand total column associated with the specified data field in ascending order.
 void sortGrandTotalColumnDescending(String dataFieldName)
          Sorts values belong to the grand total column associated with the specified data field in descending order.
 void unsetColumnFieldSortOrder(String fieldName)
          Unsets the sorting order corresponding to the specified column field.
 void unsetDataFieldSummaryType(String fieldName)
          Unsets the summary type corresponding to the specified data field.
 void unsetRowFieldSortOrder(String fieldName)
          Unsets the sorting order corresponding to the specified row field.
 

Method Detail

setDataSet

void setDataSet(AQDataSet dataSet)
Sets the application data to be presented in the pivot table.

Parameters:
dataSet - the application data

getDataSet

AQDataSet getDataSet()
Returns the application data used to create this pivot table.

Returns:
the application data used to create this pivot table

isShowGrandTotalForRow

boolean isShowGrandTotalForRow()
Returns true if grand totals for rows will be displayed upon rendering.

Returns:
true if to show grand totals for rows.

isShowGrandTotalForColumn

boolean isShowGrandTotalForColumn()
Returns true if grand totals for columns will be displayed upon rendering.

Returns:
true if to show grand totals for columns.

addRowField

void addRowField(String fieldName)
Adds a row field to the pivot table.

Parameters:
fieldName - the name of the row field to be added

removeRowField

void removeRowField(String fieldName)
Removes a row field from the pivot table.

Parameters:
fieldName - the name of the row field to be removed

getRowFields

String[] getRowFields()
Returns row field names as an array.

Returns:
an array of row field names, or an empty array if no row fields defined.

clearRowFields

void clearRowFields()
Removes all row fields from the pivot table.


addColumnField

void addColumnField(String fieldName)
Adds a column field to the pivot table.

Parameters:
fieldName - the name of the column field to be added

removeColumnField

void removeColumnField(String fieldName)
Removes a column field from the pivot table.

Parameters:
fieldName - the name of the column field to be removed

getColumnFields

String[] getColumnFields()
Returns column field names as an array.

Returns:
an array of column field names, or an empty array if no column fields defined.

clearColumnFields

void clearColumnFields()
Removes all of the column fields from the pivot table.


addDataField

void addDataField(String fieldName)
Adds a data field to the pivot table.

Parameters:
fieldName - the name of the data field to be added

removeDataField

void removeDataField(String fieldName)
Removes a data field from the pivot table.

Parameters:
fieldName - the name of the data field to be removed

getDataFields

String[] getDataFields()
Returns data field names as an array.

Returns:
an array of data field names, or an empty array if no data fields defined.

clearDataFields

void clearDataFields()
Removes all of the data fields from the pivot table.


setRowFieldSortAscending

void setRowFieldSortAscending(String fieldName)
Sorts a row field in ascending order. This method will override the column sorting setting defined by data column and grand total column if the field name specified is the last row field.

Parameters:
fieldName - the name of the row field to which sorting order to be set

setRowFieldSortDescending

void setRowFieldSortDescending(String fieldName)
Sorts a row field in descending order. This method will override the column sorting setting defined by data column and grand total column if the field name specified is the last row field.

Parameters:
fieldName - the name of the row field to which sorting order to be set

setRowFieldSortNone

void setRowFieldSortNone(String fieldName)
Sorts the values that correspond to a row field in the order defined in the application data. This method will override the column sorting setting defined by data column and grand total column if the field name specified is the last row field.

Parameters:
fieldName - the name of the row field to which sorting order to be set

isRowFieldSortAscending

boolean isRowFieldSortAscending(String fieldName)
Returns true if the specified row field is sorted in ascending order.

Parameters:
fieldName - the name of the row field
Returns:
true if sorted in ascending order

isRowFieldSortDescending

boolean isRowFieldSortDescending(String fieldName)
Returns true if the specified row field is sorted in descending order.

Parameters:
fieldName - the name of the row field
Returns:
true if sorted in descending order

isRowFieldSortNone

boolean isRowFieldSortNone(String fieldName)
Returns true if the values that correspond to the specified row field are present in the order defined in the application data.

Parameters:
fieldName - the name of the row field
Returns:
true if corresponding values are present in the order defined in the application data

unsetRowFieldSortOrder

void unsetRowFieldSortOrder(String fieldName)
Unsets the sorting order corresponding to the specified row field. Row fields are sorted in ascending order by default if custom settings are not defined.

Parameters:
fieldName - the name of the row field from which sorting order to be unset

clearRowFieldSortOrderSettings

void clearRowFieldSortOrderSettings()
Removes sorting related settings for all row fields.


setColumnFieldSortAscending

void setColumnFieldSortAscending(String fieldName)
Sorts a column field in ascending order.

Parameters:
fieldName - the name of the column field to which sorting order to be set

setColumnFieldSortDescending

void setColumnFieldSortDescending(String fieldName)
Sorts a column field in descending order.

Parameters:
fieldName - the name of the column field to which sorting order to be set

setColumnFieldSortNone

void setColumnFieldSortNone(String fieldName)
Sorts the values that correspond to a column field in the order defined in the application data.

Parameters:
fieldName - the name of the column field to which sorting order to be set

isColumnFieldSortAscending

boolean isColumnFieldSortAscending(String fieldName)
Returns true if the specified column field is sorted in ascending order.

Parameters:
fieldName - the name of the column field
Returns:
true if sorted in ascending order

isColumnFieldSortDescending

boolean isColumnFieldSortDescending(String fieldName)
Returns true if the specified column field is sorted in descending order.

Parameters:
fieldName - the name of the column field
Returns:
true if sorted in descending order

isColumnFieldSortNone

boolean isColumnFieldSortNone(String fieldName)
Returns true if the values that correspond to the specified column field are present in the order defined in the application data.

Parameters:
fieldName - the name of the column field
Returns:
true if corresponding values are present in the order defined in the application data

unsetColumnFieldSortOrder

void unsetColumnFieldSortOrder(String fieldName)
Unsets the sorting order corresponding to the specified column field. Column fields are sorted in ascending order by default if custom settings are not defined.

Parameters:
fieldName - the name of the column field from which sorting order to be unset

clearColumnFieldSortOrderSettings

void clearColumnFieldSortOrderSettings()
Removes sorting related settings for all of the column fields.


sortGrandTotalColumnAscending

void sortGrandTotalColumnAscending(String dataFieldName)
Sorts values belong to the grand total column associated with the specified data field in ascending order. If the specified dataFieldName is an empty string, i.e. a string with length equals zero, then all of values contained in the grand total column will be sorted in ascending order if there are no data fields defined. This method will override the column sorting setting defined by data column and disable the sorting on the last row field.

Parameters:
dataFieldName - the data field name

sortGrandTotalColumnDescending

void sortGrandTotalColumnDescending(String dataFieldName)
Sorts values belong to the grand total column associated with the specified data field in descending order. If the specified dataFieldName is an empty string, i.e. a string with length equals zero, then all of values contained in the grand total column will be sorted in descending order if there are no data fields defined. This method will override the column sorting setting defined by data column and disable the sorting on the last row field.

Parameters:
dataFieldName - the data field name

isSortByGrandTotalColumn

boolean isSortByGrandTotalColumn()
Returns true if sorting on the grand total column is defined.

Returns:
true if sorting on the grand total column is defined.

isSortGrandTotalColumnAscending

boolean isSortGrandTotalColumnAscending()
Returns true if sorting on the grand total column is defined and is in ascending order. Note that this method cannot be used alone to determine whether sorting on the grand total column is defined and is in descending order.

Returns:
true if sorting on the grand total column is defined and is in ascending order

isSortGrandTotalColumnDescending

boolean isSortGrandTotalColumnDescending()
Returns true if sorting on the grand total column is defined and is in descending order. Note that this method cannot be used alone to determine whether sorting on the grand total column is defined and is in ascending order.

Returns:
true if sorting on the grand total column is defined and is in descending order

getGrandTotalColumnSortName

String getGrandTotalColumnSortName()
Returns the data field name used to sort the grand total column.

Returns:
the data field name used to sort the grand total column if sorting on the grand total column is defined; otherwise, null is returned

clearGrandTotalColumnSortSettings

void clearGrandTotalColumnSortSettings()
Removes all sorting related settings on the grand total column.


setShowSubtotal

void setShowSubtotal(boolean flag)
Shows subtotals for rows and columns using system default calculation method, or clears previous subtotal settings for all of rows and columns. The default method used to calculate subtotal would calculate the sum of all pivot values. Subtotals are not displayed by default.

Parameters:
flag - the boolean value that determines whether to show or clear subtotals

isShowSubtotalUsingSystemDefault

boolean isShowSubtotalUsingSystemDefault()
Returns true if subtotals for rows and columns will be calculated using system default method.

Returns:
true if to calculate subtotals for rows and columns using system default method

setShowSubtotalForLastRowAndColumn

void setShowSubtotalForLastRowAndColumn(boolean flag)
Shows or hides subtotals for the last row and the last column. By default, subtotals for the last row and the last column are not shown.

Parameters:
flag - the boolean value that determines whether to show or hide subtotals for the last row and the last column

setShowSubtotalForLastRow

void setShowSubtotalForLastRow(boolean flag)
Shows or hides the subtotal for the last row. By default, the subtotal for the last row is not shown.

Parameters:
flag - the boolean value that determines whether to show or hide the subtotal for the last row

setShowSubtotalForLastColumn

void setShowSubtotalForLastColumn(boolean flag)
Shows or hides the subtotal for the last column. By default, the subtotal for the last column is not shown.

Parameters:
flag - the boolean value that determines whether to show or hide the subtotal for the last column

isShowSubtotalForLastRow

boolean isShowSubtotalForLastRow()
Returns true if subtotal for the last row will be shown.

Returns:
true if subtotal for the last row will be shown.

isShowSubtotalForLastColumn

boolean isShowSubtotalForLastColumn()
Returns true if subtotal for the last column will be shown.

Returns:
true if subtotal for the last column will be shown.

setFieldSubtotalNone

void setFieldSubtotalNone(String fieldName)
Hides subtotal for the specified field when it is defined as either a row field or a column field.

Parameters:
fieldName - the field name

setFieldSubtotalDefault

void setFieldSubtotalDefault(String fieldName)
Shows subtotal using system default calculation method for the specified field when it is defined as either a row field or a column field. The default method used to calculate subtotal would calculate the sum of all pivot values.

Parameters:
fieldName - the field name

setFieldSubtotalSum

void setFieldSubtotalSum(String fieldName)
Shows subtotal as the sum of all pivot values for the specified field when it is defined as either a row field or a column field.

Parameters:
fieldName - the field name

setFieldSubtotalMax

void setFieldSubtotalMax(String fieldName)
Shows subtotal as the maximum value among all pivot values for the specified field when it is defined as either a row field or a column field.

Parameters:
fieldName - the field name

setFieldSubtotalMin

void setFieldSubtotalMin(String fieldName)
Shows subtotal as the minimum value among all pivot values for the specified field when it is defined as either a row field or a column field.

Parameters:
fieldName - the field name

setFieldSubtotalMean

void setFieldSubtotalMean(String fieldName)
Shows subtotal as the average of all pivot values for the specified field when it is defined as either a row field or a column field.

Parameters:
fieldName - the field name

setFieldSubtotalVar

void setFieldSubtotalVar(String fieldName)
Shows subtotal as the variance of all pivot values for the specified field when it is defined as either a row field or a column field.

Parameters:
fieldName - the field name

setFieldSubtotalStdDev

void setFieldSubtotalStdDev(String fieldName)
Shows subtotal as the standard deviation of all pivot values for the specified field when it is defined as either a row field or a column field.

Parameters:
fieldName - the field name

setFieldSubtotalCount

void setFieldSubtotalCount(String fieldName)
Shows subtotal as the number of records stored in the database for the specified field when it is defined as either a row field or a column field.

Parameters:
fieldName - the field name

addFieldSubtotalSum

void addFieldSubtotalSum(String fieldName)
Includes showing subtotal as the sum of all pivot values for the specified field when it is defined as either a row field or a column field.

Parameters:
fieldName - the field name

addFieldSubtotalMax

void addFieldSubtotalMax(String fieldName)
Includes showing subtotal as the maximum value among all pivot values for the specified field when it is defined as either a row field or a column field.

Parameters:
fieldName - the field name

addFieldSubtotalMin

void addFieldSubtotalMin(String fieldName)
Includes showing subtotal as the minimum value among all pivot values for the specified field when it is defined as either a row field or a column field.

Parameters:
fieldName - the field name

addFieldSubtotalMean

void addFieldSubtotalMean(String fieldName)
Includes showing subtotal as the average of all pivot values for the specified field when it is defined as either a row field or a column field.

Parameters:
fieldName - the field name

addFieldSubtotalVar

void addFieldSubtotalVar(String fieldName)
Includes showing subtotal as the variance of all pivot values for the specified field when it is defined as either a row field or a column field.

Parameters:
fieldName - the field name

addFieldSubtotalStdDev

void addFieldSubtotalStdDev(String fieldName)
Includes showing subtotal as the standard deviation of all pivot values for the specified field when it is defined as either a row field or a column field.

Parameters:
fieldName - the field name

addFieldSubtotalCount

void addFieldSubtotalCount(String fieldName)
Includes showing subtotal as the number of records stored in the database for the specified field when it is defined as either a row field or a column field.

Parameters:
fieldName - the field name

removeFieldSubtotalSum

void removeFieldSubtotalSum(String fieldName)
Excludes showing subtotal as the sum of all pivot values for the specified field when it is defined as either a row field or a column field.

Parameters:
fieldName - the field name

removeFieldSubtotalMax

void removeFieldSubtotalMax(String fieldName)
Excludes showing subtotal as the maximum value among all pivot values for the specified field when it is defined as either a row field or a column field.

Parameters:
fieldName - the field name

removeFieldSubtotalMin

void removeFieldSubtotalMin(String fieldName)
Excludes showing subtotal as the minimum value among all pivot values for the specified field when it is defined as either a row field or a column field.

Parameters:
fieldName - the field name

removeFieldSubtotalMean

void removeFieldSubtotalMean(String fieldName)
Excludes showing subtotal as the average of all pivot values for the specified field when it is defined as either a row field or a column field.

Parameters:
fieldName - the field name

removeFieldSubtotalVar

void removeFieldSubtotalVar(String fieldName)
Excludes showing subtotal as the variance of all pivot values for the specified field when it is defined as either a row field or a column field.

Parameters:
fieldName - the field name

removeFieldSubtotalStdDev

void removeFieldSubtotalStdDev(String fieldName)
Excludes showing subtotal as the standard deviation of all pivot values for the specified field when it is defined as either a row field or a column field.

Parameters:
fieldName - the field name

removeFieldSubtotalCount

void removeFieldSubtotalCount(String fieldName)
Excludes showing subtotal as the number of records stored in the database for the specified field when it is defined as either a row field or a column field.

Parameters:
fieldName - the field name

setRowFieldSubtotalNone

void setRowFieldSubtotalNone(String fieldName)
Hides subtotal for the specified field when it is defined as a row field.

Parameters:
fieldName - the field name

setRowFieldSubtotalDefault

void setRowFieldSubtotalDefault(String fieldName)
Shows subtotal using system default calculation method for the specified field when it is defined as a row field. The default method used to calculate subtotal would calculate the sum of all pivot values.

Parameters:
fieldName - the field name

setRowFieldSubtotalSum

void setRowFieldSubtotalSum(String fieldName)
Shows subtotal as the sum of all pivot values for the specified field when it is defined as a row field.

Parameters:
fieldName - the field name

setRowFieldSubtotalMax

void setRowFieldSubtotalMax(String fieldName)
Shows subtotal as the maximum value among all pivot values for the specified field when it is defined as a row field.

Parameters:
fieldName - the field name

setRowFieldSubtotalMin

void setRowFieldSubtotalMin(String fieldName)
Shows subtotal as the minimum value among all pivot values for the specified field when it is defined as a row field.

Parameters:
fieldName - the field name

setRowFieldSubtotalMean

void setRowFieldSubtotalMean(String fieldName)
Shows subtotal as the average of all pivot values for the specified field when it is defined as a row field.

Parameters:
fieldName - the field name

setRowFieldSubtotalVar

void setRowFieldSubtotalVar(String fieldName)
Shows subtotal as the variance of all pivot values for the specified field when it is defined as a row field.

Parameters:
fieldName - the field name

setRowFieldSubtotalStdDev

void setRowFieldSubtotalStdDev(String fieldName)
Shows subtotal as the standard deviation of all pivot values for the specified field when it is defined as a row field.

Parameters:
fieldName - the field name

setRowFieldSubtotalCount

void setRowFieldSubtotalCount(String fieldName)
Shows subtotal as the number of records stored in the database for the specified field when it is defined as a row field.

Parameters:
fieldName - the field name

addRowFieldSubtotalSum

void addRowFieldSubtotalSum(String fieldName)
Includes showing subtotal as the sum of all pivot values for the specified field when it is defined as a row field.

Parameters:
fieldName - the field name

addRowFieldSubtotalMax

void addRowFieldSubtotalMax(String fieldName)
Includes showing subtotal as the maximum value among all pivot values for the specified field when it is defined as a row field.

Parameters:
fieldName - the field name

addRowFieldSubtotalMin

void addRowFieldSubtotalMin(String fieldName)
Includes showing subtotal as the minimum value among all pivot values for the specified field when it is defined as a row field.

Parameters:
fieldName - the field name

addRowFieldSubtotalMean

void addRowFieldSubtotalMean(String fieldName)
Includes showing subtotal as the average of all pivot values for the specified field when it is defined as a row field.

Parameters:
fieldName - the field name

addRowFieldSubtotalVar

void addRowFieldSubtotalVar(String fieldName)
Includes showing subtotal as the variance of all pivot values for the specified field when it is defined as a row field.

Parameters:
fieldName - the field name

addRowFieldSubtotalStdDev

void addRowFieldSubtotalStdDev(String fieldName)
Includes showing subtotal as the standard deviation of all pivot values for the specified field when it is defined as a row field.

Parameters:
fieldName - the field name

addRowFieldSubtotalCount

void addRowFieldSubtotalCount(String fieldName)
Includes showing subtotal as the number of records stored in the database for the specified field when it is defined as a row field.

Parameters:
fieldName - the field name

removeRowFieldSubtotalSum

void removeRowFieldSubtotalSum(String fieldName)
Excludes showing subtotal as the sum of all pivot values for the specified field when it is defined as a row field.

Parameters:
fieldName - the field name

removeRowFieldSubtotalMax

void removeRowFieldSubtotalMax(String fieldName)
Excludes showing subtotal as the maximum value among all pivot values for the specified field when it is defined as a row field.

Parameters:
fieldName - the field name

removeRowFieldSubtotalMin

void removeRowFieldSubtotalMin(String fieldName)
Excludes showing subtotal as the minimum value among all pivot values for the specified field when it is defined as a row field.

Parameters:
fieldName - the field name

removeRowFieldSubtotalMean

void removeRowFieldSubtotalMean(String fieldName)
Excludes showing subtotal as the average of all pivot values for the specified field when it is defined as a row field.

Parameters:
fieldName - the field name

removeRowFieldSubtotalVar

void removeRowFieldSubtotalVar(String fieldName)
Excludes showing subtotal as the variance of all pivot values for the specified field when it is defined as a row field.

Parameters:
fieldName - the field name

removeRowFieldSubtotalStdDev

void removeRowFieldSubtotalStdDev(String fieldName)
Excludes showing subtotal as the standard deviation of all pivot values for the specified field when it is defined as a row field.

Parameters:
fieldName - the field name

removeRowFieldSubtotalCount

void removeRowFieldSubtotalCount(String fieldName)
Excludes showing subtotal as the number of records stored in the database for the specified field when it is defined as a row field.

Parameters:
fieldName - the field name

setColumnFieldSubtotalNone

void setColumnFieldSubtotalNone(String fieldName)
Hides subtotal for the specified field when it is defined as a column field.

Parameters:
fieldName - the field name

setColumnFieldSubtotalDefault

void setColumnFieldSubtotalDefault(String fieldName)
Shows subtotal using system default calculation method for the specified field when it is defined as a column field. The default method used to calculate subtotal would calculate the sum of all pivot values.

Parameters:
fieldName - the field name

setColumnFieldSubtotalSum

void setColumnFieldSubtotalSum(String fieldName)
Shows subtotal as the sum of all pivot values for the specified field when it is defined as a column field.

Parameters:
fieldName - the field name

setColumnFieldSubtotalMax

void setColumnFieldSubtotalMax(String fieldName)
Shows subtotal as the maximum value among all pivot values for the specified field when it is defined as a column field.

Parameters:
fieldName - the field name

setColumnFieldSubtotalMin

void setColumnFieldSubtotalMin(String fieldName)
Shows subtotal as the minimum value among all pivot values for the specified field when it is defined as a column field.

Parameters:
fieldName - the field name

setColumnFieldSubtotalMean

void setColumnFieldSubtotalMean(String fieldName)
Shows subtotal as the average of all pivot values for the specified field when it is defined as a column field.

Parameters:
fieldName - the field name

setColumnFieldSubtotalVar

void setColumnFieldSubtotalVar(String fieldName)
Shows subtotal as the variance of all pivot values for the specified field when it is defined as a column field.

Parameters:
fieldName - the field name

setColumnFieldSubtotalStdDev

void setColumnFieldSubtotalStdDev(String fieldName)
Shows subtotal as the standard deviation of all pivot values for the specified field when it is defined as a column field.

Parameters:
fieldName - the field name

setColumnFieldSubtotalCount

void setColumnFieldSubtotalCount(String fieldName)
Shows subtotal as the number of records stored in the database for the specified field when it is defined as a column field.

Parameters:
fieldName - the field name

addColumnFieldSubtotalSum

void addColumnFieldSubtotalSum(String fieldName)
Includes showing subtotal as the sum of all pivot values for the specified field when it is defined as a column field.

Parameters:
fieldName - the field name

addColumnFieldSubtotalMax

void addColumnFieldSubtotalMax(String fieldName)
Includes showing subtotal as the maximum value among all pivot values for the specified field when it is defined as a column field.

Parameters:
fieldName - the field name

addColumnFieldSubtotalMin

void addColumnFieldSubtotalMin(String fieldName)
Includes showing subtotal as the minimum value among all pivot values for the specified field when it is defined as a column field.

Parameters:
fieldName - the field name

addColumnFieldSubtotalMean

void addColumnFieldSubtotalMean(String fieldName)
Includes showing subtotal as the average of all pivot values for the specified field when it is defined as a column field.

Parameters:
fieldName - the field name

addColumnFieldSubtotalVar

void addColumnFieldSubtotalVar(String fieldName)
Includes showing subtotal as the variance of all pivot values for the specified field when it is defined as a column field.

Parameters:
fieldName - the field name

addColumnFieldSubtotalStdDev

void addColumnFieldSubtotalStdDev(String fieldName)
Includes showing subtotal as the standard deviation of all pivot values for the specified field when it is defined as a column field.

Parameters:
fieldName - the field name

addColumnFieldSubtotalCount

void addColumnFieldSubtotalCount(String fieldName)
Includes showing subtotal as the number of records stored in the database for the specified field when it is defined as a column field.

Parameters:
fieldName - the field name

removeColumnFieldSubtotalSum

void removeColumnFieldSubtotalSum(String fieldName)
Excludes showing subtotal as the sum of all pivot values for the specified field when it is defined as a column field.

Parameters:
fieldName - the field name

removeColumnFieldSubtotalMax

void removeColumnFieldSubtotalMax(String fieldName)
Excludes showing subtotal as the maximum value among all pivot values for the specified field when it is defined as a column field.

Parameters:
fieldName - the field name

removeColumnFieldSubtotalMin

void removeColumnFieldSubtotalMin(String fieldName)
Excludes showing subtotal as the minimum value among all pivot values for the specified field when it is defined as a column field.

Parameters:
fieldName - the field name

removeColumnFieldSubtotalMean

void removeColumnFieldSubtotalMean(String fieldName)
Excludes showing subtotal as the average of all pivot values for the specified field when it is defined as a column field.

Parameters:
fieldName - the field name

removeColumnFieldSubtotalVar

void removeColumnFieldSubtotalVar(String fieldName)
Excludes showing subtotal as the variance of all pivot values for the specified field when it is defined as a column field.

Parameters:
fieldName - the field name

removeColumnFieldSubtotalStdDev

void removeColumnFieldSubtotalStdDev(String fieldName)
Excludes showing subtotal as the standard deviation of all pivot values for the specified field when it is defined as a column field.

Parameters:
fieldName - the field name

removeColumnFieldSubtotalCount

void removeColumnFieldSubtotalCount(String fieldName)
Excludes showing subtotal as the number of records stored in the database for the specified field when it is defined as a column field.

Parameters:
fieldName - the field name

sortDataColumnAscending

void sortDataColumnAscending(int columnIndex)
Sorts pivot values belong to the specified column in ascending order. This method will override the column sorting setting defined by grand total column and disable the sorting on the last row field.

Parameters:
columnIndex - the column index where sorting to be applied; index is zero-based

sortDataColumnDescending

void sortDataColumnDescending(int columnIndex)
Sorts pivot values belong to the specified column in descending order. This method will override the column sorting setting defined by grand total column and disable the sorting on the last row field.

Parameters:
columnIndex - the column index where sorting to be applied; index is zero-based

getSortDataColumnIndex

int getSortDataColumnIndex()
Returns the column index that is used for sorting on data column.

Returns:
the column index, or -1 if sorting on data column is not defined

isSortByDataColumn

boolean isSortByDataColumn()
Returns true if sorting on data column is defined.

Returns:
true if sorting on data column is defined.

isSortDataColumnAscending

boolean isSortDataColumnAscending()
Returns true if sorting on data column is defined and is in ascending order. Note that this method cannot be used alone to determine whether sorting on data column is defined and is in descending order.

Returns:
true if sorting on data column is defined and is in ascending order

isSortDataColumnDescending

boolean isSortDataColumnDescending()
Returns true if sorting on data column is defined and is in descending order. Note that this method cannot be used alone to determine whether sorting on data column is defined and is in ascending order.

Returns:
true if sorting on data column is defined and is in descending order

clearDataColumnSortSettings

void clearDataColumnSortSettings()
Removes sorting related settings for all data columns.


setDataFieldSummarySum

void setDataFieldSummarySum(String fieldName)
Sets the summary type for a data field to sum which would show pivot grand total value as the sum of all pivot values.

Parameters:
fieldName - the name of the data field to which summary type to be set

setDataFieldSummaryMax

void setDataFieldSummaryMax(String fieldName)
Sets the summary type for a data field to maximum which would show pivot grand total value as the maximum value amongst all pivot values.

Parameters:
fieldName - the name of the data field to which summary type to be set

setDataFieldSummaryMin

void setDataFieldSummaryMin(String fieldName)
Sets the summary type for a data field to minimum which would show pivot grand total value as the minimum value amongst all pivot values.

Parameters:
fieldName - the name of the data field to which summary type to be set

setDataFieldSummaryMean

void setDataFieldSummaryMean(String fieldName)
Sets the summary type for a data field to mean which would show pivot grand total value as the average of all pivot values.

Parameters:
fieldName - the name of the data field to which summary type to be set

setDataFieldSummaryVar

void setDataFieldSummaryVar(String fieldName)
Sets the summary type for a data field to variance which would show pivot grand total value as the variance of all pivot values.

Parameters:
fieldName - the name of the data field to which summary type to be set

setDataFieldSummaryStdDev

void setDataFieldSummaryStdDev(String fieldName)
Sets the summary type for a data field to standard deviation which would show pivot grand total value as the standard deviation of all pivot values.

Parameters:
fieldName - the name of the data field to which summary type to be set

setDataFieldSummaryCount

void setDataFieldSummaryCount(String fieldName)
Sets the summary type for a data field to count which would show pivot grand total value as the number of records stored in the application data.

Parameters:
fieldName - the name of the data field to which summary type to be set

isDataFieldSummarySum

boolean isDataFieldSummarySum(String fieldName)
Returns true if the summary type of the specified data field is sum which would show pivot grand total value as the sum of all pivot values.

Parameters:
fieldName - the name of the data field
Returns:
true if the summary type is sum

isDataFieldSummaryMax

boolean isDataFieldSummaryMax(String fieldName)
Returns true if the summary type of the specified data field is maximum which would show pivot grand total value as the maximum value amongst all pivot values.

Parameters:
fieldName - the name of the data field
Returns:
true if the summary type is maximum

isDataFieldSummaryMin

boolean isDataFieldSummaryMin(String fieldName)
Returns true if the summary type of the specified data field is minimum which would show pivot grand total value as the minimum value amongst all pivot values.

Parameters:
fieldName - the name of the data field
Returns:
true if the summary type is minimum

isDataFieldSummaryMean

boolean isDataFieldSummaryMean(String fieldName)
Returns true if the summary type of the specified data field is mean which would show pivot grand total value as the average of all pivot values.

Parameters:
fieldName - the name of the data field
Returns:
true if the summary type is mean

isDataFieldSummaryVar

boolean isDataFieldSummaryVar(String fieldName)
Returns true if the summary type of the specified data field is variance which would show pivot grand total value as the variance of all pivot values.

Parameters:
fieldName - the name of the data field
Returns:
true if the summary type is variance

isDataFieldSummaryStdDev

boolean isDataFieldSummaryStdDev(String fieldName)
Returns true if the summary type of the specified data field is standard deviation which would show pivot grand total value as the standard deviation of all pivot values.

Parameters:
fieldName - the name of the data field
Returns:
true if the summary type is standard deviation;

isDataFieldSummaryCount

boolean isDataFieldSummaryCount(String fieldName)
Returns true if the summary type of the specified data field is count which would show pivot grand total value as the number of records stored in the application data.

Parameters:
fieldName - the name of the data field
Returns:
true if the summary type is count

unsetDataFieldSummaryType

void unsetDataFieldSummaryType(String fieldName)
Unsets the summary type corresponding to the specified data field. The summary type of a data field is set to sum by default if custom setting is not defined, please see setDataFieldSummarySum(String fieldName) for more information.

Parameters:
fieldName - the name of the data field from which summary type to be unset

clearDataFieldSummaryTypeSettings

void clearDataFieldSummaryTypeSettings()
Removes summary type related settings for all data fields.


calculateGrid

void calculateGrid()
                   throws Exception
Calculates the pivot data. The previously calculated pivot data will be lost if the calculation failed. Please note that setting changes made after the invocation of this method will not affect the pivot data just being calculated. For new setting changes to take effect, this method needs to be re-invoked.

Throws:
Exception - if pivot data cannot be calculated due to incorrect settings

isCalculated

boolean isCalculated()
Returns true if the pivot data has been successfully calculated.

Returns:
true if the pivot data has been successfully calculated.

renderText

String renderText()
                  throws Exception
Converts the pivot data to a formatted plain text grid using the default grid settings.

Returns:
a String containing the formatted grid
Throws:
Exception - if the pivot data has not been calculated

renderText

String renderText(int lineCount)
                  throws Exception
Converts the pivot data, up to lineCount rows, to a formatted plain text grid using the default grid settings.

Parameters:
lineCount - the maximum number of rows to display
Returns:
a String containing the formatted grid
Throws:
Exception - if the pivot data has not been calculated

renderText

String renderText(AQDataSetSettings settings)
                  throws Exception
Converts the pivot data to a formatted plain text grid using the specified grid settings.

Parameters:
settings - a grid settings
Returns:
a String containing the formatted grid
Throws:
Exception - if the pivot data has not been calculated

renderHtml

String renderHtml(AQDataSetSettings settings)
                  throws Exception
Converts the pivot data to a HTML document using the specified grid settings.

Parameters:
settings - a grid settings
Returns:
a String containing the generated HTML document
Throws:
Exception - if the pivot data has not been calculated

renderHtml

String renderHtml(AQDataSetSettings settings,
                  AQChart chart)
                  throws Exception
Converts the pivot data to a HTML document, with chart enabled, using the specified grid settings.

Parameters:
settings - a grid settings
chart - an object that describes how chart to be presented; ignored if null
Returns:
a String containing the generated HTML document
Throws:
Exception - if the pivot data has not been calculated

renderHtml

String renderHtml()
                  throws Exception
Converts the pivot data to a HTML document using the default grid settings.

Returns:
a String containing the generated HTML document
Throws:
Exception - if the pivot data has not been calculated

saveAsExcel2003

void saveAsExcel2003(String fileName)
                     throws Exception
Saves the pivot data as an Excel 2003 file. If the specified file already exists, it will be overridden.

Parameters:
fileName - the name of the file where the pivot data to be saved
Throws:
Exception

saveAsExcel2003

void saveAsExcel2003(String fileName,
                     AQDataSetSettings settings,
                     AQChart chart)
                     throws Exception
Saves the pivot data, with chart enabled, as an Excel 2003 file. If the specified file already exists, it will be overridden.

Parameters:
fileName - the name of the file where the pivot data to be saved
settings - a data set settings, default settings are used if null
chart - an object that describes how chart to be presented; ignored if null
Throws:
Exception

getAsExcel2003

byte[] getAsExcel2003()
                      throws Exception
Returns the pivot data as a byte array representing an Excel 2003 file.

Throws:
Exception

getAsExcel2003

byte[] getAsExcel2003(AQDataSetSettings settings,
                      AQChart chart)
                      throws Exception
Returns the pivot data, with chart enabled, as a byte array representing an Excel 2003 file.

Parameters:
settings - a data set settings, default settings are used if null
chart - an object that describes how chart to be presented; ignored if null
Throws:
Exception

saveAsExcel2007

void saveAsExcel2007(String fileName)
                     throws Exception
Saves the pivot data as an Excel 2007 file. If the specified file already exists, it will be overridden.

Parameters:
fileName - the name of the file where the pivot data to be saved
Throws:
Exception

saveAsExcel2007

void saveAsExcel2007(String fileName,
                     AQDataSetSettings settings,
                     AQChart chart)
                     throws Exception
Saves the pivot data, with chart enabled, as an Excel 2007 file. If the specified file already exists, it will be overridden.

Parameters:
fileName - the name of the file where the pivot data to be saved
settings - a data set settings, default settings are used if null
chart - an object that describes how chart to be presented; ignored if null
Throws:
Exception

getAsExcel2007

byte[] getAsExcel2007()
                      throws Exception
Returns the pivot data as a byte array representing an Excel 2007 file.

Throws:
Exception

getAsExcel2007

byte[] getAsExcel2007(AQDataSetSettings settings,
                      AQChart chart)
                      throws Exception
Returns the pivot data, with chart enabled, as a byte array representing an Excel 2007 file.

Parameters:
settings - a data set settings, default settings are used if null
chart - an object that describes how chart to be presented; ignored if null
Throws:
Exception

OpenAPI 1.0


Copyright © 2010 AquaFold, Inc. All Rights Reserved. Use is subject to license terms.