public class BaseFileImporterSupport extends AbstractIOSupport
Plugin.MainType
Modifier and Type | Field and Description |
---|---|
private RequestInformation |
configureExecutor |
private RequestInformation |
configureJob |
annotationSection, configuration, COPY_ANNOTATIONS, job, OVERWRITE_ANNOTATIONS, sc
COMMAND_CONFIGURE_IO_JOB, COMMAND_CONFIGURE_IO_PLUGIN, COMMAND_EXECUTE_IO_JOB
Constructor and Description |
---|
BaseFileImporterSupport() |
Modifier and Type | Method and Description |
---|---|
void |
configure(GuiContext context,
Request request,
Response response)
Configure the plugin.
|
private RequestInformation |
getConfigureExecutorParameters(String command) |
private RequestInformation |
getConfigureJobParameters(String command) |
private Directory |
getExtraFilesDirectory(DbControl dc,
String pathName) |
Plugin.MainType |
getMainType()
Get the type of the plugin.
|
RequestInformation |
getRequestInformation(GuiContext context,
String command)
This method will return the
RequestInformation for a given command, i.e. |
String |
getShortName()
A default implementation to maintain backwards compatibility.
|
protected String |
performIO(DbControl dc,
ProgressReporter progress)
Perform the IO operation.
|
getExecutor, getGuiContexts, init, isInContext, requiresConfiguration, run, supportsConfigurations
cloneParameterWithDefaultValue, closeLogFile, createLogFile, done, getCopyAnnotationsParmeter, getCurrentConfiguration, getCurrentJob, getJobOrConfigurationValue, getOverwriteAnnotationsParameters, getPermissions, init, log, log, storeValue, storeValue, storeValues, validateRequestParameters
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
done, getPermissions, init
private RequestInformation configureExecutor
private RequestInformation configureJob
public Plugin.MainType getMainType()
Plugin
public void configure(GuiContext context, Request request, Response response)
InteractivePlugin
InteractivePlugin.getRequestInformation(GuiContext, String)
.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 parametersresponse
- Response object in for the plugin to response
throughpublic RequestInformation getRequestInformation(GuiContext context, String command) throws BaseException
InteractivePlugin
RequestInformation
for a given command, i.e.
the list of parameters and some nice help text.context
- The current context of the client application,
it is one of the values found in set returned by InteractivePlugin.getGuiContexts()
command
- The commandRequestInformation
for the commandBaseException
- if there is an errorpublic String getShortName()
AbstractIOSupport
getShortName
in interface IOSupport
getShortName
in class AbstractIOSupport
protected String performIO(DbControl dc, ProgressReporter progress) throws IOException
AbstractIOSupport
performIO
in class AbstractIOSupport
dc
- A DbControl that can be used by the subclassprogress
- An optional progress reporterIOException
private RequestInformation getConfigureExecutorParameters(String command)
private RequestInformation getConfigureJobParameters(String command)