xdoclet.modules.ejb.dao

Class DaoSubTask


public class DaoSubTask
extends AbstractEjbCodeGeneratorSubTask

Version:
$Revision: 1.3 $
Author:
Andrew Stevens
ant.element
display-name = "Data Access Object" name = "dao" parent = "xdoclet.modules.ejb.EjbDocletTask"
created
February 8, 2002

Field Summary

static String
DEFAULT_DAO_CLASS_PATTERN

Constructor Summary

DaoSubTask()
Describe what the DaoSubTask constructor does

Method Summary

protected void
engineStarted()
Describe what the method does
String
getDaoClassPattern()
Returns the configuration parameter for specifying the DAO class name pattern.
protected String
getGeneratedFileName(XClass clazz)
Gets the GeneratedFileName attribute of the DaoSubTask object
protected boolean
matchesGenerationRules(XClass clazz)
Describe what the method does
void
setPattern(String new_pattern)
Sets the Pattern attribute of the DaoSubTask object
void
validateOptions()
Called to validate configuration parameters.

Field Details

DEFAULT_DAO_CLASS_PATTERN

public static final String DEFAULT_DAO_CLASS_PATTERN

Constructor Details

DaoSubTask

public DaoSubTask()
Describe what the DaoSubTask constructor does

Method Details

engineStarted

protected void engineStarted()
            throws xdoclet.XDocletException
Describe what the method does
Throws:
xdoclet.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)
            throws xdoclet.XDocletException
Gets the GeneratedFileName attribute of the DaoSubTask object
Parameters:
clazz - Describe what the parameter does
Returns:
The GeneratedFileName value
Throws:
xdoclet.XDocletException -

matchesGenerationRules

protected boolean matchesGenerationRules(XClass clazz)
            throws xdoclet.XDocletException
Describe what the method does
Parameters:
clazz - Describe what the parameter does
Returns:
Describe the return value
Throws:
xdoclet.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()
            throws xdoclet.XDocletException
Called to validate configuration parameters.
Throws:
xdoclet.XDocletException -