2.17.2: 2011-06-17

net.sf.basedb.plugins.executor
Class BfsExporterSupport

java.lang.Object
  extended by net.sf.basedb.core.plugin.AbstractPlugin
      extended by net.sf.basedb.plugins.executor.AbstractIOSupport
          extended by net.sf.basedb.plugins.executor.BfsExporterSupport
All Implemented Interfaces:
InteractivePlugin, Plugin, IOSupport

public class BfsExporterSupport
extends AbstractIOSupport

Exporter implementation for the external program executor that exports data to BFS format.

Since:
2.15
Author:
nicklas
Last modified
$Date $

Nested Class Summary
 
Nested classes/interfaces inherited from interface net.sf.basedb.core.plugin.Plugin
Plugin.MainType
 
Field Summary
private static About about
           
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
BfsExporterSupport()
           
 
Method Summary
private  void checkUniqueFields(String fields, String parameter)
           
 void configure(GuiContext context, Request request, Response response)
          Configure the plugin.
 About getAbout()
          Get information about the plugin, such as name, version, authors, etc.
private  RequestInformation getConfigureExecutorParameters(String command)
           
 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.
 
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
checkInterrupted, 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

about

private static final About about

configureExecutor

private RequestInformation configureExecutor
Constructor Detail

BfsExporterSupport

public BfsExporterSupport()
Method Detail

getAbout

public About getAbout()
Description copied from interface: Plugin
Get information about the plugin, such as name, version, authors, etc.

Returns:
An About object

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 by InteractivePlugin.getRequestInformation(GuiContext, String).

Parameters:
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 parameters
response - 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 the RequestInformation 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 by InteractivePlugin.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 interface IOSupport
Overrides:
getShortName in class AbstractIOSupport
Returns:
The name of the plugin (eg. getAbout().getName())

getConfigureExecutorParameters

private RequestInformation getConfigureExecutorParameters(String command)

checkUniqueFields

private void checkUniqueFields(String fields,
                               String parameter)

performIO

protected String performIO(DbControl dc,
                           ProgressReporter progress)
                    throws IOException
Description copied from class: AbstractIOSupport
Perform the IO operation.

Specified by:
performIO in class AbstractIOSupport
Parameters:
dc - A DbControl that can be used by the subclass
progress - An optional progress reporter
Returns:
A message that is returned as to the external program executor
Throws:
IOException

2.17.2: 2011-06-17