xdoclet.ejb.tags
Class DaoTagsHandler

java.lang.Object
  |
  +--xdoclet.template.TemplateTagHandler
        |
        +--xdoclet.XDocletTagSupport
              |
              +--xdoclet.ejb.tags.EjbTagsHandler
                    |
                    +--xdoclet.ejb.tags.DaoTagsHandler

public class DaoTagsHandler

extends EjbTagsHandler

Version:

$Revision: 1.1 $

Author:

Andrew Stevens

Fields inherited from class xdoclet.ejb.tags.EjbTagsHandler

LOCAL_SUFFIX

Fields inherited from class xdoclet.XDocletTagSupport

FOR_CLASS, FOR_CONSTRUCTOR, FOR_FIELD, FOR_METHOD, PARAMETER_DELIMITER

Constructor Summary

DaoTagsHandler()

Method Summary

java.lang.String	daoClass(java.util.Properties attributes) Returns the full qualified dao class name for the bean
static java.lang.String	getDaoClassFor(com.sun.javadoc.ClassDoc clazz) Similar to InterfaceTagsHandler.getComponentInterface(java.lang.String, com.sun.javadoc.ClassDoc).
protected static java.lang.String	getDaoClassPattern()
void	ifUsingDao(java.lang.String template) Evaluate the body block if ejb:dao tag present and DAO subtask being used.

Methods inherited from class xdoclet.ejb.tags.EjbTagsHandler

beanType, choosePackage, concreteFullClassName, ejbExternalRefName, ejbName, ejbRefName, extendsFromFor, forAllBeans, getDependentClassFor, getDependentClassTagName, getEjbIdFor, getEjbNameFor, getEjbSpec, getShortEjbNameFor, hasPermission, hasTransaction, id, ifIsAConcreteEJBean, ifLocalEjb, ifNotLocalEjb, ifNotRemoteEjb, ifRemoteEjb, isAConcreteEJBean, isEjb, isLocalEjb, isOnlyLocalEjb, isOnlyRemoteEjb, isRemoteEjb, prefixWithEjbSlash, shortEjbName, shouldTraverseSuperclassForDependentClass, symbolicClassName

Methods inherited from class xdoclet.XDocletTagSupport

getClassTagValue, getClassTagValue, getConstructorTagValue, getCurrentClass, getCurrentConstructor, getCurrentField, getCurrentMethod, getCurrentPackage, getCurrentTag, getDocletContext, getFieldTagValue, getFieldTagValue, getMethodTagValue, getMethodTagValue, getParameterValue, getParameterValue, getTagValue, getTagValue, getTagValue, invalidParamValueFound, mandatoryParamNotFound, mandatoryTemplateTagParamNotFound, parsePropertyString, popCurrentClass, pushCurrentClass, replaceProperties, setCurrentClass, setCurrentConstructor, setCurrentField, setCurrentMethod, setCurrentPackage, setCurrentTag, tokenizeValue

Methods inherited from class xdoclet.template.TemplateTagHandler

generate, getContext, getEngine, getParser, setContext, setEngine, setParser

Methods inherited from class java.lang.Object

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

Constructor Detail

DaoTagsHandler

public DaoTagsHandler()

Method Detail

getDaoClassFor

public static java.lang.String getDaoClassFor(com.sun.javadoc.ClassDoc clazz)
                                       throws XDocletException

Similar to InterfaceTagsHandler.getComponentInterface(java.lang.String, com.sun.javadoc.ClassDoc). Relies on the ejb:dao tag, which has the following relevant properties:

• class: The fully qualified name of the DAO class - overrides all set patterns
• pattern: The pattern to be used to determine the unqualified name of the DAO class
• package: The package the DAO is to be placed in

Parameters:

clazz - Description of Parameter

Returns:

The DAO value

Throws:

XDocletException - Description of Exception

getDaoClassPattern

protected static java.lang.String getDaoClassPattern()

daoClass

public java.lang.String daoClass(java.util.Properties attributes)
                          throws XDocletException

Returns the full qualified dao class name for the bean

Parameters:

attributes - The attributes of the template tag

Returns:

DAO class name

Throws:

XDocletException - Description of Exception

ifUsingDao

public void ifUsingDao(java.lang.String template)
                throws XDocletException

Evaluate the body block if ejb:dao tag present and DAO subtask being used.

Parameters:

template -

Throws:

XDocletException - Description of Exception