|
Oracle Reports Java API Reference 11g Release 1 (11.1.1) E10775-01 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface PluginResultSetMetaData
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.
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 |
---|
static final int SORT_NONE
static final int SORT_ASCENDING
static final int SORT_DESCENDING
Method Detail |
---|
int getSortOrder(int colIdx) throws PluginException
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 decendinglyThe 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).
colIdx
- column index, the first column is 1, the second is 2, ...
RWException
- when error
PluginException
int sortColumnOf(int colIdx) throws PluginException
colIdx
- column index, the first column is 1, the second is 2, ...
PluginException
- when error
|
Oracle Reports Java API Reference |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |