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

Class AbstractTemplateModelHandler

java.lang.Object

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

All Implemented Interfaces:

ITemplateModelHandler

Direct Known Subclasses:

FileTemplateModelHandler

public abstract class AbstractTemplateModelHandler
extends java.lang.Object
implements ITemplateModelHandler

Abstract implementation of the ITemplateModelHandler interface. This implementation splits the ITemplateModelHandler.createFiles(IProgressMonitor, TemplateConfiguration) 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
AbstractTemplateModelHandler()

Method Summary

Modifier and Type	Method and Description
boolean	createFiles(org.eclipse.core.runtime.IProgressMonitor progressMonitor, TemplateConfiguration config) Creates model files using the data from the given template configuration.
TemplateConfiguration	createTemplateConfiguration(ITemplate template) Creates the template configuration for the given ITemplate, to be populated by the wizard.
protected abstract org.eclipse.core.resources.IFile[]	doCreateFiles(org.eclipse.core.runtime.IProgressMonitor progressMonitor, TemplateConfiguration config) Create the model files.
protected java.lang.String	getFinalPerspective(TemplateConfiguration config) Return the id which identifies a perspective to activate.
protected java.lang.String	getPreferredPerspectives(TemplateConfiguration 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 monitor, TemplateConfiguration config) T 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

AbstractTemplateModelHandler

public AbstractTemplateModelHandler()

Method Detail

createTemplateConfiguration

public TemplateConfiguration createTemplateConfiguration(ITemplate template)

Description copied from interface: ITemplateModelHandler

Creates the template configuration for the given ITemplate, to be populated by the wizard.

Specified by:

createTemplateConfiguration in interface ITemplateModelHandler

Parameters:

template - the template to configure

Returns:

the template configuration to be populated by the wizard

createFiles

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

Description copied from interface: ITemplateModelHandler

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

Specified by:

createFiles in interface ITemplateModelHandler

Parameters:

progressMonitor - the progress monitor

config - the template configuration data

Returns:

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

preFileCreation

protected boolean preFileCreation(org.eclipse.core.runtime.IProgressMonitor monitor,
                                  TemplateConfiguration config)

T Complete pre file creation tasks.

Parameters:

monitor - the progress monitor

config - the template configuration data

Returns:

true if pre file creation completed successfully, false otherwise

getFinalPerspective

protected java.lang.String getFinalPerspective(TemplateConfiguration config)

Return the id which identifies a perspective to activate.

Parameters:

config - the template configuration data

Returns:

the final perspective id

getPreferredPerspectives

protected java.lang.String getPreferredPerspectives(TemplateConfiguration 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 template 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,
                                                                    TemplateConfiguration config)

Create the model files.

Parameters:

progressMonitor - the progress monitor

config - the template configuration data

Returns:

the newly created model files, or null if the operation failed

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