com.canto.cumulus.server.esp.modules.reportgenerator

Interface ResultData2D

public interface ResultData2D

The interface required to be implemented by a report result generated by a report generator plugin. This returns general information about a 2D table of objects.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ResultData2D.ResultData2DRow Interface of a 2D result table row.

Method Summary

Methods

Modifier and Type	Method and Description
java.text.Format	getCellFormat(int columnIndex) Get a format to be used for rendering a value object of the given column as text.
javax.swing.table.TableCellRenderer	getCellRenderer(int columnIndex) Return a renderer for rendering a value of the given column.
java.lang.Class	getColumnClass(int columnIndex) Return the object class of values in the given column.
java.lang.String[]	getColumnHeaders() Return the names of all available columns in this table.
java.lang.Integer[]	getColumnsInitiallyVisible() Return an array of indices of columns that are initially visible when displaying the content on screen.
java.lang.Integer[]	getColumnsRequired() Return the indices of the columns that are required to be displayed to the user.
boolean	getPreferredSortAscending() Return whether the preeferred csort column should be sorted in ascending values.
int	getPreferredSortColumn() Return the index of the preferred sort column.
int	getRowCount() Return the number of rows in this table.
ResultData2D.ResultData2DRow	getValueAt(int rowIndex) Return a row object which allows access to the column values for this row.
boolean	hasPreferredSortColumn() Return whether one of the available columns is preferred for sorting.

Method Detail

getRowCount

int getRowCount()

Return the number of rows in this table.

Returns:

The number of rows.

getColumnsInitiallyVisible

java.lang.Integer[] getColumnsInitiallyVisible()

Return an array of indices of columns that are initially visible when displaying the content on screen. All indices must be within the range of 0 up to the number of columns returned by getColumnHeaders(). The array must contain all indices returned by getColumnsRequired().

Returns:

The indices of columns that should initially be displayed to the user.

getColumnsRequired

java.lang.Integer[] getColumnsRequired()

Return the indices of the columns that are required to be displayed to the user. All indices must be within the range of 0 up to the number of columns returned by getColumnHeaders().

Returns:

The indices of columns that should always be displayed to the user.

getColumnHeaders

java.lang.String[] getColumnHeaders()

Return the names of all available columns in this table.

Returns:

The header names of all available columns.

getColumnClass

java.lang.Class getColumnClass(int columnIndex)

Return the object class of values in the given column.

Parameters:

columnIndex - The 0-based index of the column

Returns:

The class of column values in the given column.

hasPreferredSortColumn

boolean hasPreferredSortColumn()

Return whether one of the available columns is preferred for sorting.

Returns:

Return true if the table has a column which should be used for sorting. false otherwise.

getPreferredSortColumn

int getPreferredSortColumn()

Return the index of the preferred sort column. This is called only if you have returned true on hasPreferredSortColumn().

Returns:

The index of the preferred sort column.

getPreferredSortAscending

boolean getPreferredSortAscending()

Return whether the preeferred csort column should be sorted in ascending values. This is called only if you have returned true on hasPreferredSortColumn().

Returns:

Return if the preferred sort column values should be sorted in ascending order. Return false if it should be sorted in descendin gorder.

getCellFormat

java.text.Format getCellFormat(int columnIndex)

Get a format to be used for rendering a value object of the given column as text.

Parameters:

columnIndex - The index of the column to return the format for.

Returns:

The text format to be used for rendering the given column values. Return null to use the standard #toString() method.

getCellRenderer

javax.swing.table.TableCellRenderer getCellRenderer(int columnIndex)

Return a renderer for rendering a value of the given column.

Parameters:

columnIndex - The index of the column.

Returns:

Return a custom renderer for rendering the given column in Swing UI. Return null to use the standard renderer.

getValueAt

ResultData2D.ResultData2DRow getValueAt(int rowIndex)

Return a row object which allows access to the column values for this row.

Parameters:

rowIndex - The 0-based index of the row to return.

Returns:

The row object.