net.sf.basedb.plugins
Class HelpImporter

java.lang.Object
  net.sf.basedb.core.plugin.AbstractPlugin
      net.sf.basedb.plugins.HelpImporter

All Implemented Interfaces:

AutoDetectingImporter, InteractivePlugin, Plugin, SignalTarget

public class HelpImporter
extends AbstractPlugin
implements InteractivePlugin, AutoDetectingImporter, SignalTarget

This plugin imports helptexts into database from a XML-file. The XML-file need to have a DOCLET definition in the first 15 lines and it should use the DTD-file: helpfile.dtd in /net/sf/basedb/core/dtd/.

Version:

2.0

Author:

Martin

Last modified

$Date$

Nested Class Summary

Nested classes/interfaces inherited from interface net.sf.basedb.core.plugin.Plugin

Plugin.MainType

Field Summary

private static About	about
private Client	client
private static GuiContext	clientItem
private PluginParameter<Client>	clientParameter
private RequestInformation	configureJob
private static String	dtdFileName
private String	filename
private PluginParameter<File>	fileParameter
private static Set<GuiContext>	guiContexts
private static GuiContext	helpList
private int	numImported
private int	numTotal
private int	numUpdated
private boolean	overwrite
private PluginParameter<Boolean>	overWriteParameter
private static Set<Permissions>	permissions
private ThreadSignalHandler	signalHandler
private File	xmlFile

Fields inherited from class net.sf.basedb.core.plugin.AbstractPlugin

annotationSection, configuration, COPY_ANNOTATIONS, job, OVERWRITE_ANNOTATIONS, sc

Constructor Summary

HelpImporter()

Method Summary

void	configure(GuiContext context, Request request, Response response) Configure the plugin.
void	doImport(InputStream in, ProgressReporter progress) Import the data from the given InputStream.
About	getAbout() Get information about the plugin, such as name, version, authors, etc.
private RequestInformation	getConfiguredJobParameters()
Set<GuiContext>	getGuiContexts() Get a set containing all items that the plugin handles.
Plugin.MainType	getMainType() Get the type of the plugin.
Collection<Permissions>	getPermissions() Request write access to Client:s and read access to File:s.
RequestInformation	getRequestInformation(GuiContext context, String command) This method will return the RequestInformation for a given command, i.e.
SignalHandler	getSignalHandler() Get the signal handler that is handling signals on behalf of this object.
private String	getSuccessMessage()
void	installHelpTexts(Client client, boolean overwrite, InputStream is) Deprecated. Use installHelpTexts(Client, boolean, InputStream, String) instead
void	installHelpTexts(Client client, boolean overwrite, InputStream is, String filename) This method installs the helptexts from an inputstream.
boolean	isImportable(InputStream in) Check if the given InputStream can be imported by this plugin.
String	isInContext(GuiContext context, Object item) Check if the plugin can be used on the specified object.
boolean	requiresConfiguration() Returns FALSE, since that is how the plugins used to work before this method was introduced.
void	run(Request request, Response response, ProgressReporter progress) Run the plugin.
boolean	supportsConfigurations() Returns TRUE, since that is how the plugins used to work before this method was introduced.

Methods inherited from class net.sf.basedb.core.plugin.AbstractPlugin

checkInterrupted, cloneParameterWithDefaultValue, closeLogFile, createLogFile, done, getCopyAnnotationsParmeter, getCurrentConfiguration, getCurrentJob, getJobOrConfigurationValue, getOverwriteAnnotationsParameters, init, log, log, storeValue, storeValue, storeValues, validateRequestParameters

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sf.basedb.core.plugin.Plugin

done, init

Field Detail

numImported

private int numImported

numUpdated

private int numUpdated

numTotal

private int numTotal

overwrite

private boolean overwrite

client

private Client client

xmlFile

private File xmlFile

filename

private String filename

fileParameter

private PluginParameter<File> fileParameter

clientParameter

private PluginParameter<Client> clientParameter

overWriteParameter

private PluginParameter<Boolean> overWriteParameter

configureJob

private RequestInformation configureJob

dtdFileName

private static final String dtdFileName

See Also:

Constant Field Values

about

private static final About about

clientItem

private static final GuiContext clientItem

helpList

private static final GuiContext helpList

guiContexts

private static final Set<GuiContext> guiContexts

permissions

private static final Set<Permissions> permissions

signalHandler

private ThreadSignalHandler signalHandler

Constructor Detail

HelpImporter

public HelpImporter()

Method Detail

getGuiContexts

public Set<GuiContext> getGuiContexts()

Description copied from interface: InteractivePlugin

Get a set containing all items that the plugin handles. Ie. if the plugin imports reporters, return a set containing Item.REPORTER. This information is used by client applications to put the plugin in the proper place in the user interface.

Specified by:

getGuiContexts in interface InteractivePlugin

Returns:

A Set containing Item:s, or null if the plugin is not concerned about items

isInContext

public String isInContext(GuiContext context,
                          Object item)

Description copied from interface: InteractivePlugin

Check if the plugin can be used on the specified object. The item is either a BasicItem or BasicData object, or null if called from a list context. A client application should only call this method for contexts matching one of the contexts in the set returned by the InteractivePlugin.getGuiContexts() method. For GuiContext.Type.ITEM contexts an item of the correct type should be passed as a parameter.

