com.finalist.jaggenerator.template
Class Template

java.lang.Object
  com.finalist.jaggenerator.template.Template

public class Template

extends java.lang.Object

This class represents a JAG 'generation template'. A generation template is in fact a directory containing a collection of files and subdirectories. The template directory must have a "template.xml" configuration file, which contains information about the template and what configuration options are to be presented to the user.

Author:

Michael O'Connor - Finalist IT Group

Field Summary

static java.lang.String

DEFAULT_ENGINE_CLASS The default template engine class.

Constructor Summary

Template(java.io.File templateDir)

Method Summary

TemplateConfigParameter[]	getConfigParams() Gets the configuration paramaters defined for this template.
java.lang.String	getDescription()
java.lang.String	getEngine()
java.lang.String	getEngineClass()
java.lang.String	getName() Gets the name of this template.
java.io.File	getTemplateDir() Gets the base directory of this template.
void	setTemplateDir(java.io.File templateDir) Sets the base directory of this template.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_ENGINE_CLASS

public static final java.lang.String DEFAULT_ENGINE_CLASS

The default template engine class.

See Also:

Constant Field Values

Constructor Detail

Template

public Template(java.io.File templateDir)
         throws TemplateConfigException

Method Detail

getName

public java.lang.String getName()

Gets the name of this template.

Returns:

the name.

getTemplateDir

public java.io.File getTemplateDir()

Gets the base directory of this template.

Returns:

the base directory.

setTemplateDir

public void setTemplateDir(java.io.File templateDir)

Sets the base directory of this template.

getDescription

public java.lang.String getDescription()

getEngine

public java.lang.String getEngine()

getEngineClass

public java.lang.String getEngineClass()

getConfigParams

public TemplateConfigParameter[] getConfigParams()

Gets the configuration paramaters defined for this template.

Returns:

the config paramseters.

toString

public java.lang.String toString()