|
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 |
java.lang.Object oracle.reports.plugin.datasource.PluginDataSourceTemplate
public class PluginDataSourceTemplate
Template Plug-in Data Source class. 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 static java.lang.String |
DEFINITION
|
protected DataSource |
mDataSource
|
protected PluginFactory |
mFactory
|
protected PluginResultSetMetaData |
mMetaData
|
protected Parameter |
mSignOnParameter
|
Fields inherited from interface oracle.reports.plugin.datasource.PluginDataSource |
---|
ALL_ROWS |
Constructor Summary | |
---|---|
PluginDataSourceTemplate()
|
Method Summary | |
---|---|
boolean |
applyXML(java.lang.String xml)
Template Data Source has only static definition for sample code purpose. |
PluginResultSetMetaData |
describe()
Returns static meta-data of Template Plug-in Data Source. |
void |
dispose()
Clean up any Plug-in's resources here. |
java.sql.ResultSet |
execute(java.lang.Object[] refedColVals,
PluginCondition[] conds,
int maxrows)
Returns static result set of Template Plug-in Data Source. |
DataSource |
getDataSource()
Gets the hosting Reports data source object of the Plugin. |
PluginFactory |
getFactory()
Gets the factory passed to setFactory. |
java.lang.String |
getQueryDescription()
Returns the high-light data source description to be displayed in Reports Wizard Data Tab. |
java.lang.String[] |
getReferencedColumns()
Template Plug-in Data Source does not reference Reports columns. |
Report |
getReport()
Gets the hosting report of the plugin. |
ReportContext |
getReportContext()
Gets the report context which provides environment information. |
Parameter |
getSignOnParameter()
Return sign-on parameter of this Plug-in Data Source. |
java.lang.String |
saveToXML()
Return the static definition to be saved with report. |
void |
setDataSource(DataSource datasource)
Sets the Reports hosting data source object of the plugin |
void |
setFactory(PluginFactory fac)
Sets the factory which creates the Plugin. |
void |
setSignOnParameter(Parameter signOnParam)
Sets sign on parameter of this Plug-in Data Source whenever it is set or changed in Reports Property Palette. |
void |
startRuntime()
Template Plug-in Data Source does not need any initilization before runtime. |
boolean |
supportCondition()
Template Plugin Data Source does not support condition, simply returns false here. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected static final java.lang.String DEFINITION
protected PluginFactory mFactory
protected DataSource mDataSource
protected Parameter mSignOnParameter
protected PluginResultSetMetaData mMetaData
Constructor Detail |
---|
public PluginDataSourceTemplate()
Method Detail |
---|
public java.lang.String[] getReferencedColumns() throws PluginException
getReferencedColumns
in interface PluginDataSource
PluginException
public void startRuntime() throws PluginException
startRuntime
in interface Plugin
PluginException
public void setFactory(PluginFactory fac) throws PluginException
setFactory
in interface Plugin
PluginException
public PluginFactory getFactory() throws PluginException
getFactory
in interface Plugin
PluginException
public DataSource getDataSource() throws PluginException
PluginException
public Report getReport() throws PluginException
PluginException
public ReportContext getReportContext() throws PluginException
PluginException
public void setSignOnParameter(Parameter signOnParam) throws PluginException
setSignOnParameter
in interface PluginDataSource
signOnParam
- sign on parameter of this Plugin Data Source
PluginException
public Parameter getSignOnParameter() throws PluginException
PluginException
public boolean applyXML(java.lang.String xml) throws PluginException
applyXML
in interface Plugin
PluginException
public void setDataSource(DataSource datasource) throws PluginException
setDataSource
in interface PluginDataSource
datasource
- the hosting data source object
PluginException
public java.lang.String getQueryDescription() throws PluginException
getQueryDescription
in interface PluginDataSource
PluginException
public PluginResultSetMetaData describe() throws PluginException
describe
in interface PluginDataSource
PluginException
public java.sql.ResultSet execute(java.lang.Object[] refedColVals, PluginCondition[] conds, int maxrows) throws PluginException
execute
in interface PluginDataSource
refedColVals
- values of the referenced Reports columns
as given by getReferencedColumns method. See getReferencedColumns
for details.conds
- conditions imposed on the result set required by column links.
See supportCondition method for details.maxrows
- maximum number of rows the result set should return.
ALL_ROWS means no limit.
PluginException
public boolean supportCondition() throws PluginException
supportCondition
in interface PluginDataSource
PluginException
public void dispose()
dispose
in interface Plugin
public java.lang.String saveToXML() throws PluginException
saveToXML
in interface Plugin
PluginException
|
Oracle Reports Java API Reference |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |