net.sf.basedb.clients.web.plugins
Class SimpleExport

java.lang.Object
  net.sf.basedb.core.plugin.AbstractPlugin
      net.sf.basedb.core.plugin.AbstractExporterPlugin
          net.sf.basedb.clients.web.plugins.SimpleExport

All Implemented Interfaces:

ImmediateDownloadExporter, InteractivePlugin, NonRestartable, Plugin, SignalTarget

public class SimpleExport
extends AbstractExporterPlugin
implements InteractivePlugin, SignalTarget, NonRestartable

Export plugin for exporting data from table listings in the web client. This plugin only works from within the web client, since it depends on context and table information. It must have access to the current query which means that it always must be executed immediately, since queries can't be saved as parameters.

Version:

2.0

Author:

Nicklas

Last modified

$Date: 2010-11-08 14:49:35 +0100 (Mon, 08 Nov 2010) $

Nested Class Summary

Nested classes/interfaces inherited from interface net.sf.basedb.core.plugin.Plugin

Plugin.MainType

Field Summary

private static About	about Plugin description
private static String	COLUMN_PREFIX
private RequestInformation	configureJob
private DbControl	dc
private static String	FORMAT
private static Set<GuiContext>	guiContexts
private static String	SAME_UNITS
private ThreadSignalHandler	signalHandler
private String	successMessage
private static String	WHICH_ITEMS
private static String	WHICH_PROPERTIES

Fields inherited from class net.sf.basedb.core.plugin.AbstractExporterPlugin

optionalSaveAsType, OVERWRITE, overwriteType, requiredSaveAsType, SAVE_AS

Fields inherited from class net.sf.basedb.core.plugin.AbstractPlugin

annotationSection, configuration, COPY_ANNOTATIONS, job, OVERWRITE_ANNOTATIONS, sc

Constructor Summary

SimpleExport()

Method Summary

protected void	begin(DbControl dc) Called just before the export starts.
void	configure(GuiContext context, Request request, Response response) Configure the plugin.
protected void	end(boolean success) Called just after everything has been committed to the database, or immediately after an error has ocurred.
void	exportProperties(DbControl dc, ExportOutputStream out, String format, List<ExportedProperty> exportedProperties, Item itemType, Query query, ProgressReporter progress) Exports properties from a query to an output stream.
About	getAbout() Get information about the plugin, such as name, version, authors, etc.
private PluginParameter<String>	getColumnPrefixParameter()
private RequestInformation	getConfigureJobParameters(GuiContext context)
private PluginParameter<String>	getFormatParameter()
Set<GuiContext>	getGuiContexts() Get a set containing all items that the plugin handles.
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.
private PluginParameter<Boolean>	getSameUnitsParameter()
SignalHandler	getSignalHandler() Get the signal handler that is handling signals on behalf of this object.
protected String	getSuccessMessage() Called if the export was successful to let the subclass generate a simple message that is sent back to the core and user interface.
private PluginParameter<String>	getWhichItemsParameter()
private PluginParameter<String>	getWhichPropertiesParameter()
private void	initGuiContexts()
String	isInContext(GuiContext context, Object item) Check if the plugin can be used on the specified object.
protected void	performExport(ExportOutputStream out, ProgressReporter progress) Perform the export.
boolean	requiresConfiguration() Returns FALSE, since that is how the plugins used to work before this method was introduced.
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.AbstractExporterPlugin

doExport, getOverwrite, getOverwriteParameter, getSaveAsParameter, getSaveAsPath, getSaveTo, pathCanBeUsed, run

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, run

Field Detail

about

private static final About about

Plugin description

guiContexts

private static final Set<GuiContext> guiContexts

configureJob

private RequestInformation configureJob

signalHandler

private ThreadSignalHandler signalHandler

dc

private DbControl dc

successMessage

private String successMessage

FORMAT

private static final String FORMAT

See Also:

Constant Field Values

WHICH_ITEMS

private static final String WHICH_ITEMS

See Also:

Constant Field Values

WHICH_PROPERTIES

private static final String WHICH_PROPERTIES

See Also:

Constant Field Values

COLUMN_PREFIX

private static final String COLUMN_PREFIX

See Also:

Constant Field Values

SAME_UNITS

private static final String SAME_UNITS

See Also:

Constant Field Values

Constructor Detail

SimpleExport

public SimpleExport()

Method Detail

getAbout

public About getAbout()

Description copied from interface: Plugin

Get information about the plugin, such as name, version, authors, etc.

Specified by:

getAbout in interface Plugin

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.

Specified by:

getMainType in interface Plugin

Overrides:

getMainType in class AbstractExporterPlugin

