xdoclet.modules.ejb.dao
Class DaoSubTask

java.lang.Object
  extended by xdoclet.DocletSupport
      extended by xdoclet.SubTask
          extended by xdoclet.TemplateSubTask
              extended by xdoclet.modules.ejb.AbstractEjbCodeGeneratorSubTask
                  extended by xdoclet.modules.ejb.dao.DaoSubTask
All Implemented Interfaces:
java.io.Serializable

public class DaoSubTask
extends AbstractEjbCodeGeneratorSubTask

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

Nested Class Summary
 
Nested classes/interfaces inherited from class xdoclet.TemplateSubTask
TemplateSubTask.ExtentTypes, TemplateSubTask.OfType
 
Field Summary
static java.lang.String DEFAULT_DAO_CLASS_PATTERN
           
 
Fields inherited from class xdoclet.DocletSupport
currentClassTag, currentFieldTag, currentMethodTag
 
Constructor Summary
DaoSubTask()
          Describe what the DaoSubTask constructor does
 
Method Summary
protected  void engineStarted()
          Describe what the method does
 java.lang.String getDaoClassPattern()
          Returns the configuration parameter for specifying the DAO class name pattern.
protected  java.lang.String getGeneratedFileName(xjavadoc.XClass clazz)
          Gets the GeneratedFileName attribute of the DaoSubTask object
protected  boolean matchesGenerationRules(xjavadoc.XClass clazz)
          Describe what the method does
 void setPattern(java.lang.String new_pattern)
          Sets the Pattern attribute of the DaoSubTask object
 void validateOptions()
          Called to validate configuration parameters.
 
Methods inherited from class xdoclet.TemplateSubTask
addOfType, addOfType, addPackageSubstitution, copyAttributesFrom, engineFinished, execute, generateForClass, getAcceptAbstractClasses, getAcceptInterfaces, getDestinationFile, getEngine, getExtent, getGenerationManager, getHavingClassTag, getOfType, getPackageSubstitutions, getSubTaskClassName, getTemplateURL, init, isPackageSubstitutionInheritanceSupported, isPrefixWithPackageStructure, javaFile, processInnerClasses, setAcceptAbstractClasses, setAcceptInterfaces, setDestinationFile, setEngine, setExtent, setExtentValue, setGenerationManager, setHavingClassTag, setOfType, setPackageSubstitutionInheritanceSupported, setPackageSubstitutions, setPrefixWithPackageStructure, setSubTaskClassName, setTemplateFile, setTemplateURL, startEngine, startProcess, startProcessForAll, startProcessPerClass
 
Methods inherited from class xdoclet.SubTask
addConfigParam, getConfigParams, getConfigParamsAsMap, getContext, getDestDir, getMergeDir, getSubTaskName, getXJavaDoc, setDestDir, setMergeDir, setSubTaskName
 
Methods inherited from class xdoclet.DocletSupport
getCurrentClass, getCurrentClassTag, getCurrentConstructor, getCurrentField, getCurrentFieldTag, getCurrentMethod, getCurrentMethodTag, getCurrentPackage, getCurrentTag, isDocletGenerated, popCurrentClass, pushCurrentClass, setCurrentClass, setCurrentClassTag, setCurrentConstructor, setCurrentField, setCurrentFieldTag, setCurrentMethod, setCurrentMethodTag, setCurrentPackage
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

DEFAULT_DAO_CLASS_PATTERN

public static final java.lang.String DEFAULT_DAO_CLASS_PATTERN
See Also:
Constant Field Values
Constructor Detail

DaoSubTask

public DaoSubTask()
Describe what the DaoSubTask constructor does

Method Detail

getDaoClassPattern

public java.lang.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

setPattern

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

Parameters:
new_pattern - The new Pattern value

validateOptions

public void validateOptions()
                     throws XDocletException
Called to validate configuration parameters.

Overrides:
validateOptions in class TemplateSubTask
Throws:
XDocletException

getGeneratedFileName

protected java.lang.String getGeneratedFileName(xjavadoc.XClass clazz)
                                         throws XDocletException
Gets the GeneratedFileName attribute of the DaoSubTask object

Overrides:
getGeneratedFileName in class TemplateSubTask
Parameters:
clazz - Describe what the parameter does
Returns:
The GeneratedFileName value
Throws:
XDocletException

engineStarted

protected void engineStarted()
                      throws XDocletException
Describe what the method does

Overrides:
engineStarted in class TemplateSubTask
Throws:
XDocletException

matchesGenerationRules

protected boolean matchesGenerationRules(xjavadoc.XClass clazz)
                                  throws XDocletException
Describe what the method does

Overrides:
matchesGenerationRules in class TemplateSubTask
Parameters:
clazz - Describe what the parameter does
Returns:
Describe the return value
Throws:
XDocletException

http://xdoclet.sourceforge.net/