Package pulse.io.export

Class ExportManager

java.lang.Object

pulse.io.export.ExportManager

public class ExportManager
extends Object

Manages export operations. Provides tools to find a specific exporter suitable for a given target and shortcuts for export operations.

Method Summary

Modifier and Type	Method	Description
static <T extends Descriptive> void	askToExport(T target, JFrame parentWindow, String fileTypeLabel)	Finds an exporter matching to target and allows the user to select the location of export.
static <T extends Descriptive> void	export(T target, File directory, Extension extension)	Attempts to export the given target to the directory by saving the contents in a file with the given Extension.
static void	exportAllResults(File directory, Extension extension)	Exports all results generated previously during task execution for all tasks listed by the TaskManager, provided those tasks had the respective result assigned to them.
static void	exportAllTasks(File directory, Extension extension)	This will invoke exportGroup on each task listed by the TaskManager.
static void	exportCurrentTask(File directory)	Exports the currently selected task as a group of objects using the default export extension.
static void	exportCurrentTask(File directory, Extension extension)	Exports the currently selected task as a group of objects.
static void	exportGroup(Group group, File directory, Extension extension)	Fully exports group and all its contents to the root directory requesting the files to be saved with the extension.
static <T extends Descriptive> Exporter<T>	findExporter(Class<T> target)	Finds an exporter that can work with target.
static <T extends Descriptive> Exporter<T>	findExporter(T target)	Finds a suitable exporter for a non-null target by calling findExporter(target.getClass()).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

findExporter

public static <T extends Descriptive> Exporter<T> findExporter(T target)

Finds a suitable exporter for a non-null target by calling findExporter(target.getClass()).

Type Parameters:

T - an instance of Descriptive

Parameters:

target - the exported target

Returns:

an exporter that works for target

See Also:

<T>findExporter(T)

findExporter

public static <T extends Descriptive> Exporter<T> findExporter(Class<T> target)

Finds an exporter that can work with target.

Searches through available instances of the Exporter class contained in this package and checks if any of those have their target set to the argument of this method, then returns the first occurrence. If nothing matches exactly the same class as specified, searches for exporters of any classes assignable from target.

Type Parameters:

T - an instance of Descriptive

Parameters:

target - the target glass

Returns:

an instance of the Exporter class that can work worth the type T, null if nothing has been found

askToExport

public static <T extends Descriptive> void askToExport(T target,
                                                       JFrame parentWindow,
                                                       String fileTypeLabel)

Finds an exporter matching to target and allows the user to select the location of export.

Type Parameters:

T - a Descriptive type

Parameters:

target - the target to be exported

parentWindow - a frame to which the file chooser dialog will be attached

fileTypeLabel - a brief description of the exported file types

Throws:

IllegalArgumentException - if no exporter can be found

See Also:

<T>findExporter(T)

export

public static <T extends Descriptive> void export(T target,
                                                  File directory,
                                                  Extension extension)

Attempts to export the given target to the directory by saving the contents in a file with the given Extension.

The file is formatted according to the inherent format, i.e. if it is an Extension.HTML file, it will contain HTML tags, etc. If extension is not present in the list of supported extension of an exporter matching target, this will revert to the first supported extension. This method will not have any result if no exporter has been found fot target.

Type Parameters:

T - the target type

Parameters:

target - the exported target

directory - a pre-selected directory

extension - the desired extension

exportAllTasks

public static void exportAllTasks(File directory,
                                  Extension extension)

This will invoke exportGroup on each task listed by the TaskManager.

Parameters:

directory - a pre-selected directory

extension - the desired extension

See Also:

exportGroup(pulse.util.Group,java.io.File,pulse.io.export.Extension), TaskManager

exportCurrentTask

public static void exportCurrentTask(File directory,
                                     Extension extension)

Exports the currently selected task as a group of objects.

Parameters:

directory - a pre-selected directory

extension - the desired extension

See Also:

exportGroup(pulse.util.Group,java.io.File,pulse.io.export.Extension)

exportCurrentTask

public static void exportCurrentTask(File directory)

Exports the currently selected task as a group of objects using the default export extension.

Parameters:

directory - a pre-selected directory

See Also:

exportGroup(pulse.util.Group,java.io.File,pulse.io.export.Extension)

exportAllResults

public static void exportAllResults(File directory,
                                    Extension extension)

Exports all results generated previously during task execution for all tasks listed by the TaskManager, provided those tasks had the respective result assigned to them.

Parameters:

directory - a pre-selected directory

extension - the desired extension

exportGroup

public static void exportGroup(Group group,
                               File directory,
                               Extension extension)

Fully exports group and all its contents to the root directory requesting the files to be saved with the extension.

If an Exporter exists that accepts the group as its argument, this will create files in the root directory in accordance to the root Exporter rules. All contents of the group will then be processed in a similar manner and the output will be stored in an internal directory, the name of which conforms to the respective description. Note this method is NOT recursive and it calls the export method of the ExportManager.

Parameters:

group - a group

directory - a pre-selected root directory

extension - the desired extension

Throws:

IllegalArgumentException - if directory is not a directory