com.ibm.xtools.common.ui.wizards.templates

Class BasicTemplate

java.lang.Object

com.ibm.xtools.common.ui.wizards.templates.BasicTemplate

All Implemented Interfaces:

ITemplate

Direct Known Subclasses:

FileTemplate

public class BasicTemplate
extends java.lang.Object
implements ITemplate

Basic implementation of the ITemplate interface. Provides getters and setters of all properties.

Constructor Summary

Constructors

Constructor and Description
BasicTemplate()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDescription() Return the template description.
java.net.URL	getIconURL() Return the URL of the template icon.
java.lang.String	getId() Return the template ID.
java.lang.String	getModelFileExtension() Return the new model file extension.
java.lang.String	getModelName() Return the new model name.
java.lang.String	getName() Return the template name.
java.util.Map<java.lang.String,java.lang.Object>	getProperties() Obtains a map of additional properties defined in the template definition, which are not interpreted by the New Wizard framework.
java.lang.Object	getProperty(java.lang.String nameArg) Obtains the value of an additional property defined in the template definition, which is not interpreted by the New Wizard framework.
ITemplateModelHandler	getTemplateModelHandler() Return the ITemplateModelHandler used to create models from this template.
void	setDescription(java.lang.String description) Set the template description.
void	setIconURL(java.net.URL iconURL) Set the URL of the template icon.
void	setId(java.lang.String id) Set the template ID.
void	setModelFileExtension(java.lang.String modelFileExtension) Set the new model file extension.
void	setModelName(java.lang.String modelName) Set the new model's name.
void	setName(java.lang.String name) Set the template name.
void	setProperty(java.lang.String name, java.lang.Object value) Sets the value of an additional property defined in the template definition, which is not interpreted by the New Wizard framework.
void	setTemplateModelHandler(ITemplateModelHandler templateModelHandler) Set the ITemplateModelHandler used to create models from this template.

Methods inherited from class java.lang.Object

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

Constructor Detail

BasicTemplate

public BasicTemplate()

Method Detail

getModelName

public java.lang.String getModelName()

Description copied from interface: ITemplate

Return the new model name.

Specified by:

getModelName in interface ITemplate

Returns:

the new model name

setModelName

public void setModelName(java.lang.String modelName)

Set the new model's name.

Parameters:

modelName - the new model's name

getDescription

public java.lang.String getDescription()

Description copied from interface: ITemplate

Return the template description.

Specified by:

getDescription in interface ITemplate

Returns:

the template description

setDescription

public void setDescription(java.lang.String description)

Set the template description.

Parameters:

description - the template description

getIconURL

public java.net.URL getIconURL()

Description copied from interface: ITemplate

Return the URL of the template icon.

Specified by:

getIconURL in interface ITemplate

Returns:

the URL of the template icon

setIconURL

public void setIconURL(java.net.URL iconURL)

Set the URL of the template icon.

Parameters:

iconURL - the URL of the template icon

getId

public java.lang.String getId()

Description copied from interface: ITemplate

Return the template ID.

Specified by:

getId in interface ITemplate

Returns:

the template ID

setId

public void setId(java.lang.String id)

Set the template ID.

Parameters:

id - the template ID

getName

public java.lang.String getName()

Description copied from interface: ITemplate

Return the template name.

Specified by:

getName in interface ITemplate

Returns:

the template name.

setName

public void setName(java.lang.String name)

Set the template name.

Parameters:

name - the template name

getTemplateModelHandler

public ITemplateModelHandler getTemplateModelHandler()

Description copied from interface: ITemplate

Return the ITemplateModelHandler used to create models from this template.

Specified by:

getTemplateModelHandler in interface ITemplate

Returns:

the ITemplateModelHandler

setTemplateModelHandler

public void setTemplateModelHandler(ITemplateModelHandler templateModelHandler)

Set the ITemplateModelHandler used to create models from this template.

Parameters:

templateModelHandler - the ITemplateModelHandler

getModelFileExtension

public java.lang.String getModelFileExtension()

Description copied from interface: ITemplate

Return the new model file extension.

Specified by:

getModelFileExtension in interface ITemplate

Returns:

the new model file extension

setModelFileExtension

public void setModelFileExtension(java.lang.String modelFileExtension)

Set the new model file extension.

Parameters:

modelFileExtension - the new model file extension

getProperties

public java.util.Map<java.lang.String,java.lang.Object> getProperties()

Obtains a map of additional properties defined in the template definition, which are not interpreted by the New Wizard framework.

Returns:

additional properties, or an empty map if none

Since:

7.5

getProperty

public java.lang.Object getProperty(java.lang.String nameArg)

Obtains the value of an additional property defined in the template definition, which is not interpreted by the New Wizard framework.

Parameters:

nameArg - the property name

Returns:

the corresponding value, or null if the property is not set or has a value of null

Since:

7.5

setProperty

public void setProperty(java.lang.String name,
                        java.lang.Object value)

Sets the value of an additional property defined in the template definition, which is not interpreted by the New Wizard framework.

Parameters:

name - the property name

value - the corresponding value

Since:

7.5