oracle.reports.plugin
Class PluginResultSetMetaDataTemplate

java.lang.Object
  |
  +--oracle.reports.plugin.PluginResultSetMetaDataTemplate

All Implemented Interfaces:

PluginResultSetMetaData, java.sql.ResultSetMetaData

public class PluginResultSetMetaDataTemplate

extends java.lang.Object

implements PluginResultSetMetaData

Template ResultSetMetaData class used by Template Plug-in Data Source. It provides sample code of a real functioning Plug-in Data Source. Application developers are encouraged to extend, or copy/modify Template Plug-in Data Source to create their own Plug-in Data Source.

Field Summary

protected int[]	mDisplaySizes
protected java.lang.String[]	mLabels
protected java.lang.String[]	mNames
protected int	mNumOfCols
protected int[]	mPrecisions
protected int[]	mScales
protected int[]	mSortColumnOf
protected int[]	mSortOrder
protected int[]	mTypes

Fields inherited from interface oracle.reports.plugin.PluginResultSetMetaData

SORT_ASCENDING, SORT_DESCENDING, SORT_NONE

Fields inherited from interface java.sql.ResultSetMetaData

columnNoNulls, columnNullable, columnNullableUnknown

Constructor Summary

PluginResultSetMetaDataTemplate()
Constructor.

Method Summary

boolean	checkColumnIndex(int colIdx) Check if column index valid.
java.lang.String	getCatalogName(int column) Not used by Reports Plugin API, simply stub it.
java.lang.String	getColumnClassName(int column) Not used by Reports Plugin API, simply stub it.
int	getColumnCount() Returns number of columns.
int	getColumnDisplaySize(int column) Return display size.
java.lang.String	getColumnLabel(int column) Returns column label.
java.lang.String	getColumnName(int column) Return the name of the specific column in the row
int	getColumnType(int column) Returns the column data type.
java.lang.String	getColumnTypeName(int column) Not used by Reports Plugin API, simply stub it.
int	getPrecision(int column) Return the precision of the column.
int	getScale(int column) Return the scale of the column.
java.lang.String	getSchemaName(int column) Not used by Reports Plugin API, simply stub it.
int	getSortOrder(int column) Return the sort order.
java.lang.String	getTableName(int column) Not used by Reports Plugin API, simply stub it.
boolean	isAutoIncrement(int column) Not used by Reports Plugin API, simply stub it.
boolean	isCaseSensitive(int column) Not used by Reports Plugin API, simply stub it.
boolean	isCurrency(int column) Not used by Reports Plugin API, simply stub it.
boolean	isDefinitelyWritable(int column) Not used by Reports Plugin API, simply stub it.
int	isNullable(int column) Not used by Reports Plugin API, simply stub it.
boolean	isReadOnly(int column) Not used by Reports Plugin API, simply stub it.
boolean	isSearchable(int column) Not used by Reports Plugin API, simply stub it.
boolean	isSigned(int column) Not used by Reports Plugin API, simply stub it.
boolean	isWritable(int column) Not used by Reports Plugin API, simply stub it.
int	sortColumnOf(int column) Returns SortColumnOf.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

mNumOfCols

protected int mNumOfCols

mNames

protected java.lang.String[] mNames

mLabels

protected java.lang.String[] mLabels

mTypes

protected int[] mTypes

mPrecisions

protected int[] mPrecisions

mScales

protected int[] mScales

mDisplaySizes

protected int[] mDisplaySizes

mSortOrder

protected int[] mSortOrder

mSortColumnOf

protected int[] mSortColumnOf

Constructor Detail

PluginResultSetMetaDataTemplate

public PluginResultSetMetaDataTemplate()

Constructor.

Method Detail

checkColumnIndex

public boolean checkColumnIndex(int colIdx)

Check if column index valid. Note JDBC column index starts from 1.

sortColumnOf

public int sortColumnOf(int column)
                 throws PluginException

Returns SortColumnOf.

Specified by:

sortColumnOf in interface PluginResultSetMetaData

Following copied from interface: oracle.reports.plugin.PluginResultSetMetaData

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

getColumnLabel

public java.lang.String getColumnLabel(int column)

