org.eclipse.emf.emfstore.internal.client.importexport

Interface IExportImportController

All Known Implementing Classes:

ExportChangesController, ExportProjectController, ExportProjectHistoryController, ExportProjectSpaceController, ExportWorkspaceController, ImportChangesController, ImportProjectController, ImportProjectHistoryController, ImportProjectSpaceController, ProjectSpaceBasedExportController

public interface IExportImportController

Generic interface that is used for both export and import.

Author:

emueller

Method Summary

Modifier and Type	Method and Description
void	execute(File file, org.eclipse.core.runtime.IProgressMonitor progressMonitor) Executes the controller.
String	getFilename() Returns the file name that is used for export/import.
String[]	getFilteredExtensions() Returns an array of extensions that should be filtered in the export/import dialog.
String[]	getFilteredNames() Returns an array of names that should be filtered in the export/import dialog.
String	getLabel() The label that should be shown while exporting/importing.
String	getParentFolderPropertyKey() Returns the key that is used to cache the last location of the export/import performed.
boolean	isExport() Whether this controller is an export controller.

Method Detail

getLabel

String getLabel()

The label that should be shown while exporting/importing.

Returns:

a label that best describes the export/import process

getFilteredNames

String[] getFilteredNames()

Returns an array of names that should be filtered in the export/import dialog.

Returns:

an array of filtered names

getFilteredExtensions

String[] getFilteredExtensions()

Returns an array of extensions that should be filtered in the export/import dialog.

Returns:

an array of file extensions

getParentFolderPropertyKey

String getParentFolderPropertyKey()

Returns the key that is used to cache the last location of the export/import performed.

Returns:

a property key identifier

execute

void execute(File file,
             org.eclipse.core.runtime.IProgressMonitor progressMonitor)
      throws IOException

Executes the controller.

Parameters:

file - the File that is either exported to or imported

progressMonitor - an IProgressMonitor that is used to inform about the progress of the export/import process

Throws:

IOException - in case an error occurs during export/import

getFilename

String getFilename()

Returns the file name that is used for export/import.

Returns:

the file name

isExport

boolean isExport()

Whether this controller is an export controller.

Returns:

true, if this controller exports an entity of type T, otherwise this controller imports an entity of type T