com.finalist.jaggenerator.template
Class TemplateConfigParameter

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

public class TemplateConfigParameter

extends java.lang.Object

This bean represents a single configurable parameter, as specified in a template's "template.xml".

Author:

Michael O'Connor - Finalist IT Group

Field Summary

static com.finalist.jaggenerator.template.TemplateConfigParameter.Type	TYPE_CHECKBOX The 'type' value for a parameter whose value is determined by clicking an on/off checkbox.
static com.finalist.jaggenerator.template.TemplateConfigParameter.Type	TYPE_EDITABLE_LIST The 'type' value for a parameter whose value is determined by either: selecting an item from a predefined list, or typing in a 'free text' value
static com.finalist.jaggenerator.template.TemplateConfigParameter.Type	TYPE_LIST The 'type' value for a parameter whose value is determined by selecting an item from a predefined list.
static com.finalist.jaggenerator.template.TemplateConfigParameter.Type	TYPE_TEXT The 'type' value for a parameter whose value is determined by entering text into an input field.

Constructor Summary

TemplateConfigParameter()

Method Summary

java.lang.String	getDescription() Gets the description for this parameter - shows up in the GUI as a tooltip.
java.lang.String	getId() Gets the id - the unique identifier of this parameter used to access the parameter value from the templates.
java.lang.String	getName() Gets the name - this is the human-readable short name used to represent this parameter in the GUI.
java.lang.String[]	getPresetValues() Gets the preset values for this parameter.
com.finalist.jaggenerator.template.TemplateConfigParameter.Type	getType() Gets the type of this configuration parameter.
static com.finalist.jaggenerator.template.TemplateConfigParameter.Type	getTypeByName(java.lang.String name) Translates a type's name into the corresponding Type object.
java.lang.String	getValue()
void	setDescription(java.lang.String description) Sets the description for this parameter - shows up in the GUI as a tooltip.
void	setId(java.lang.String id) Sets the id - the unique identifier of this parameter used to access the parameter value from the templates.
void	setName(java.lang.String name) Sets the name - this is the human-readable short name used to represent this parameter in the GUI.
void	setPresetValues(java.lang.String[] presetValues)
void	setType(com.finalist.jaggenerator.template.TemplateConfigParameter.Type type) Sets the type of this configuration parameter.
void	setValue(java.lang.String value)

Methods inherited from class java.lang.Object

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

Field Detail

TYPE_TEXT

public static final com.finalist.jaggenerator.template.TemplateConfigParameter.Type TYPE_TEXT

The 'type' value for a parameter whose value is determined by entering text into an input field.

TYPE_CHECKBOX

public static final com.finalist.jaggenerator.template.TemplateConfigParameter.Type TYPE_CHECKBOX

The 'type' value for a parameter whose value is determined by clicking an on/off checkbox.

TYPE_LIST

public static final com.finalist.jaggenerator.template.TemplateConfigParameter.Type TYPE_LIST

The 'type' value for a parameter whose value is determined by selecting an item from a predefined list.

TYPE_EDITABLE_LIST

public static final com.finalist.jaggenerator.template.TemplateConfigParameter.Type TYPE_EDITABLE_LIST

The 'type' value for a parameter whose value is determined by either:

selecting an item from a predefined list, or

typing in a 'free text' value

Constructor Detail

TemplateConfigParameter

public TemplateConfigParameter()

Method Detail

getId

public java.lang.String getId()

Gets the id - the unique identifier of this parameter used to access the parameter value from the templates.

Returns:

id

setId

public void setId(java.lang.String id)

Sets the id - the unique identifier of this parameter used to access the parameter value from the templates. This value should be a String following the same naming conventions as a Java bean attribute (e.g. no spaces, hyphens, etc.).

Parameters:

id -

getName

public java.lang.String getName()

Gets the name - this is the human-readable short name used to represent this parameter in the GUI.

Returns:

setName

public void setName(java.lang.String name)

Sets the name - this is the human-readable short name used to represent this parameter in the GUI.

Parameters:

name -

getDescription

public java.lang.String getDescription()

Gets the description for this parameter - shows up in the GUI as a tooltip.

Returns:

setDescription

public void setDescription(java.lang.String description)

Sets the description for this parameter - shows up in the GUI as a tooltip.

Parameters:

description -

getType

public com.finalist.jaggenerator.template.TemplateConfigParameter.Type getType()

Gets the type of this configuration parameter.

Returns:

one of the TYPE_XXX constants defined in this class.

setType

public void setType(com.finalist.jaggenerator.template.TemplateConfigParameter.Type type)

Sets the type of this configuration parameter.

Parameters:

type - - Use one of the TYPE_XXX constants defined in this class.

getPresetValues

public java.lang.String[] getPresetValues()

Gets the preset values for this parameter.

Returns:

a String[] (may have length zero, never null).

setPresetValues

public void setPresetValues(java.lang.String[] presetValues)

getValue

public java.lang.String getValue()

setValue

public void setValue(java.lang.String value)

getTypeByName

public static com.finalist.jaggenerator.template.TemplateConfigParameter.Type getTypeByName(java.lang.String name)

Translates a type's name into the corresponding Type object.

Parameters:

name -

Returns:

null if the name is not a valid Type.