oracle.reports.plugin.datasource
Class PluginDataSourceFactoryTemplate

java.lang.Object
  oracle.reports.plugin.PluginFactoryTemplate
      oracle.reports.plugin.datasource.PluginDataSourceFactoryTemplate

All Implemented Interfaces:

PluginDataSourceFactory, PluginFactory

public class PluginDataSourceFactoryTemplate
extends PluginFactoryTemplate
implements PluginDataSourceFactory

Factory class of 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.

Constructor Summary

PluginDataSourceFactoryTemplate()
Constructor to set static information.

Method Summary

void	dispose() Dispose the Plugin Factory and clean up related resources.
java.lang.String	getDefaultSignOnParameter() Template Data Source does not support sign-on parameter.
boolean	needSignOnParameter() Template Data Source does not support sign-on parameter.
void	raiseConnectDialog(Parameter signOnParam) Template Data Source does not support sign-on parameter.
void	setReportContext(ReportContext pReportContext) Get ReportContext object.

Methods inherited from class oracle.reports.plugin.PluginFactoryTemplate

getEditor, getEditorClass, getHelpPrefix, getHelpSet, getHint, getIconName, getMajorVersion, getMinorVersion, getName, getPluginClass, getReportContext, make, setEditorClass, setHelpPrefix, setHelpSet, setHelpSetID, setHint, setIconName, setMajorVersion, setMinorVersion, setName, setPluginClass

Methods inherited from class java.lang.Object

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

Methods inherited from interface oracle.reports.plugin.PluginFactory

getEditor, getHelpPrefix, getHelpSet, getHint, getIconName, getMajorVersion, getMinorVersion, getName, make, setHelpSetID

Constructor Detail

PluginDataSourceFactoryTemplate

public PluginDataSourceFactoryTemplate()

Constructor to set static information. If Plug-in Data Source requires any set-ups based on environment information, those set-ups should be done inside setReportContext method.

Method Detail

needSignOnParameter

public boolean needSignOnParameter()
                            throws PluginException

Template Data Source does not support sign-on parameter. Please check JDBC Data Source reference implementation for sign-on parameter example.

Specified by:

needSignOnParameter in interface PluginDataSourceFactory

Throws:

PluginException

getDefaultSignOnParameter

public java.lang.String getDefaultSignOnParameter()
                                           throws PluginException

Template Data Source does not support sign-on parameter. Please check JDBC Data Source reference implementation for sign-on parameter example.

Specified by:

getDefaultSignOnParameter in interface PluginDataSourceFactory

Throws:

PluginException

raiseConnectDialog

public void raiseConnectDialog(Parameter signOnParam)
                        throws PluginException

Template Data Source does not support sign-on parameter. Please check JDBC Data Source reference implementation for sign-on parameter example.

Specified by:

raiseConnectDialog in interface PluginDataSourceFactory

Throws:

PluginException

setReportContext

public void setReportContext(ReportContext pReportContext)

Get ReportContext object. This method is called by Reports right after Plug-in Factory is created. PluginFactoryTemplate saves the passed in ReportContext in an object variable. GetReportContext returns the saved ReportContext. Any subclass of PluginFactoryTemplate that overwrites setReportContext should still call super.setReportContext, so that ReportContext can be saved, and getReportContext can work properly.

Specified by:

setReportContext in interface PluginFactory

Overrides:

setReportContext in class PluginFactoryTemplate

dispose

public void dispose()

Dispose the Plugin Factory and clean up related resources. This method is called when shut down Reports.

Specified by:

dispose in interface PluginFactory

Overrides:

dispose in class PluginFactoryTemplate