public class PackedFileExporter extends AbstractExporterPlugin implements InteractivePlugin, SignalTarget
FilePacker
interface. To add new formats, create a class that implements the interface and,
register the new class with a PluginConfiguration
item.
The compressed file can either be downloaded immediately to the local computer or stored into BASE's file system.
Plugin.MainType
Modifier and Type | Field and Description |
---|---|
private RequestInformation |
configureJob |
private RequestInformation |
configurePlugin |
private DbControl |
dc |
private static GuiContext |
directoryGui |
private static GuiContext |
fileGui |
private static java.util.Set<GuiContext> |
guiContexts |
private int |
numFiles |
private PluginParameter<java.lang.String> |
packerParameter |
private static java.util.Set<Permissions> |
permissions |
private PluginParameter<java.lang.Boolean> |
removeFilesParameter |
private java.util.List<java.lang.Integer> |
selectedDirs |
private java.util.List<java.lang.Integer> |
selectedFiles |
private java.util.List<Nameable> |
selectedFilesAndDirs |
private ThreadSignalHandler |
signalHandler |
private long |
totalBytes |
optionalSaveAsType, OVERWRITE, overwriteType, requiredSaveAsType, SAVE_AS
annotationSection, configuration, COPY_ANNOTATIONS, job, OVERWRITE_ANNOTATIONS, sc
Constructor and Description |
---|
PackedFileExporter()
Create new instance.
|
Modifier and Type | Method and Description |
---|---|
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.
|
private java.lang.String |
generateDefaultName(FilePacker packer,
Directory rootDir,
java.util.Collection<Nameable> selectedItems)
Generate a default name without a path for the packed file.
|
private java.lang.String |
generateDefaultPath(FilePacker packer,
Directory rootDir,
java.util.Collection<Nameable> selectedItems)
Generate a default path for the packed file.
|
private RequestInformation |
getConfigureJobParameters(GuiContext context,
java.lang.Boolean requireFile) |
private RequestInformation |
getConfigurePluginParameters() |
java.util.Set<GuiContext> |
getGuiContexts()
Get a set containing all items that the plugin handles.
|
private FilePacker |
getPacker()
Get the FilePacker that has been configured in the current configuration.
|
private FilePacker |
getPacker(java.lang.String packerClass)
Create a FilePacker from the given class.
|
java.util.Collection<Permissions> |
getPermissions()
Request create and delete access to File:s and Directory:s.
|
RequestInformation |
getRequestInformation(GuiContext context,
java.lang.String command)
This method will return the
RequestInformation for a given command, i.e. |
SignalHandler |
getSignalHandler()
Get the signal handler that is handling signals on behalf of this
object.
|
protected java.lang.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.
|
java.lang.String |
isInContext(GuiContext context,
java.lang.Object item)
Check that at least one file or directory has been selected.
|
private void |
loadFiles(DbControl dc,
java.util.Collection<Nameable> loadedFiles,
Directory directory)
Load files and subdirectories in the given directory.
|
private void |
loadFilesAndDirectories(DbControl dc,
java.util.Collection<Nameable> loadedFiles,
java.util.Collection<java.lang.Integer> files,
java.util.Collection<java.lang.Integer> directories,
boolean recursive)
Load specified files and directories and put them in
loadedFiles . |
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.
|
doExport, getMainType, getOverwrite, getOverwriteParameter, getSaveAsParameter, getSaveAsPath, getSaveTo, pathCanBeUsed, run
cloneParameterWithDefaultValue, closeLogFile, createLogFile, done, getCopyAnnotationsParmeter, getCurrentConfiguration, getCurrentJob, getJobOrConfigurationValue, getOverwriteAnnotationsParameters, init, log, log, storeValue, storeValue, storeValues, validateRequestParameters
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
done, getMainType, init, run
private static final GuiContext fileGui
private static final GuiContext directoryGui
private static final java.util.Set<GuiContext> guiContexts
private static final java.util.Set<Permissions> permissions
private RequestInformation configureJob
private RequestInformation configurePlugin
private PluginParameter<java.lang.Boolean> removeFilesParameter
private PluginParameter<java.lang.String> packerParameter
private int numFiles
private long totalBytes
private java.util.List<java.lang.Integer> selectedFiles
private java.util.List<java.lang.Integer> selectedDirs
private java.util.List<Nameable> selectedFilesAndDirs
private ThreadSignalHandler signalHandler
private DbControl dc
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 java.util.Collection<Permissions> getPermissions()
getPermissions
in interface Plugin
getPermissions
in class AbstractPlugin
public java.util.Set<GuiContext> getGuiContexts()
InteractivePlugin
Item.REPORTER
.
This information is used by client applications to put the plugin
in the proper place in the user interface.getGuiContexts
in interface InteractivePlugin
Set
containing Item
:s, or null
if the plugin is not concerned about itemspublic java.lang.String isInContext(GuiContext context, java.lang.Object item)
isInContext
in interface InteractivePlugin
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
contextNull
if the plugin can use that item, or
a warning-level message explaining why the plugin can't be usedpublic RequestInformation getRequestInformation(GuiContext context, java.lang.String command) throws BaseException
InteractivePlugin
RequestInformation
for a given command, i.e.
the list of parameters and some nice help text.getRequestInformation
in interface InteractivePlugin
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 void configure(GuiContext context, Request request, Response response)
InteractivePlugin
InteractivePlugin.getRequestInformation(GuiContext, String)
.configure
in interface InteractivePlugin
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
throughprotected void begin(DbControl dc)
AbstractExporterPlugin
begin
in class AbstractExporterPlugin
dc
- The DbControl that is used to write to the database.
A subclass may use this read from the database as wellAbstractExporterPlugin.end(boolean)
protected void performExport(ExportOutputStream out, ProgressReporter progress) throws java.io.IOException
AbstractExporterPlugin
ImmediateDownloadExporter.doExport(ExportOutputStream, ProgressReporter)
method.performExport
in class AbstractExporterPlugin
out
- Output stream to write the exported data toprogress
- An optional progress reporterjava.io.IOException
protected void end(boolean success)
AbstractExporterPlugin
AbstractExporterPlugin.begin(DbControl)
method here.end
in class AbstractExporterPlugin
success
- TRUE if the file was parsed successfully, FALSE otherwiseAbstractExporterPlugin.begin(DbControl)
protected java.lang.String getSuccessMessage()
AbstractExporterPlugin
178 reporters exported successfully
.
The default implementation always return null.getSuccessMessage
in class AbstractExporterPlugin
public SignalHandler getSignalHandler()
SignalTarget
getSignalHandler
in interface SignalTarget
private RequestInformation getConfigureJobParameters(GuiContext context, java.lang.Boolean requireFile)
private RequestInformation getConfigurePluginParameters()
private void loadFilesAndDirectories(DbControl dc, java.util.Collection<Nameable> loadedFiles, java.util.Collection<java.lang.Integer> files, java.util.Collection<java.lang.Integer> directories, boolean recursive)
loadedFiles
.
This method also calculates the total size of all files and stores it in
totalBytes
.dc
- The DbControl to use for loadingloadedFiles
- The files and directories will be added to this collectionfiles
- The ID of the files to loaddirectories
- The ID of the directories to loadrecursive
- If we should recurse into subdirectories or notprivate void loadFiles(DbControl dc, java.util.Collection<Nameable> loadedFiles, Directory directory)
dc
- The DbControl to use for loadingloadedFiles
- The files and directories will be added to this collectiondirectory
- The parent directoryprivate FilePacker getPacker()
private FilePacker getPacker(java.lang.String packerClass) throws java.lang.Exception
packerClass
- The class name of a class that implements FilePackerjava.lang.Exception
private java.lang.String generateDefaultPath(FilePacker packer, Directory rootDir, java.util.Collection<Nameable> selectedItems)
FilePacker.getFileExtension()
is
automatically appeneded.packer
- The current FilePackerrootDir
- The root directoryselectedItems
- The selected items (not including subdirectories)private java.lang.String generateDefaultName(FilePacker packer, Directory rootDir, java.util.Collection<Nameable> selectedItems)