|
3.2.4: 2013-12-06 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectnet.sf.basedb.core.plugin.AbstractPlugin
net.sf.basedb.plugins.CloneReportersPlugin
public class CloneReportersPlugin
A plug-in that clone reporter annotations to an experiment. To use, create
a Job
and make sure the Job.getExperiment()
is set.
Set the "template" parameter to a ReporterCloneTemplate
item to use
that as template for the cloning operation, or use null to clone all reporter
annotations. Set the "cloneSource" parameter to a name from the ReporterCloneBatcher.CloneSource
enumeration to use a specific reporter source.
Nested Class Summary |
---|
Nested classes/interfaces inherited from interface net.sf.basedb.core.plugin.Plugin |
---|
Plugin.MainType |
Field Summary | |
---|---|
private ThreadSignalHandler |
signalHandler
|
Fields inherited from class net.sf.basedb.core.plugin.AbstractPlugin |
---|
annotationSection, configuration, COPY_ANNOTATIONS, job, OVERWRITE_ANNOTATIONS, sc |
Constructor Summary | |
---|---|
CloneReportersPlugin()
|
Method Summary | |
---|---|
Plugin.MainType |
getMainType()
Get the type of the plugin. |
Collection<Permissions> |
getPermissions()
Request write permission to Experiment:s and Reporter clone templates and read permission to reporters. |
SignalHandler |
getSignalHandler()
Get the signal handler that is handling signals on behalf of this 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 |
---|
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 |
Field Detail |
---|
private ThreadSignalHandler signalHandler
Constructor Detail |
---|
public CloneReportersPlugin()
Method Detail |
---|
public Plugin.MainType getMainType()
Plugin
getMainType
in interface Plugin
public boolean supportsConfigurations()
AbstractPlugin
supportsConfigurations
in interface Plugin
supportsConfigurations
in class AbstractPlugin
public boolean requiresConfiguration()
AbstractPlugin
requiresConfiguration
in interface Plugin
requiresConfiguration
in class AbstractPlugin
public Collection<Permissions> getPermissions()
getPermissions
in interface Plugin
getPermissions
in class AbstractPlugin
public void run(Request request, Response response, ProgressReporter progress)
Plugin
run
in interface Plugin
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 nullpublic SignalHandler getSignalHandler()
SignalTarget
getSignalHandler
in interface SignalTarget
|
3.2.4: 2013-12-06 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |