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

Class FileTemplateModelHandler

java.lang.Object

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

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

All Implemented Interfaces:

ITemplateModelHandler

public class FileTemplateModelHandler
extends AbstractTemplateModelHandler

This implementation of ITemplateModelHandler creates a new model from a model template file, where the template data is of type FileTemplate.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FileTemplateModelHandler()

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	appendExtensionToFileName(java.lang.String filename, java.lang.String fileExtension) Appends the given file extension to the given file name.
protected org.eclipse.emf.ecore.resource.Resource[]	createResources(org.eclipse.core.runtime.IProgressMonitor progressMonitor, TemplateConfiguration config, org.eclipse.emf.transaction.TransactionalEditingDomain domain) Create the resources in memory
TemplateConfiguration	createTemplateConfiguration(ITemplate template) Creates the template configuration for the given ITemplate, to be populated by the wizard.
protected org.eclipse.core.resources.IFile[]	doCreateFiles(org.eclipse.core.runtime.IProgressMonitor progressMonitor, TemplateConfiguration config) Create the model files.
protected org.eclipse.emf.transaction.TransactionalEditingDomain	getEditingDomain() Return the editing domain to to create the new model resource in.
static FileTemplateModelHandler	getFileTemplateModelHandler()
protected java.util.Map<java.lang.Object,java.lang.Object>	getSaveOptions() Return the resource save options.

Methods inherited from class com.ibm.xtools.common.ui.wizards.handlers.AbstractTemplateModelHandler

createFiles, getFinalPerspective, getPreferredPerspectives, postFileCreation, preFileCreation

Methods inherited from class java.lang.Object

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

Constructor Detail

FileTemplateModelHandler

protected FileTemplateModelHandler()

Method Detail

getFileTemplateModelHandler

public static final FileTemplateModelHandler getFileTemplateModelHandler()

getSaveOptions

protected java.util.Map<java.lang.Object,java.lang.Object> getSaveOptions()

Return the resource save options.

Returns:

the resource save options

getEditingDomain

protected org.eclipse.emf.transaction.TransactionalEditingDomain getEditingDomain()

Return the editing domain to to create the new model resource in.

Returns:

editing domain

createResources

protected org.eclipse.emf.ecore.resource.Resource[] createResources(org.eclipse.core.runtime.IProgressMonitor progressMonitor,
                                                                    TemplateConfiguration config,
                                                                    org.eclipse.emf.transaction.TransactionalEditingDomain domain)

Create the resources in memory

Parameters:

progressMonitor - the progress monitor

config - the template configuration data

domain - the editing domain to create the resources into

Returns:

the newly created resources, or null if the operation failed

doCreateFiles

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

Description copied from class: AbstractTemplateModelHandler

Create the model files.

Specified by:

doCreateFiles in class AbstractTemplateModelHandler

Parameters:

progressMonitor - the progress monitor

config - the template configuration data

Returns:

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

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

Overrides:

createTemplateConfiguration in class AbstractTemplateModelHandler

Parameters:

template - the template to configure

Returns:

the template configuration to be populated by the wizard

appendExtensionToFileName

protected final java.lang.String appendExtensionToFileName(java.lang.String filename,
                                                           java.lang.String fileExtension)

Appends the given file extension to the given file name.

Parameters:

filename -

fileExtension -

Returns:

the file name with extension