org.esa.beam.framework.gpf.ui
Class SingleTargetProductDialog

java.lang.Object
  org.esa.beam.framework.ui.AbstractDialog
      org.esa.beam.framework.ui.ModelessDialog
          org.esa.beam.framework.gpf.ui.SingleTargetProductDialog

Direct Known Subclasses:

DefaultSingleTargetProductDialog

public abstract class SingleTargetProductDialog
extends ModelessDialog

WARNING: This class belongs to a preliminary API and may change in future releases.

Version:

$Revision$ $Date$

Author:

Norman Fomferra, Marco Peters

Field Summary

Fields inherited from class org.esa.beam.framework.ui.ModelessDialog

ID_APPLY_CLOSE, ID_APPLY_CLOSE_HELP

Fields inherited from class org.esa.beam.framework.ui.AbstractDialog

ID_APPLY, ID_CANCEL, ID_CLOSE, ID_HELP, ID_NO, ID_OK, ID_OTHER, ID_RESET, ID_YES

Constructor Summary

protected	SingleTargetProductDialog(AppContext appContext, String title, int buttonMask, String helpID)
protected	SingleTargetProductDialog(AppContext appContext, String title, int buttonMask, String helpID, TargetProductSelectorModel model)
protected	SingleTargetProductDialog(AppContext appContext, String title, String helpID)

Method Summary

protected abstract Product	createTargetProduct() Creates the desired target product.
AppContext	getAppContext()
TargetProductSelector	getTargetProductSelector()
protected void	handleInitialisationError(Throwable t)
protected void	handleProcessingError(Throwable t)
protected void	onApply() Called if the "Apply" button has been clicked.
void	showSuppressibleInformationDialog(String infoMessage, String propertyName) Shows an information dialog on top of this dialog.

Methods inherited from class org.esa.beam.framework.ui.ModelessDialog

close

Methods inherited from class org.esa.beam.framework.ui.AbstractDialog

center, collectButtons, getButton, getButtonID, getButtonMask, getContent, getHelpID, getJDialog, getParent, getQualifiedPropertyName, getTitle, hide, onCancel, onClose, onHelp, onNo, onOK, onOther, onReset, onYes, registerButton, setButtonID, setContent, setContent, setHelpID, setTitle, show, showErrorDialog, showInformationDialog, showWarningDialog, verifyUserInput

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SingleTargetProductDialog

protected SingleTargetProductDialog(AppContext appContext,
                                    String title,
                                    String helpID)

SingleTargetProductDialog

protected SingleTargetProductDialog(AppContext appContext,
                                    String title,
                                    int buttonMask,
                                    String helpID)

SingleTargetProductDialog

protected SingleTargetProductDialog(AppContext appContext,
                                    String title,
                                    int buttonMask,
                                    String helpID,
                                    TargetProductSelectorModel model)

Method Detail

getAppContext

public AppContext getAppContext()

getTargetProductSelector

public TargetProductSelector getTargetProductSelector()

onApply

protected void onApply()

Description copied from class: AbstractDialog

Called if the "Apply" button has been clicked. The default implementation does nothing. Clients should override this method to implement meaningful behaviour.

Overrides:

onApply in class AbstractDialog

handleInitialisationError

protected void handleInitialisationError(Throwable t)

handleProcessingError

protected void handleProcessingError(Throwable t)

showSuppressibleInformationDialog

public void showSuppressibleInformationDialog(String infoMessage,
                                              String propertyName)

Shows an information dialog on top of this dialog. The shown dialog will contain a user option allowing to not show the message anymore.

Parameters:

infoMessage - The message.

propertyName - The (simple) property name used to store the user option in the application's preferences.

createTargetProduct

protected abstract Product createTargetProduct()
                                        throws Exception

Creates the desired target product. Usually, this method will be implemented by invoking one of the multiple GPF createProduct methods.

The method should throw a OperatorException in order to signal "nominal" processing errors, other exeption types are treated as internal errors.

Returns:

The target product.

Throws:

Exception - if an error occurs, an OperatorException is signaling "nominal" processing errors.