org.datacleaner.windows

Interface AnalysisJobBuilderWindow

All Superinterfaces:

DCWindow

public interface AnalysisJobBuilderWindow
extends DCWindow

This interface represents the main window in the DataCleaner GUI. An AnalysisJobBuilderWindow has it's name because it's primary purpose is to present a job that is being built. Behind the covers this job state is respresented in the AnalysisJobBuilder class. Besides job building, an AnalysisJobBuilderWindow also handles datastore selection and menus in general.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	AnalysisJobBuilderWindow.AnalysisWindowPanelType

Method Summary

Modifier and Type	Method and Description
void	applyPropertyValues() Applies property values for all job components visible in the window.
void	changePanel(AnalysisJobBuilderWindow.AnalysisWindowPanelType panel) Changes the current panel showing in the builder
org.datacleaner.job.builder.AnalysisJobBuilder	getAnalysisJobBuilder() Gets the AnalysisJobBuilder that the window currently represents.
org.apache.commons.vfs2.FileObject	getJobFile() Gets the current job file
java.lang.String	getStatusLabelText() Gets the status text of the status label.
boolean	isDatastoreSelectionEnabled() Gets whether datastore selection is enabled.
boolean	isDatastoreSet() Gets whether or not the datastore has been set in this window (ie.
void	setDatastore(Datastore datastore) Initializes the window to use a particular datastore in the schema tree.
void	setDatastore(Datastore datastore, boolean expandTree) Initializes the window to use a particular datastore in the schema tree.
void	setDatastoreSelectionEnabled(boolean datastoreSelectionEnabled) Sets whether or not datastore selection should be enabled (default is true).
void	setJobFile(org.apache.commons.vfs2.FileObject jobFile) Sets the job file of the window (will be visible in the title and more).
void	setStatusLabelError() Sets the icon of the status label to indicate an error situation
void	setStatusLabelNotice() Sets the icon of the status label to indicate an notice/informational situation
void	setStatusLabelText(java.lang.String statusLabelText) Sets the status label text.
void	setStatusLabelValid() Sets the icon of the status label to indicate an valid situation
void	setStatusLabelWarning() Sets the icon of the status label to indicate a warning situation

Methods inherited from interface org.datacleaner.windows.DCWindow

close, getWindowContext, getWindowIcon, getWindowTitle, open, toComponent, toFront

Method Detail

isDatastoreSet

boolean isDatastoreSet()

Gets whether or not the datastore has been set in this window (ie. if the tree is showing a datastore).

Returns:

true if a datastore is set.

setDatastore

void setDatastore(Datastore datastore)

Initializes the window to use a particular datastore in the schema tree.

Parameters:

datastore -

setDatastore

void setDatastore(Datastore datastore,
                  boolean expandTree)

Initializes the window to use a particular datastore in the schema tree.

Parameters:

datastore -

expandTree - true if the datastore tree should be initially expanded.

setJobFile

void setJobFile(org.apache.commons.vfs2.FileObject jobFile)

Sets the job file of the window (will be visible in the title and more).

Parameters:

jobFile -

getJobFile

org.apache.commons.vfs2.FileObject getJobFile()

Gets the current job file

Returns:

setDatastoreSelectionEnabled

void setDatastoreSelectionEnabled(boolean datastoreSelectionEnabled)

Sets whether or not datastore selection should be enabled (default is true). If disabled, only a single datastore will be usable within this window.

Parameters:

datastoreSelectionEnabled -

isDatastoreSelectionEnabled

boolean isDatastoreSelectionEnabled()

Gets whether datastore selection is enabled.

Returns:

a boolean indicating whether or not datastore selection is enabled.

See Also:

setDatastoreSelectionEnabled(boolean)

applyPropertyValues

void applyPropertyValues()

Applies property values for all job components visible in the window.

getStatusLabelText

java.lang.String getStatusLabelText()

Gets the status text of the status label. Useful if something goes wrong - this status label will typically have a humanly readable explanation.

Returns:

setStatusLabelText

void setStatusLabelText(java.lang.String statusLabelText)

Sets the status label text. Note that the status label text changes based on multiple events, so the duration of a given text may not be for long.

Parameters:

statusLabelText -

setStatusLabelError

void setStatusLabelError()

Sets the icon of the status label to indicate an error situation

setStatusLabelWarning

void setStatusLabelWarning()

Sets the icon of the status label to indicate a warning situation

setStatusLabelValid

void setStatusLabelValid()

Sets the icon of the status label to indicate an valid situation

setStatusLabelNotice

void setStatusLabelNotice()

Sets the icon of the status label to indicate an notice/informational situation

getAnalysisJobBuilder

org.datacleaner.job.builder.AnalysisJobBuilder getAnalysisJobBuilder()

Gets the AnalysisJobBuilder that the window currently represents.

Returns:

changePanel

void changePanel(AnalysisJobBuilderWindow.AnalysisWindowPanelType panel)

Changes the current panel showing in the builder

Parameters:

panel -