Package net.sf.basedb.plugins.executor
Class BaseFileExporterSupport
- java.lang.Object
-
- net.sf.basedb.core.plugin.AbstractPlugin
-
- net.sf.basedb.plugins.executor.AbstractIOSupport
-
- net.sf.basedb.plugins.executor.BaseFileExporterSupport
-
- All Implemented Interfaces:
InteractivePlugin
,Plugin
,IOSupport
public class BaseFileExporterSupport extends AbstractIOSupport
Exporter implementation for the external program executor that exports data to BASEfile format.- Since:
- 2.16
- Author:
- nicklas
- Last modified
- $Date $
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface net.sf.basedb.core.plugin.Plugin
Plugin.MainType
-
-
Field Summary
Fields Modifier and Type Field Description private RequestInformation
configureExecutor
-
Fields inherited from class net.sf.basedb.core.plugin.AbstractPlugin
annotationSection, configuration, COPY_ANNOTATIONS, job, OVERWRITE_ANNOTATIONS, sc
-
Fields inherited from interface net.sf.basedb.plugins.executor.IOSupport
COMMAND_CONFIGURE_IO_JOB, COMMAND_CONFIGURE_IO_PLUGIN, COMMAND_EXECUTE_IO_JOB
-
-
Constructor Summary
Constructors Constructor Description BaseFileExporterSupport()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description private void
checkUniqueFields(String fields, String parameter)
void
configure(GuiContext context, Request request, Response response)
Configure the plugin.private RequestInformation
getConfigureExecutorParameters(String command)
Plugin.MainType
getMainType()
Get the type of the plugin.RequestInformation
getRequestInformation(GuiContext context, String command)
This method will return theRequestInformation
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.-
Methods inherited from class net.sf.basedb.plugins.executor.AbstractIOSupport
getExecutor, getGuiContexts, init, isInContext, requiresConfiguration, run, supportsConfigurations
-
Methods inherited from class net.sf.basedb.core.plugin.AbstractPlugin
cloneParameterWithDefaultValue, closeLogFile, createLogFile, done, getCopyAnnotationsParmeter, getCurrentConfiguration, getCurrentJob, getJobOrConfigurationValue, getOverwriteAnnotationsParameters, getPermissions, 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, getPermissions, init
-
-
-
-
Field Detail
-
configureExecutor
private RequestInformation configureExecutor
-
-
Method Detail
-
getMainType
public Plugin.MainType getMainType()
Description copied from interface:Plugin
Get the type of the plugin. This method must always return the same value.- Returns:
- One of the defined types
-
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 byInteractivePlugin.getRequestInformation(GuiContext, String)
.- 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
-
getRequestInformation
public RequestInformation getRequestInformation(GuiContext context, String command) throws BaseException
Description copied from interface:InteractivePlugin
This method will return theRequestInformation
for a given command, i.e. the list of parameters and some nice help text.- 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
-
getShortName
public String getShortName()
Description copied from class:AbstractIOSupport
A default implementation to maintain backwards compatibility. Plug-ins that want to return a different short name should override this method.- Specified by:
getShortName
in interfaceIOSupport
- Overrides:
getShortName
in classAbstractIOSupport
- Returns:
- The name of the plugin (eg. PluginDefinition.getName())
-
getConfigureExecutorParameters
private RequestInformation getConfigureExecutorParameters(String command)
-
performIO
protected String performIO(DbControl dc, ProgressReporter progress) throws IOException
Description copied from class:AbstractIOSupport
Perform the IO operation.- Specified by:
performIO
in classAbstractIOSupport
- Parameters:
dc
- A DbControl that can be used by the subclassprogress
- An optional progress reporter- Returns:
- A message that is returned as to the external program executor
- Throws:
IOException
-
-