com.sdmetrics.app

Interface DataTables

All Known Implementing Classes:

MetricData, ModelData, RelationMatrices, RuleData

public interface DataTables

Interface to access all kinds of measurement data (metrics, rule violations, relation matrices) in a tabular form. The interface provides access to a list of tables. Each table is addressed by an index. Each table has

• a name describing the contents of the table (e.g. the type of design elements shown in the table)
• a number of columns (e.g. representing metrics) with column headers and column descriptions (names and descriptions of the metrics),
• a number of rows (e.g. design elements) with a row header (the name of the design element), and
• data cells as the body of the table (e.g. metric values).

Method Summary

Modifier and Type	Method and Description
java.lang.String	getColumnDescription(int index, int col) Returns a short description of a column.
java.lang.String	getColumnName(int index, int col) Returns the name of the object a column represents (column header).
int	getNumberOfColumns(int index) Returns the number of columns of a table.
int	getNumberOfRows(int index) Returns the number of rows of a table.
int	getNumberOfTables() Returns the number of available tables.
java.lang.String	getRowName(int index, int row) Returns the name of the object a row represents (row header).
java.lang.String	getTableName(int index) Returns the name of a table.
java.lang.String	getTablesDescription() Returns a short description of the tables contents.
java.lang.String	getTypeName(int index) Returns the metamodel type name of the elements of a table.
java.lang.Object	getValueAt(int index, int row, int col) Returns the value of a table cell.

Method Detail

getNumberOfTables

int getNumberOfTables()

Returns the number of available tables.

Returns:

The number of tables, n. Valid table indices run from 0 to n-1.

getTableName

java.lang.String getTableName(int index)

Returns the name of a table.

Parameters:

index - Index of the table to access.

Returns:

The name of that table.

getNumberOfRows

int getNumberOfRows(int index)

Returns the number of rows of a table. Note: This does NOT include the row with the column headers (names).

Parameters:

index - Index of the table to access.

Returns:

The number of rows of the table, r. Valid row indices for the table run from 0 to r-1.

getNumberOfColumns

int getNumberOfColumns(int index)

Returns the number of columns of a table. Note: This does NOT include the column with the row headers (names).

Parameters:

index - Index of the table to access.

Returns:

Number of columns of the table, c. Valid column indices for the table run from 0 to c-1.

getValueAt

java.lang.Object getValueAt(int index,
                            int row,
                            int col)

Returns the value of a table cell.

Parameters:

index - Index of the table to access.

row - Index of the row to access.

col - Index of the column to access.

Returns:

Table cell value at the specified coordinates.

getRowName

java.lang.String getRowName(int index,
                            int row)

Returns the name of the object a row represents (row header).

Parameters:

index - Index of the table to access.

row - Index of the row to access.

Returns:

The name of the row to be used as row header.

getColumnName

java.lang.String getColumnName(int index,
                               int col)

Returns the name of the object a column represents (column header).

Parameters:

index - Index of the table to access.

col - Index of the column to access.

Returns:

The name of the column to be used as column header.

getColumnDescription

java.lang.String getColumnDescription(int index,
                                      int col)

Returns a short description of a column. The description is a short string (one-liner), providing a brief, informal description of the column, and can be used, e.g., as a tool tip for the column headers when displaying the table on screen.

Parameters:

index - Index of the table to access.

col - Index of the column to access.

Returns:

A brief description text for the column.

getTypeName

java.lang.String getTypeName(int index)

Returns the metamodel type name of the elements of a table.

Parameters:

index - Index of the table to access.

Returns:

Type name of the model elements of that table.

getTablesDescription

java.lang.String getTablesDescription()

Returns a short description of the tables contents. For example, "metric data", "design rule violations", "descriptive statistics", etc.

Returns:

Description of the table contents.