org.electrocodeogram.cpc.imports.api.imports
Interface IImportController

public interface IImportController

Main backend controller for the CPC Imports module.
Can be used to execute clone data imports via registered IImportToolAdapters.

An instance can be obtained via CPCImportsPlugin.getImportController().

Author:

vw

See Also:

IImportToolAdapter, IImportFilterStrategy

Method Summary

IImportTask	createTask() Creates a new empty IImportTask object which can then be filled with the task configuration options and data.
org.electrocodeogram.cpc.importexport.api.generic.IGenericStatus	executeImport(org.eclipse.core.runtime.IProgressMonitor monitor, IImportTask importTask) Executes the complete import process using the IImportToolAdapter which corresponds to the given IImportToolAdapterDescriptor.
java.util.List<IImportFilterStrategyDescriptor>	getRegisteredImportFilterStrategies() Retrieves a list of all currently registered IImportFilterStrategy implementations.
java.util.List<IImportToolAdapterDescriptor>	getRegisteredImportToolAdapters() Retrieves a list of all currently registered IImportToolAdapter implementations.

Method Detail

getRegisteredImportToolAdapters

java.util.List<IImportToolAdapterDescriptor> getRegisteredImportToolAdapters()

Retrieves a list of all currently registered IImportToolAdapter implementations.

Returns:

list of all registered IImportToolAdapter implementations, never null.

getRegisteredImportFilterStrategies

java.util.List<IImportFilterStrategyDescriptor> getRegisteredImportFilterStrategies()

Retrieves a list of all currently registered IImportFilterStrategy implementations.

Returns:

list of all registered IImportFilterStrategy implementations, never null.

createTask

IImportTask createTask()

Creates a new empty IImportTask object which can then be filled with the task configuration options and data.
Once filled, the object can be passed to executeImport(IProgressMonitor, IImportTask) to execute the import task.

Returns:

an empty task object, never null.

executeImport

org.electrocodeogram.cpc.importexport.api.generic.IGenericStatus executeImport(org.eclipse.core.runtime.IProgressMonitor monitor,
                                                                               IImportTask importTask)
                                                                               throws org.electrocodeogram.cpc.importexport.api.generic.ImportExportConfigurationOptionException,
                                                                                      org.electrocodeogram.cpc.importexport.api.generic.ImportExportFailureException,
                                                                                      java.lang.InterruptedException

Executes the complete import process using the IImportToolAdapter which corresponds to the given IImportToolAdapterDescriptor.

Import Process:

• all source files in the given projects are collected
• the IImportToolAdapter is called to process these files
• the returned clone data is passed to the registered IImportFilterStrategys
• the resulting clone data is transmitted to the IStoreProvider

Parameters:

monitor - a progress monitor for progress reporting and cancellation, may be NULL.

importTask - the import task to process, never null.

Returns:

clone import statistics, never null.

Throws:

org.electrocodeogram.cpc.importexport.api.generic.ImportExportConfigurationOptionException - if the given configuration options are illegal.

org.electrocodeogram.cpc.importexport.api.generic.ImportExportFailureException - if any error occurred during the import process.

java.lang.InterruptedException - if the import was cancelled by the user.