Oracle Reports
Java API Reference
11g Release 1 (11.1.1)
E10775-01

oracle.reports.plugin
Interface PluginResultSetMetaData

All Superinterfaces:
java.sql.ResultSetMetaData, java.sql.Wrapper
All Known Implementing Classes:
PluginResultSetMetaDataTemplate

public interface PluginResultSetMetaData
extends java.sql.ResultSetMetaData

PluginResultSetMetaData defines extended result set meta data used by Reports Plugin Data Source. It contains those Reports column meta data informaton which are not defined in JDBC, such as sort order, sort column, and etc. Please check PluginTypes to see list of data types supported by Reports Plug-in API. The following lists the methods of ResultSetMetaData which are used by Reports Plug-in API. getColumnCount() getColumnName(int column) getColumnLabel(int column) getColumnType(int column) getPrecision(int column) getScale(int column) getDisplaySize(int column) Please check PluginResultSetMetaDataTemplate for sample implementation of PluginResultSetMetaData.

Version:
1.01 May 1 2000

Field Summary
static int SORT_ASCENDING
          Code to indicate the column needs to to sorted ascendingly
static int SORT_DESCENDING
          Code to indicate the column needs to to sorted descendingly
static int SORT_NONE
          Code to indicate the column is not used for sorting at all
 
Fields inherited from interface java.sql.ResultSetMetaData
columnNoNulls, columnNullable, columnNullableUnknown
 
Method Summary
 int getSortOrder(int colIdx)
          Returns column's sort order, how Reports should sort rows based on this column:
 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
 
Methods inherited from interface java.sql.Wrapper
isWrapperFor, unwrap
 

Field Detail

SORT_NONE

static final int SORT_NONE
Code to indicate the column is not used for sorting at all

See Also:
Constant Field Values

SORT_ASCENDING

static final int SORT_ASCENDING
Code to indicate the column needs to to sorted ascendingly

See Also:
Constant Field Values

SORT_DESCENDING

static final int SORT_DESCENDING
Code to indicate the column needs to to sorted descendingly

See Also:
Constant Field Values
Method Detail

getSortOrder

int getSortOrder(int colIdx)
                 throws PluginException
Returns column's sort order, how Reports should sort rows based on this column:
   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 a break group should have at least one break column (SORT_ASCENDING or SORT_DECENDING).

Parameters:
colIdx - column index, the first column is 1, the second is 2, ...
Returns:
column's sort order
Throws:
RWException - when error
PluginException

sortColumnOf

int sortColumnOf(int colIdx)
                 throws PluginException
Returns the base column index of the column if it is a sort column. -1 if the column is not a sort column. Sort column is a column which 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. Sort column 'weekday_sort' is necessary for the example because the order of days in a week is not either alphabetical or numerical order. 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 - column index, the first column is 1, the second is 2, ...
Returns:
sort column's base column index, the first column is 1, the second is 2, ...
Throws:
PluginException - when error

Oracle Reports
Java API Reference

Copyright © 1994, 2009 Oracle Corporation. All Rights Reserved.