xdoclet.modules.apache.struts.ejb

Class StrutsFormSubTask

public class StrutsFormSubTask extends AbstractEjbCodeGeneratorSubTask

Generates a Struts ActionForm, based on an entity EJB. More information on Struts is available on the Struts website , or the ActionForm API .

Version: $Revision: 1.12 $

Author: Dmitri Colebatch (dim@bigpond.net.au)

UNKNOWN: September 3, 2001 display-name = "Struts Form" name = "strutsform" parent = "xdoclet.modules.ejb.EjbDocletTask"

Field Summary
protected XTag	currentFormTag Form tag being processed right now.
protected static String	DEFAULT_TEMPLATE_FILE The default template file - struts_form.xdt.
protected String	formClassPattern The pattern for the form class.

Constructor Summary
	StrutsFormSubTask() Describe what the StrutsFormSubTask constructor does

Method Summary
protected void	engineStarted() Describe what the method does
protected void	generateForClass(XClass clazz) iterate through all struts:form tags,and produce separate classes
XTag	getCurrentFormTag() Gets the CurrentFormTag attribute of the StrutsFormSubTask object
protected String	getGeneratedFileName(XClass clazz) Gets the GeneratedFileName attribute of the StrutsFormSubTask object
String	getStrutsFormClassPattern() Return the class pattern.
protected boolean	matchesGenerationRules(XClass clazz) Returns whether struts form[s] shall be generated for this class
void	setCurrentFormTag(XTag t) Sets the CurrentFormTag attribute of the StrutsFormSubTask object
void	setPattern(String newPattern) Sets the Pattern attribute of the StrutsFormSubTask object
void	validateOptions() Called to validate configuration parameters.

Field Detail

currentFormTag

protected XTag currentFormTag

Form tag being processed right now.

DEFAULT_TEMPLATE_FILE

protected static final String DEFAULT_TEMPLATE_FILE

The default template file - struts_form.xdt.

formClassPattern

protected String formClassPattern

The pattern for the form class. Defaults to {0}{1}Form if not present.

Constructor Detail

StrutsFormSubTask

public StrutsFormSubTask()

Describe what the StrutsFormSubTask constructor does

Method Detail

engineStarted

protected void engineStarted()

Describe what the method does

Throws: XDocletException Describe the exception

generateForClass

protected void generateForClass(XClass clazz)

iterate through all struts:form tags,and produce separate classes

Parameters: clazz Description of Parameter

Throws: XDocletException Description of Exception

getCurrentFormTag

public XTag getCurrentFormTag()

Gets the CurrentFormTag attribute of the StrutsFormSubTask object

Returns: The CurrentFormTag value

getGeneratedFileName

protected String getGeneratedFileName(XClass clazz)

Gets the GeneratedFileName attribute of the StrutsFormSubTask object

Parameters: clazz Describe what the parameter does

Returns: The GeneratedFileName value

Throws: XDocletException Describe the exception

getStrutsFormClassPattern

public String getStrutsFormClassPattern()

Return the class pattern.

Returns: The StrutsFormClassPattern value

matchesGenerationRules

protected boolean matchesGenerationRules(XClass clazz)

Returns whether struts form[s] shall be generated for this class

Parameters: clazz Description of Parameter

Returns: is form tag shall be generated

Throws: XDocletException Description of Exception

setCurrentFormTag

public void setCurrentFormTag(XTag t)

Sets the CurrentFormTag attribute of the StrutsFormSubTask object

Parameters: t The new CurrentFormTag value

setPattern

public void setPattern(String newPattern)

Sets the Pattern attribute of the StrutsFormSubTask object

Parameters: newPattern The new Pattern value

validateOptions

public void validateOptions()

Called to validate configuration parameters.

Throws: XDocletException Description of Exception