Oracle Reports
Java API Reference
10g (9.0.4)
B12019-01

oracle.reports.plugin
Interface PluginFactory

All Known Subinterfaces:
PluginDataSourceFactory
All Known Implementing Classes:
PluginFactoryTemplate

public interface PluginFactory

Creates plugin instances, holds static information, and provides shared functions of this type of plugin. One type of plugin, such as the JDBC Plugin Data Source, will have one PluginFactory instance.

Reports creates and registers PluginFactory with the following call sequence to related methods:

 1. PluginFactory() (default constructor)
 2. setReportContext()
 3. getHelpSet()
 4. getHelpPrefix()
 5. setHelpSetID()

Note that setReportContext is called right after PluginFactory is created. If PluginFactory has any setup based on Report Context (or the environment), it needs to be done inside the setReportContext method.

Version:
1.01 May 1 2000

Method Summary
 void dispose()
          Removes the plugin instance and cleans up related resources.
 PluginEditor getEditor()
          Returns the plugin's editor.
 java.lang.String getHelpPrefix()
          Returns the prefix string for the error message help (e.g., "XR" for Express).
 java.lang.String getHelpSet()
          Returns the full path of the helpset file or a URL to the helpset file.
 java.lang.String getHint()
          Returns the hint message of this type of plugin.
 java.lang.String getIconName()
          Returns the icon name of the plugin.
 int getMajorVersion()
          Returns the major version of the plugin.
 int getMinorVersion()
          Returns the minor version of the plugin.
 java.lang.String getName()
          Returns the name of this type of plugin.
 Plugin make()
          Makes a plugin instance.
 void setHelpSetID(java.lang.String helpSetID)
          Sets the helpset ID for the plugin.
 void setReportContext(ReportContext reportContext)
           

 

Method Detail

setReportContext

public void setReportContext(ReportContext reportContext)

getMajorVersion

public int getMajorVersion()
                    throws PluginException
Returns the major version of the plugin.

getMinorVersion

public int getMinorVersion()
                    throws PluginException
Returns the minor version of the plugin.

getIconName

public java.lang.String getIconName()
                             throws PluginException
Returns the icon name of the plugin. Each Plugin Data Source needs to provide three icon files:
1. {iconName}.ico : icon displayed in the Data Model view tool palette.
2. {iconName}n.icon: icon displayed used in the Object Navigator.
3. {iconName}.res: icon displayed on top right corner of the Query box.

The plugin's icon files must be placed in ORACLE_HOME/reports/plugin/resource. Please check the plugin's UI documentation for details.


getName

public java.lang.String getName()
                         throws PluginException
Returns the name of this type of plugin. This name will be used to display this type of plugin in the UI or to describe this type of plugin in a message.

getHint

public java.lang.String getHint()
                         throws PluginException
Returns the hint message of this type of plugin. This hint is displayed in the Reports Builder Data Model view when users move the cursor over the icon for this type of plugin.

setHelpSetID

public void setHelpSetID(java.lang.String helpSetID)
                  throws PluginException
Sets the helpset ID for the plugin. This ID identifies the helpset associated with this type of plugin. The plugin should stash the ID and use it if it needs to access help using Report.setHelpTopic().

getHelpSet

public java.lang.String getHelpSet()
                            throws PluginException
Returns the full path of the helpset file or a URL to the helpset file. If not implemented, this plugin has no help available.

getHelpPrefix

public java.lang.String getHelpPrefix()
                               throws PluginException
Returns the prefix string for the error message help (e.g., "XR" for Express). This is used to fully qualify the error message help topic ID. For example, "XR-1000" is a help topic ID for error number 1000 in Express PDS. Reports takes two strings provided by PluginFactory (the helpset file and the prefix) and returns a helpSet ID that uniquely identifies this plugin via IPlugin.setHelpSetID(). This helpSet ID is a number (in the form of a String) that gets passed to help methods and RWException. The plugin must supply this prefix if error message help is to be used.

getEditor

public PluginEditor getEditor()
                       throws PluginException
Returns the plugin's editor.

make

public Plugin make()
            throws PluginException
Makes a plugin instance.

dispose

public void dispose()
             throws PluginException
Removes the plugin instance and cleans up related resources. This method is called when the report is closed.

Oracle Reports
Java API Reference

Copyright © 2003 Oracle Corporation. All Rights Reserved.