org.datacleaner.wizard

Interface JobWizard

public interface JobWizard

Defines a wizard which is shown on the DataCleaner welcome screen. The wizard can be used to create a job, which can either be opened in DataCleaner or be directly run.

Field Summary

Fields

Modifier and Type	Field and Description
static String	BUTTON_NEXT_ICON Icon for next button in wizard.
static String	BUTTON_NEXT_TEXT Text for next button in wizard.

Method Summary

Modifier and Type	Method and Description
String	getCategory() Gets the category the JobWizard belongs to.
String	getDescription() Gets the description of the wizard.
Icon	getIcon() Gets the icon which is shown for the wizard on the welcome screen, or null if none is defined for the wizard.
String	getTitle() Gets the title for the wizard.
boolean	isAvailable() Checks if all necessary components to use the wizard are available.
void	startWizard(DataCleanerConfiguration configuration, Datastore selectedDatastore, JobWizardCallback callback) Starts wizard when it is activated from the welcome screen, after a Datastore has been selected to use with it.

Field Detail

BUTTON_NEXT_TEXT

static final String BUTTON_NEXT_TEXT

Text for next button in wizard.

See Also:

Constant Field Values

BUTTON_NEXT_ICON

static final String BUTTON_NEXT_ICON

Icon for next button in wizard.

See Also:

Constant Field Values

Method Detail

isAvailable

boolean isAvailable()

Checks if all necessary components to use the wizard are available.

Returns:

true if the wizard can be used

getIcon

Icon getIcon()

Gets the icon which is shown for the wizard on the welcome screen, or null if none is defined for the wizard.

Returns:

an Icon

getTitle

String getTitle()

Gets the title for the wizard.

Returns:

Title for the wizard

getDescription

String getDescription()

Gets the description of the wizard. Describes what the wizard can be used for.

Returns:

description of the wizard

startWizard

void startWizard(DataCleanerConfiguration configuration,
                 Datastore selectedDatastore,
                 JobWizardCallback callback)

Starts wizard when it is activated from the welcome screen, after a Datastore has been selected to use with it.

Parameters:

configuration - DataCleanerConfiguration passed by DataCleaner

selectedDatastore - Datastore which is selected to use the wizard with

callback - JobWizardCallback which contains some signaling logic

getCategory

String getCategory()

Gets the category the JobWizard belongs to.

Returns:

A String representing the category