oracle.reports.plugin
Interface PluginResultSetMetaData

All Superinterfaces:

java.sql.ResultSetMetaData

All Known Implementing Classes:

PluginResultSetMetaDataTemplate

public interface PluginResultSetMetaData

extends java.sql.ResultSetMetaData

Defines the extended result set meta data used by the Reports Plugin Data Source. It contains the Reports column meta data information that is not defined in JDBC, such as sort order, sort column, and so on. Refer to PluginTypes for a list of data types supported by the Reports Plugin API.

The following methods of ResultSetMetaData are used by the Reports Plugin API.

    getColumnCount()
    getColumnName(int column)
    getColumnLabel(int column)
    getColumnType(int column)
    getPrecision(int column)
    getScale(int column)
    getDisplaySize(int column)

Refer to PluginResultSetMetaDataTemplate for sample implementation of PluginResultSetMetaData.

Version:

1.01 May 1 2000

Field Summary

static int	SORT_ASCENDING Specifies that the column needs to be sorted in ascending order.
static int	SORT_DESCENDING Specifies that the column needs to be sorted in descending order.
static int	SORT_NONE Specifies that the column is not used for sorting.

Fields inherited from interface java.sql.ResultSetMetaData

columnNoNulls, columnNullable, columnNullableUnknown

Method Summary

int	getSortOrder(int colIdx) Returns the column's sort order.
int	sortColumnOf(int colIdx) Returns the base column index of the column if it is a sort column.

Methods inherited from interface java.sql.ResultSetMetaData

getCatalogName, getColumnClassName, getColumnCount, getColumnDisplaySize, getColumnLabel, getColumnName, getColumnType, getColumnTypeName, getPrecision, getScale, getSchemaName, getTableName, isAutoIncrement, isCaseSensitive, isCurrency, isDefinitelyWritable, isNullable, isReadOnly, isSearchable, isSigned, isWritable

Field Detail

SORT_NONE

public static final int SORT_NONE

Specifies that the column is not used for sorting.

SORT_ASCENDING

public static final int SORT_ASCENDING

Specifies that the column needs to be sorted in ascending order.

SORT_DESCENDING

public static final int SORT_DESCENDING

Specifies that the column needs to be sorted in descending order.

Method Detail

getSortOrder

public int getSortOrder(int colIdx)
                 throws PluginException

Returns the column's sort order. Reports will sort rows based on this value:

SORT_NONE: column value is not used for sorting at all
SORT_ASCENDING: column value needs to be sorted ascendingly
SORT_DESCENDING: column value needs to be sorted decendingly

The sort order only takes effect when the column is in a break group. Note that a break group should have at least one break column (SORT_ASCENDING or SORT_DECENDING).

Parameters:

colIdx - The column index, the first column is 1, the second is 2, and so on.

sortColumnOf

public int sortColumnOf(int colIdx)
                 throws PluginException

Returns the base column index of the column if it is a sort column. This value is -1 if the column is not a sort column. A sort column is a column that has the sorting value of another column. For example, column 'weekday' may have a sort column 'weekday_sort' to represent the order of "Sunday", "Monday", "Tuesday", and so on. In this example, the sort column 'weekday_sort' is necessary because the order of days in a week is neither alphabetical nor numerical. A sort column will be moved with its base column when the base column is moved from one break group to another. One column may have more than one sort column.

Parameters:

colIdx - The column index, the first column is 1, the second is 2, and so on.