edu.illinois.ncsa.datawolf

Class ImportExport

java.lang.Object

edu.illinois.ncsa.datawolf.ImportExport

public class ImportExport
extends Object

Constructor Summary

Constructors

Constructor and Description
ImportExport()

Method Summary

Methods

Modifier and Type	Method and Description
static void	exportDataset(File file, String datasetId) Exports the given dataset to a zip file.
static void	exportExecution(File file, String executionId) Exports the given execution to a zip file.
static void	exportLogfile(File file, String logfileId) Exports the given logfile to a textfile.
static void	exportStep(File file, String stepId, String executionId) Exports the given step to a zip file.
static void	exportTool(File file, String toolId) Exports the given tool to a zip file.
static void	exportWorkflow(File file, String workflowId) Exports the given workflow to a zip file.
static Dataset	importDataset(File file) Imports the dataset from the zipfile.
static WorkflowTool	importTool(File file) Imports the tool from the zipfile.
static Workflow	importWorkflow(File file) Imports the workflow from the zipfile.

Methods inherited from class java.lang.Object

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

Constructor Detail

ImportExport

public ImportExport()

Method Detail

exportWorkflow

public static void exportWorkflow(File file,
                  String workflowId)
                           throws Exception

Exports the given workflow to a zip file. The complete workflow will be exported as a JSON object, including people definitions as well as tools. The blobs associated with the tools will be exported as well.

Parameters:

file - the zipfile where the workflow will be saved, this file will be overwritten.

workflowId - the id of the workflow to export.

Throws:

Exception - an exception is thrown if the workflow could not be saved.

importWorkflow

public static Workflow importWorkflow(File file)
                               throws Exception

Imports the workflow from the zipfile. The complete workflow will be imported, including people definitions as well as tools. The blobs associated with the tools will be imported as well. This will return the workflow imported after it is persisted.

Parameters:

file - the zipfile where the workflow is saved.

Returns:

the persisted workflow.

Throws:

Exception - an exception is thrown if the workflow could not be loaded.

exportTool

public static void exportTool(File file,
              String toolId)
                       throws Exception

Exports the given tool to a zip file. The complete tool will be exported as a JSON object, including people definitions. The blobs associated with the tools will be exported as well.

Parameters:

file - the zipfile where the tool will be saved, this file will be overwritten.

toolId - the id of the tool to export.

Throws:

Exception - an exception is thrown if the tool could not be saved.

importTool

public static WorkflowTool importTool(File file)
                               throws Exception

Imports the tool from the zipfile. The complete tool will be imported, including people definitions. The blobs associated with the tool will be imported as well. This will return the tool imported after it is persisted.

Parameters:

file - the zipfile where the tool is saved

Returns:

the persisted tool.

Throws:

Exception - an exception is thrown if the tool could not be loaded.

exportExecution

public static void exportExecution(File file,
                   String executionId)
                            throws Exception

Exports the given execution to a zip file. The complete execution will be exported as a JSON object, including all outputs generated during the execution

Parameters:

file - the zipfile where the execution will be saved, this file will be overwritten.

executionId - the id of the exection to export.

Throws:

Exception - an exception is thrown if the execution could not be saved.

exportStep

public static void exportStep(File file,
              String stepId,
              String executionId)
                       throws Exception

Exports the given step to a zip file. The complete step will be exported as a JSON object, including all outputs generated during the specific execution.

Parameters:

file - the zipfile where the step will be saved, this file will be overwritten.

stepId - the id of the step to export.

executionId - the id of the exection to find the data to export.

Throws:

Exception - an exception is thrown if the step could not be saved.

exportDataset

public static void exportDataset(File file,
                 String datasetId)
                          throws Exception

Exports the given dataset to a zip file. The complete dataset will be exported as a JSON object, including blobs.

Parameters:

file - the zipfile where the dataset will be saved, this file will be overwritten.

datasetId - the id of the dataset to export.

Throws:

Exception - an exception is thrown if the dataset could not be saved.

importDataset

public static Dataset importDataset(File file)
                             throws Exception

Imports the dataset from the zipfile. The blobs associated with the dataset will be imported. This will return the dataset imported after it is persisted.

Parameters:

file - the zipfile where the dataset (json) will be saved, this file will be overwritten.

Returns:

the persisted dataset.

Throws:

Exception - an exception is thrown if the dataset could not be saved.

exportLogfile

public static void exportLogfile(File file,
                 String logfileId)
                          throws Exception

Exports the given logfile to a textfile.

Parameters:

file - the textfile where the log will be saved, this file will be overwritten.

logfileId - the id of the workflow to export.

Throws:

Exception - an exception is thrown if the logfile could not be saved.