org.andromda.core.common

Class TemplateObject

java.lang.Object

org.andromda.core.common.TemplateObject

public class TemplateObject
extends Object

Contains the configuration of a template object which are objects that are made available to the cartridge templates.

Author:

Chad Brandon, Bob Fields

Constructor Summary

Constructors

Constructor and Description
TemplateObject()

Method Summary

Methods

Modifier and Type	Method and Description
void	addPropertyReference(String reference) Adds a templateObject property reference (used to customize templateObjects).
protected Logger	getLogger() Gets the namespace logger (the logger under which output for this template object should be written).
String	getName() Gets the current name of this TemplateObject.
String	getNamespace() Gets the namespace to which this template object belongs.
Object	getObject() Returns the actuall object instance described by this template object.
URL	getResource() The resource in which the templateObject was found.
void	setClassName(String className) Sets the class of the transformation object.
void	setName(String name) Sets the name of the template object (this name will be what the template class is stored under in the template)
void	setNamespace(String namespace) Sets the namespace to which this template object belongs.
protected void	setProperties(Object templateObject) Sets all the nested properties on the templateObject object.
void	setResource(URL resource) Sets the resource in which the templateObject was defined.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

TemplateObject

public TemplateObject()

Method Detail

getName

public String getName()

Gets the current name of this TemplateObject.

Returns:

String

getObject

public Object getObject()

Returns the actuall object instance described by this template object.

Returns:

the actual object instance.

setProperties

protected void setProperties(Object templateObject)

Sets all the nested properties on the templateObject object.

Parameters:

templateObject - the template object on which to populate properties.

setName

public void setName(String name)

Sets the name of the template object (this name will be what the template class is stored under in the template)

Parameters:

name - the name of the template object.

setClassName

public void setClassName(String className)

Sets the class of the transformation object.

Parameters:

className - the name of the template object class.

addPropertyReference

public void addPropertyReference(String reference)

Adds a templateObject property reference (used to customize templateObjects). Property references are used to populate bean like properties of template objects.

Parameters:

reference - the name of the property reference.

getResource

public URL getResource()

The resource in which the templateObject was found.

Returns:

the resource as a URL.

setResource

public void setResource(URL resource)

Sets the resource in which the templateObject was defined.

Parameters:

resource - the resource on which this template object was defined.

getNamespace

public String getNamespace()

Gets the namespace to which this template object belongs.

Returns:

Returns the namespace.

setNamespace

public void setNamespace(String namespace)

Sets the namespace to which this template object belongs.

Parameters:

namespace - The namespace to set.

getLogger

protected Logger getLogger()

Gets the namespace logger (the logger under which output for this template object should be written).

Returns:

the logger instance.

toString

public String toString()

Overrides:

toString in class Object

See Also:

Object.toString()