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 used by the Template Plugin Data Source. Provides sample code for a Plugin Data Source. Application developers are encouraged to extend or copy/modify the Template Plugin Data Source to create their own Plugin Data Source.

Constructor Summary

PluginDataSourceFactoryTemplate()
Constructor to set static information.

Method Summary

void	dispose() Removes the Plugin Factory and cleans up related resources.
java.lang.String	getDefaultSignOnParameter() The Template Data Source does not support the Sign-on Parameter.
boolean	needSignOnParameter() The Template Data Source does not support the Sign-on Parameter.
void	raiseConnectDialog(Parameter signOnParam) The Template Data Source does not support the Sign-on Parameter.
void	setReportContext(ReportContext pReportContext) Passed in ReportContext.

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 the Plug-in Data Source requires any setup based on environment information, that setup should be done inside the setReportContext method.

Method Detail

needSignOnParameter

public boolean needSignOnParameter()
                            throws PluginException

The Template Data Source does not support the Sign-on Parameter. Refer to the JDBC Data Source reference implementation for a Sign-on Parameter example.

Specified by:

needSignOnParameter in interface PluginDataSourceFactory

getDefaultSignOnParameter

public java.lang.String getDefaultSignOnParameter()
                                           throws PluginException

The Template Data Source does not support the Sign-on Parameter. Refer to the JDBC Data Source reference implementation for a Sign-on Parameter example.

Specified by:

getDefaultSignOnParameter in interface PluginDataSourceFactory

raiseConnectDialog

public void raiseConnectDialog(Parameter signOnParam)
                        throws PluginException

The Template Data Source does not support the Sign-on Parameter. Refer to the JDBC Data Source reference implementation for a Sign-on Parameter example.

Specified by:

raiseConnectDialog in interface PluginDataSourceFactory

setReportContext

public void setReportContext(ReportContext pReportContext)

Passed in ReportContext. This method is called by Reports right after the Plugin Factory is created. PluginFactoryTemplate saves the passed in Report Context in an object variable for later use. getReportContext returns the saved Report Context. Any subclass of PluginFactoryTemplate that overwrites setReportContext should still call super.setReportContext so that Report Context can be saved and getReportContext can work properly.

Specified by:

setReportContext in interface PluginFactory

Overrides:

setReportContext in class PluginFactoryTemplate

dispose

public void dispose()

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

Specified by:

dispose in interface PluginFactory

Overrides:

dispose in class PluginFactoryTemplate