The plug-in can response with a null value indicating success, a warning-level message or throw an exception to indicate an error-level message. Client application should normally only show error-level messages to users, unless the user has requested to see warning messages.

NOTE! Before BASE 2.4 all messages were treated as error-level messages.

Specified by:

isInContext in interface InteractivePlugin

Parameters:

context - The current context of the client application, it is one of the values found in set returned by InteractivePlugin.getGuiContexts()

item - The currently active item, it's type should match the GuiContext.getItem() type, or null if the context is a list context

Returns:

Null if the plugin can use that item, or a warning-level message explaining why the plugin can't be used

getRequestInformation

public RequestInformation getRequestInformation(GuiContext context,
                                                String command)
                                         throws BaseException

Description copied from interface: InteractivePlugin

This method will return the RequestInformation for a given command, i.e. the list of parameters and some nice help text.

Specified by:

getRequestInformation in interface InteractivePlugin

Parameters:

context - The current context of the client application, it is one of the values found in set returned by InteractivePlugin.getGuiContexts()

command - The command

Returns:

The RequestInformation for the command

Throws:

BaseException - if there is an error

configure

public void configure(GuiContext context,
                      Request request,
                      Response response)

Description copied from interface: InteractivePlugin

Configure the plugin. Hopefully the client is supplying values for the parameters specified by InteractivePlugin.getRequestInformation(GuiContext, String).

Specified by:

configure in interface InteractivePlugin

Parameters:

context - The current context of the client application, it is one of the values found in set returned by InteractivePlugin.getGuiContexts()

request - Request object with the command and parameters

response - Response object in for the plugin to response through

getMainType

public Plugin.MainType getMainType()

Description copied from interface: Plugin

Get the type of the plugin. This method must always return the same value.

Specified by:

getMainType in interface Plugin

Returns:

One of the defined types

getAbout

public About getAbout()

Description copied from interface: Plugin

Get information about the plugin, such as name, version, authors, etc.

Specified by:

getAbout in interface Plugin

Returns:

An About object

supportsConfigurations

public boolean supportsConfigurations()

Description copied from class: AbstractPlugin

Returns TRUE, since that is how the plugins used to work before this method was introduced.

Specified by:

supportsConfigurations in interface Plugin

Overrides:

supportsConfigurations in class AbstractPlugin

Returns:

TRUE or FALSE

requiresConfiguration

public boolean requiresConfiguration()

Description copied from class: AbstractPlugin

Returns FALSE, since that is how the plugins used to work before this method was introduced.

Specified by:

requiresConfiguration in interface Plugin

Overrides:

requiresConfiguration in class AbstractPlugin

Returns:

TRUE or FALSE

getPermissions

public Collection<Permissions> getPermissions()

Request write access to Client:s and read access to File:s.

Specified by:

getPermissions in interface Plugin

Overrides:

getPermissions in class AbstractPlugin

Returns:

A collection of permissions or null to not use permissions

run

public void run(Request request,
                Response response,
                ProgressReporter progress)

Description copied from interface: Plugin

Run the plugin. If a progress reporter object is passed it is recommended that the plugin makes use of it.

Specified by:

run in interface Plugin

Parameters:

request - Request object with the command and parameters

response - Response object in for the plugin to response through

progress - A ProgressReporter where the plugin can report its progess, can be null

getSignalHandler

public SignalHandler getSignalHandler()

Description copied from interface: SignalTarget

Get the signal handler that is handling signals on behalf of this object. Multiple invokations of this method may receive the same or different objects. Null may be returned if, for some reason, the current object instance doesn't want to receive signals. Returning null is the same as not implementing this interface.

Specified by:

getSignalHandler in interface SignalTarget

Returns:

A SignalHandler object, or null if the current instance doesn't support signals

isImportable

public boolean isImportable(InputStream in)
                     throws BaseException

Description copied from interface: AutoDetectingImporter

Check if the given InputStream can be imported by this plugin.

Specified by:

isImportable in interface AutoDetectingImporter

Parameters:

in - The input stream to check

Returns:

TRUE if the stream can be imported, FALSE otherwise

Throws:

BaseException - If something goes wrong

doImport

public void doImport(InputStream in,
                     ProgressReporter progress)
              throws BaseException

Description copied from interface: AutoDetectingImporter

Import the data from the given InputStream.

Specified by:

doImport in interface AutoDetectingImporter

Parameters:

in - The input stream to read from

progress - Progress reporter used by the caller to keep track of the progress. Null is allowed

Throws:

BaseException - If something goes wrong

getConfiguredJobParameters

private RequestInformation getConfiguredJobParameters()

installHelpTexts

public void installHelpTexts(Client client,
                             boolean overwrite,
                             InputStream is)

Deprecated. Use installHelpTexts(Client, boolean, InputStream, String) instead

installHelpTexts

public void installHelpTexts(Client client,
                             boolean overwrite,
                             InputStream is,
                             String filename)

This method installs the helptexts from an inputstream.

Parameters:

client - The client that owns the helptexts

overwrite - Handles duplicate of externalID. True - the existing texts in database will be overwritten with the one from importfile that have same externalID. False - the existing texts in database are not overwritten with the one from importfile that have the same externalID.

is - InputStream from the xml-file with texts to import

filename - The filename of the original file or null if not known

Since:

2.4

getSuccessMessage

private String getSuccessMessage()