Humboldt Alignment Editor 2.5.0

eu.esdihumboldt.hale.ui.io
Interface ImportSource<P extends ImportProvider>

Type Parameters:
P - the supported IOProvider type
All Known Implementing Classes:
AbstractProviderSource, AbstractSource, AbstractWFSSource, FileSource, PresetsSource, URLSource, WFSDescribeFeatureSource, WFSGetFeatureSource

public interface ImportSource<P extends ImportProvider>

Import source for an ImportWizard

Since:
2.5
Author:
Simon Templer

Nested Class Summary
static interface ImportSource.SourceConfiguration<P extends ImportProvider>
          Configuration based on an import source.
 
Method Summary
 void createControls(org.eclipse.swt.widgets.Composite parent)
          Create the controls that enable the user to define the import source.
 void dispose()
          Dispose any resources when the source page is disposed.
 void onActivate()
          Method that is called when the source page is activated.
 void setConfiguration(ImportSource.SourceConfiguration<P> config)
          Sets the source configuration to populate.
 void setPage(org.eclipse.jface.wizard.WizardPage page)
          Sets the containing wizard page.
 boolean updateConfiguration(P provider)
          Update the configuration (of the I/O provider).
 

Method Detail

setPage

void setPage(org.eclipse.jface.wizard.WizardPage page)
Sets the containing wizard page. It may be used for displaying messages.

Parameters:
page - the wizard page

setConfiguration

void setConfiguration(ImportSource.SourceConfiguration<P> config)
Sets the source configuration to populate.

Parameters:
config - the source configuration

createControls

void createControls(org.eclipse.swt.widgets.Composite parent)
Create the controls that enable the user to define the import source. setPage(WizardPage) and setConfiguration(SourceConfiguration) must have been called before calling this method.

Parameters:
parent - the parent composite, implementors may assign a custom layout to this composite

updateConfiguration

boolean updateConfiguration(P provider)
Update the configuration (of the I/O provider). This is executed right before the execution.

Parameters:
provider - the I/O provider to update
Returns:
if the source is valid and updating the provider was successful

onActivate

void onActivate()
Method that is called when the source page is activated.


dispose

void dispose()
Dispose any resources when the source page is disposed.


Humboldt Alignment Editor 2.5.0

Build 2012-12-03_12-30-59
Revision 9d2dd4b0318cda9f1393b1ddd390f7f792d70a2d