Returns column label.

Specified by:

getColumnLabel in interface java.sql.ResultSetMetaData

getColumnCount

public int getColumnCount()
                   throws java.sql.SQLException

Returns number of columns.

Specified by:

getColumnCount in interface java.sql.ResultSetMetaData

getColumnName

public java.lang.String getColumnName(int column)
                               throws java.sql.SQLException

Return the name of the specific column in the row

Specified by:

getColumnName in interface java.sql.ResultSetMetaData

getPrecision

public int getPrecision(int column)
                 throws java.sql.SQLException

Return the precision of the column.

Specified by:

getPrecision in interface java.sql.ResultSetMetaData

getScale

public int getScale(int column)
             throws java.sql.SQLException

Return the scale of the column.

Specified by:

getScale in interface java.sql.ResultSetMetaData

getColumnType

public int getColumnType(int column)
                  throws java.sql.SQLException

Returns the column data type.

Specified by:

getColumnType in interface java.sql.ResultSetMetaData

getSortOrder

public int getSortOrder(int column)
                 throws PluginException

Return the sort order.

Specified by:

getSortOrder in interface PluginResultSetMetaData

Following copied from interface: oracle.reports.plugin.PluginResultSetMetaData

Parameters:

colIdx - column index, the first column is 1, the second is 2, ...

Returns:

column's sort order

Throws:

RWException - when error

getColumnDisplaySize

public int getColumnDisplaySize(int column)

Return display size.

Specified by:

getColumnDisplaySize in interface java.sql.ResultSetMetaData

getCatalogName

public java.lang.String getCatalogName(int column)

Not used by Reports Plugin API, simply stub it.

Specified by:

getCatalogName in interface java.sql.ResultSetMetaData

getColumnClassName

public java.lang.String getColumnClassName(int column)

Not used by Reports Plugin API, simply stub it.

Specified by:

getColumnClassName in interface java.sql.ResultSetMetaData

getSchemaName

public java.lang.String getSchemaName(int column)

Not used by Reports Plugin API, simply stub it.

Specified by:

getSchemaName in interface java.sql.ResultSetMetaData

getTableName

public java.lang.String getTableName(int column)

Not used by Reports Plugin API, simply stub it.

Specified by:

getTableName in interface java.sql.ResultSetMetaData

isAutoIncrement

public boolean isAutoIncrement(int column)

Not used by Reports Plugin API, simply stub it.

Specified by:

isAutoIncrement in interface java.sql.ResultSetMetaData

isCaseSensitive

public boolean isCaseSensitive(int column)

Not used by Reports Plugin API, simply stub it.

Specified by:

isCaseSensitive in interface java.sql.ResultSetMetaData

isCurrency

public boolean isCurrency(int column)

Not used by Reports Plugin API, simply stub it.

Specified by:

isCurrency in interface java.sql.ResultSetMetaData

isDefinitelyWritable

public boolean isDefinitelyWritable(int column)

Not used by Reports Plugin API, simply stub it.

Specified by:

isDefinitelyWritable in interface java.sql.ResultSetMetaData

isNullable

public int isNullable(int column)

Not used by Reports Plugin API, simply stub it.

Specified by:

isNullable in interface java.sql.ResultSetMetaData

isReadOnly

public boolean isReadOnly(int column)

Not used by Reports Plugin API, simply stub it.

Specified by:

isReadOnly in interface java.sql.ResultSetMetaData

isSearchable

public boolean isSearchable(int column)

Not used by Reports Plugin API, simply stub it.

Specified by:

isSearchable in interface java.sql.ResultSetMetaData

isSigned

public boolean isSigned(int column)

Not used by Reports Plugin API, simply stub it.

Specified by:

isSigned in interface java.sql.ResultSetMetaData

isWritable

public boolean isWritable(int column)

Not used by Reports Plugin API, simply stub it.

Specified by:

isWritable in interface java.sql.ResultSetMetaData

getColumnTypeName

public java.lang.String getColumnTypeName(int column)
                                   throws java.sql.SQLException

Not used by Reports Plugin API, simply stub it.

Specified by:

getColumnTypeName in interface java.sql.ResultSetMetaData