net.sf.basedb.plugins
Class SpotImageCreator
java.lang.Object
net.sf.basedb.core.plugin.AbstractPlugin
net.sf.basedb.plugins.SpotImageCreator
- All Implemented Interfaces:
- Plugin, SignalTarget
public class SpotImageCreator
- extends AbstractPlugin
- implements Plugin, SignalTarget
- Version:
- 2.0
- Author:
- Nicklas
- Last modified
- $Date: 2011-05-13 14:54:50 +0200 (Fri, 13 May 2011) $
Methods inherited from class net.sf.basedb.core.plugin.AbstractPlugin |
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 |
permissions
private static final Set<Permissions> permissions
signalHandler
private ThreadSignalHandler signalHandler
SpotImageCreator
public SpotImageCreator()
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
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 RawBioAssay:s, create and write access to File:s,
use access to FileType:s and Directory: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 parametersresponse
- Response object in for the plugin to response
throughprogress
- 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