Package net.sf.basedb.plugins
Class IntensityCalculatorPlugin
java.lang.Object
net.sf.basedb.core.plugin.AbstractPlugin
net.sf.basedb.plugins.IntensityCalculatorPlugin
- All Implemented Interfaces:
InteractivePlugin
,Plugin
,SignalTarget
public class IntensityCalculatorPlugin
extends AbstractPlugin
implements InteractivePlugin, SignalTarget
This plugin provides methods to calculate the intensity for a root bioassayset
using different formulas. It needs the following parameters:
String : name; The name of the new bioassayset Experiment : experiment; The experiment we are working on List>RawBioAssay< : rawBioAssays; The raw bioassays to create bioassays for (must be part of the experiment) Formula : formula; The formula to use to for calculating intesities
- Version:
- 2.0
- Author:
- Gregory, Nicklas
- Last modified
- $Date: 2019-02-26 11:10:15 +0100 (tis, 26 feb. 2019) $
-
Nested Class Summary
Nested classes/interfaces inherited from interface net.sf.basedb.core.plugin.Plugin
Plugin.MainType
-
Field Summary
Modifier and TypeFieldDescriptionprivate RequestInformation
private PluginParameter<Experiment>
private ItemParameterType<Experiment>
private PluginParameter<Formula>
private ItemParameterType<Formula>
private static final Set<GuiContext>
private static final PluginParameter<String>
private static final StringParameterType
private static final Set<Permissions>
private PluginParameter<RawBioAssay>
private ItemParameterType<RawBioAssay>
private ThreadSignalHandler
Fields inherited from class net.sf.basedb.core.plugin.AbstractPlugin
annotationSection, configuration, COPY_ANNOTATIONS, job, OVERWRITE_ANNOTATIONS, sc
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
configure
(GuiContext context, Request request, Response response) Store configuration settings forRequest.COMMAND_CONFIGURE_PLUGIN
, andRequest.COMMAND_CONFIGURE_JOB
.private RequestInformation
Get a set containing all items that the plugin handles.Returns the main plugin type this plugin belongs to.Request use access to Experiment:s and read access to RawBioAssay:s, ArrayDesign:s, Formulas:s, Job:s and and Reporter:s.getRequestInformation
(GuiContext context, String command) TheRequest.COMMAND_CONFIGURE_PLUGIN
command will not ask for any parameters.Get the signal handler that is handling signals on behalf of this object.isInContext
(GuiContext context, Object item) Check that the current experiment stores it's raw data in the database.boolean
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
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
cloneParameterWithDefaultValue, closeLogFile, createLogFile, done, getCopyAnnotationsParmeter, getCurrentConfiguration, getCurrentJob, getJobOrConfigurationValue, getOverwriteAnnotationsParameters, init, isLogging, log, log, storeValue, storeValue, storeValues, validateRequestParameters
-
Field Details
-
guiContexts
-
permissions
-
nameType
-
nameParameter
-
experimentType
-
experimentParameter
-
rawBioAssaysType
-
rawBioAssaysParameter
-
formulaType
-
formulaParameter
-
configureJob
-
signalHandler
-
-
Constructor Details
-
IntensityCalculatorPlugin
public IntensityCalculatorPlugin()Constructor should be empty.
-
-
Method Details
-
getMainType
Returns the main plugin type this plugin belongs to.- Specified by:
getMainType
in interfacePlugin
- Returns:
Plugin.MainType.INTENSITY
.
-
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 interfacePlugin
- Overrides:
supportsConfigurations
in classAbstractPlugin
- 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 interfacePlugin
- Overrides:
requiresConfiguration
in classAbstractPlugin
- Returns:
- TRUE or FALSE
-
getPermissions
Request use access to Experiment:s and read access to RawBioAssay:s, ArrayDesign:s, Formulas:s, Job:s and and Reporter:s.- Specified by:
getPermissions
in interfacePlugin
- Overrides:
getPermissions
in classAbstractPlugin
- Returns:
- A collection of permissions or null to not use permissions
-
run
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 interfacePlugin
- Parameters:
request
- Request object with the command and parametersresponse
- Response object in for the plugin to response throughprogress
- AProgressReporter
where the plugin can report its progess, can be null
-
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 containingItem.REPORTER
. This information is used by client applications to put the plugin in the proper place in the user interface.- Specified by:
getGuiContexts
in interfaceInteractivePlugin
- Returns:
- A
Set
containingItem
:s, or null if the plugin is not concerned about items
-
isInContext
Check that the current experiment stores it's raw data in the database.- Specified by:
isInContext
in interfaceInteractivePlugin
- Parameters:
context
- The current context of the client application, it is one of the values found in set returned byInteractivePlugin.getGuiContexts()
item
- The currently active item, it's type should match theGuiContext.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 TheRequest.COMMAND_CONFIGURE_PLUGIN
command will not ask for any parameters. TheRequest.COMMAND_CONFIGURE_JOB
command will ask for the parameters mentioned in the class documentation.- Specified by:
getRequestInformation
in interfaceInteractivePlugin
- Parameters:
context
- The current context of the client application, it is one of the values found in set returned byInteractivePlugin.getGuiContexts()
command
- The command- Returns:
- The
RequestInformation
for the command - Throws:
BaseException
- if there is an error
-
configure
Store configuration settings forRequest.COMMAND_CONFIGURE_PLUGIN
, andRequest.COMMAND_CONFIGURE_JOB
.- Specified by:
configure
in interfaceInteractivePlugin
- Parameters:
context
- The current context of the client application, it is one of the values found in set returned byInteractivePlugin.getGuiContexts()
request
- Request object with the command and parametersresponse
- Response object in for the plugin to response through
-
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 interfaceSignalTarget
- Returns:
- A SignalHandler object, or null if the current instance doesn't support signals
-
getConfigureJobParameters
-