com.ibm.xtools.common.ui.wizards.handlers

Class AbstractExistingModelHandler

java.lang.Object

com.ibm.xtools.common.ui.wizards.handlers.AbstractExistingModelHandler

All Implemented Interfaces:

IExistingModelHandler

public abstract class AbstractExistingModelHandler
extends java.lang.Object
implements IExistingModelHandler

Abstract implementation of the IExistingModelHandler interface. This implementation splits the IExistingModelHandler.createFiles(IProgressMonitor, ExistingModelConfiguration) method into three steps; preFileCreation, doFileCreation, postFileCreation.

The default implementation of postFileCreation, opens the first newly created model in an eclipse editor.

Constructor Summary

Constructors

Constructor and Description
AbstractExistingModelHandler()

Method Summary

Modifier and Type	Method and Description
ExistingModelConfiguration	createExistingModelConfiguration(org.eclipse.core.resources.IFile sourceModel) Creates the existing model configuration for the given source model, to be populated by the wizard.
boolean	createFiles(org.eclipse.core.runtime.IProgressMonitor progressMonitor, ExistingModelConfiguration config) Creates model files using the data from the given existing model configuration.
protected abstract org.eclipse.core.resources.IFile[]	doCreateFiles(org.eclipse.core.runtime.IProgressMonitor progressMonitor, ExistingModelConfiguration config) Create the model files.
protected java.lang.String	getFinalPerspective(ExistingModelConfiguration config) Return the id which identifies a perspective to activate.
protected java.lang.String	getPreferredPerspectives(ExistingModelConfiguration config) Return a comma-separated list of perspective IDs.
protected boolean	postFileCreation(org.eclipse.core.runtime.IProgressMonitor progressMonitor, org.eclipse.core.resources.IFile[] files) Complete post file creation tasks.
protected boolean	preFileCreation(org.eclipse.core.runtime.IProgressMonitor progressMonitor, ExistingModelConfiguration config) Complete pre file creation tasks.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractExistingModelHandler

public AbstractExistingModelHandler()

Method Detail

createExistingModelConfiguration

public ExistingModelConfiguration createExistingModelConfiguration(org.eclipse.core.resources.IFile sourceModel)

Description copied from interface: IExistingModelHandler

Creates the existing model configuration for the given source model, to be populated by the wizard.

Specified by:

createExistingModelConfiguration in interface IExistingModelHandler

Parameters:

sourceModel - the source model to configure

Returns:

the existing model configuration to be populated by the wizard

createFiles

public final boolean createFiles(org.eclipse.core.runtime.IProgressMonitor progressMonitor,
                                 ExistingModelConfiguration config)

Description copied from interface: IExistingModelHandler

Creates model files using the data from the given existing model configuration.

Specified by:

createFiles in interface IExistingModelHandler

Parameters:

progressMonitor - the progress monitor

config - the existing model configuration data

Returns:

true if model(s) are created successfully, false otherwise

preFileCreation

protected boolean preFileCreation(org.eclipse.core.runtime.IProgressMonitor progressMonitor,
                                  ExistingModelConfiguration config)

Complete pre file creation tasks.

Parameters:

progressMonitor - the progress monitor

config - the existing model configuration data

Returns:

true if pre file creation completed successfully, false otherwise

getFinalPerspective

protected java.lang.String getFinalPerspective(ExistingModelConfiguration config)

Return the id which identifies a perspective to activate.

Parameters:

config - the existing model configuration data

Returns:

the final perspective id

getPreferredPerspectives

protected java.lang.String getPreferredPerspectives(ExistingModelConfiguration config)

Return a comma-separated list of perspective IDs. If the current perspective is in this list, then no perspective activation occurs.

Parameters:

config - the existing model configuration data

Returns:

a comma-separated list of perspective IDs

doCreateFiles

protected abstract org.eclipse.core.resources.IFile[] doCreateFiles(org.eclipse.core.runtime.IProgressMonitor progressMonitor,
                                                                    ExistingModelConfiguration config)

Create the model files.

Parameters:

progressMonitor - the progress monitor

config - the existing model configuration data

Returns:

the newly created model files

postFileCreation

protected boolean postFileCreation(org.eclipse.core.runtime.IProgressMonitor progressMonitor,
                                   org.eclipse.core.resources.IFile[] files)

Complete post file creation tasks.

The default implementation opens the first newly created model in an eclipse editor.

Parameters:

progressMonitor - the progress monitor

files - the newly created files

Returns:

true if post file creation completed successfully, false otherwise