xdoclet.modules.ejb.dao

Class DaoSubTask

public class DaoSubTask extends AbstractEjbCodeGeneratorSubTask

Version: $Revision: 1.3 $

Author: Andrew Stevens

UNKNOWN: February 8, 2002 display-name = "Data Access Object" name = "dao" parent = "xdoclet.modules.ejb.EjbDocletTask" file = "dao-custom.xdt" relates-to = "{0}DAO.java" description = "A text file containing custom * template and/or java code to include in the data access object interface."

Field Summary
static StringDEFAULT_DAO_CLASS_PATTERN
Constructor Summary
DaoSubTask()
Describe what the DaoSubTask constructor does
Method Summary
protected voidengineStarted()
Describe what the method does
StringgetDaoClassPattern()
Returns the configuration parameter for specifying the DAO class name pattern.
protected StringgetGeneratedFileName(XClass clazz)
Gets the GeneratedFileName attribute of the DaoSubTask object
protected booleanmatchesGenerationRules(XClass clazz)
Describe what the method does
voidsetPattern(String new_pattern)
Sets the Pattern attribute of the DaoSubTask object
voidvalidateOptions()
Called to validate configuration parameters.

Field Detail

DEFAULT_DAO_CLASS_PATTERN

public static final String DEFAULT_DAO_CLASS_PATTERN

Constructor Detail

DaoSubTask

public DaoSubTask()
Describe what the DaoSubTask constructor does

Method Detail

engineStarted

protected void engineStarted()
Describe what the method does

Throws: XDocletException

getDaoClassPattern

public String getDaoClassPattern()
Returns the configuration parameter for specifying the DAO class name pattern. By default the value is used for deciding the DAO class name. {0} in the value mean current class's symbolic name which for an EJBean is the EJB name. If nothing explicitly specified by user then "{0}DAO" is used by default.

Returns: The daoClassPattern value

getGeneratedFileName

protected String getGeneratedFileName(XClass clazz)
Gets the GeneratedFileName attribute of the DaoSubTask object

Parameters: clazz Describe what the parameter does

Returns: The GeneratedFileName value

Throws: XDocletException

matchesGenerationRules

protected boolean matchesGenerationRules(XClass clazz)
Describe what the method does

Parameters: clazz Describe what the parameter does

Returns: Describe the return value

Throws: XDocletException

setPattern

public void setPattern(String new_pattern)
Sets the Pattern attribute of the DaoSubTask object

Parameters: new_pattern The new Pattern value

validateOptions

public void validateOptions()
Called to validate configuration parameters.

Throws: XDocletException