Returns:

MainType.EXPORT

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 interface Plugin

Overrides:

supportsConfigurations in class AbstractPlugin

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 interface Plugin

Overrides:

requiresConfiguration in class AbstractPlugin

Returns:

TRUE or FALSE

getGuiContexts

public Set<GuiContext> 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 containing Item.REPORTER. This information is used by client applications to put the plugin in the proper place in the user interface.

Specified by:

getGuiContexts in interface InteractivePlugin

Returns:

A Set containing Item:s, or null if the plugin is not concerned about items

isInContext

public String isInContext(GuiContext context,
                          Object item)

Description copied from interface: InteractivePlugin

Check if the plugin can be used on the specified object. The item is either a BasicItem or BasicData object, or null if called from a list context. A client application should only call this method for contexts matching one of the contexts in the set returned by the InteractivePlugin.getGuiContexts() method. For GuiContext.Type.ITEM contexts an item of the correct type should be passed as a parameter.

The plug-in can response with a null value indicating success, a warning-level message or throw an exception to indicate an error-level message. Client application should normally only show error-level messages to users, unless the user has requested to see warning messages.

NOTE! Before BASE 2.4 all messages were treated as error-level messages.

Specified by:

isInContext in interface InteractivePlugin

Parameters:

context - The current context of the client application, it is one of the values found in set returned by InteractivePlugin.getGuiContexts()

item - The currently active item, it's type should match the GuiContext.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

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.

Specified by:

getRequestInformation in interface InteractivePlugin

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

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).

Specified by:

configure in interface InteractivePlugin

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

begin

protected void begin(DbControl dc)

Description copied from class: AbstractExporterPlugin

Called just before the export starts. A subclass may override this method if it needs to initialise some resources.

Overrides:

begin in class AbstractExporterPlugin

Parameters:

dc - The DbControl that is used to write to the database. A subclass may use this read from the database as well

See Also:

AbstractExporterPlugin.end(boolean)

performExport

protected void performExport(ExportOutputStream out,
                             ProgressReporter progress)
                      throws IOException

Description copied from class: AbstractExporterPlugin

Perform the export. This method replaces the ImmediateDownloadExporter.doExport(ExportOutputStream, ProgressReporter) method.

Specified by:

performExport in class AbstractExporterPlugin

Parameters:

out - Output stream to write the exported data to

progress - An optional progress reporter

Throws:

IOException

end

protected void end(boolean success)

Description copied from class: AbstractExporterPlugin

Called just after everything has been committed to the database, or immediately after an error has ocurred. A subclass should clean up any resources aquired in the AbstractExporterPlugin.begin(DbControl) method here.

Overrides:

end in class AbstractExporterPlugin

Parameters:

success - TRUE if the file was parsed successfully, FALSE otherwise

See Also:

AbstractExporterPlugin.begin(DbControl)

getSuccessMessage

protected String getSuccessMessage()

Description copied from class: AbstractExporterPlugin

Called if the export was successful to let the subclass generate a simple message that is sent back to the core and user interface. An example message might by: 178 reporters exported successfully. The default implementation always return null.

Overrides:

getSuccessMessage in class AbstractExporterPlugin

getSignalHandler

public SignalHandler 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 interface SignalTarget

Returns:

A SignalHandler object, or null if the current instance doesn't support signals

initGuiContexts

private void initGuiContexts()

getConfigureJobParameters

private RequestInformation getConfigureJobParameters(GuiContext context)

getFormatParameter

private PluginParameter<String> getFormatParameter()

getWhichItemsParameter

private PluginParameter<String> getWhichItemsParameter()

getWhichPropertiesParameter

private PluginParameter<String> getWhichPropertiesParameter()

getColumnPrefixParameter

private PluginParameter<String> getColumnPrefixParameter()

getSameUnitsParameter

private PluginParameter<Boolean> getSameUnitsParameter()

exportProperties

public void exportProperties(DbControl dc,
                             ExportOutputStream out,
                             String format,
                             List<ExportedProperty> exportedProperties,
                             Item itemType,
                             Query query,
                             ProgressReporter progress)
                      throws IOException

Exports properties from a query to an output stream. The export can be either tab-separated text or XML.

Parameters:

dc - The DbControl to use when accessing the database

out - Output stream to export to.

format - Use 'xml' to export in XML-format. All other inputs will give a tab-separated format.

exportedProperties - A list of which properties to include in the export.

itemType - Kind of item the export is about

query - This query is used to get the items to export.

progress - Optional progress reporter to get overview of how the export is proceeding.

Throws:

IOException - If anything goes wrong with export to the output stream.