xdoclet.modules.ejb.entity
public class CmpTagsHandler extends EntityTagsHandler
ALL, LOCAL_SUFFIX, SERVICE_ENDPOINT, SERVICE_ENDPOINT_SUFFIX
FOR_CLASS, FOR_CONSTRUCTOR, FOR_FIELD, FOR_METHOD, PARAMETER_DELIMITER
Constructor and Description |
---|
CmpTagsHandler() |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
dbmsColumn()
Returns the dbms column.
|
java.lang.String |
dbmsTable()
Returns the table name for the current class.
|
java.lang.String |
entityCmpClass()
Returns the name of generated CMP class.
|
java.lang.String |
fieldName()
Returns the cmp-version 2.x compatible cmp / cmr field name for the current method.
|
void |
forAllCmpEntityBeans(java.lang.String template)
Evaluates the body block for each EJBean derived from EntityBean which is CMP.
|
void |
forAllCmpFields(java.lang.String template)
Evaluates the body block for each persistent field of current class (if entity CMP).
|
static java.lang.String |
getEntityCmpClassFor(xjavadoc.XClass clazz)
Gets the EntityCmpClassFor attribute of the CmpTagsHandler class
|
protected static java.lang.String |
getEntityCmpClassPattern()
Gets the EntityCmpClassPattern attribute of the CmpTagsHandler class
|
static java.lang.String |
getFieldNameFor(xjavadoc.XMethod method)
Returns the cmp-version 2.x compatible cmp / cmr field name for the passed method.
|
void |
ifEntityIsCmp(java.lang.String template)
Evaluates the body block if current class is an CMP entity bean.
|
void |
ifIsPersistent(java.lang.String template) |
void |
ifNotUsingCmp2(java.lang.String template)
Evaluate the body block if not using EJB 2.0 or using EJB 2.0 but CMP version 1.x.
|
void |
ifUsingCmp2(java.lang.String template)
Evaluate the body block if using EJB 2.0 and CMP version 2.x.
|
static boolean |
isEntityCmp(xjavadoc.XClass clazz)
Returns true if clazz is an CMP entity bean, false otherwise.
|
static boolean |
isUsingCmp2Impl(xjavadoc.XClass clazz)
Returns true if ejbspec config parameter is "2.0" and ejb:bean's cmp-version either not defined or is "2.x",
false otherwise.
|
forAllEjbSelectMethods, forAllEntityBeans, ifEntity, isEjbSelectMethod, isEntity, persistenceType, reentrant
beanType, choosePackage, concreteFullClassName, ejbExternalRefName, ejbName, ejbRefName, ejbRefName, extendsFromFor, forAllBeans, getDependentClassFor, getDependentClassTagName, getEjb, getEjbIdFor, getEjbNameFor, getEjbSpec, getShortEjbNameFor, hasTransaction, id, ifIsAConcreteEJBean, ifLocalEjb, ifNotLocalEjb, ifNotRemoteEjb, ifNotServiceEndpointEjb, ifRemoteEjb, ifServiceEndpointEjb, isAConcreteEJBean, isEjb, isLocalEjb, isOnlyLocalEjb, isOnlyRemoteEjb, isOnlyServiceEndpointEjb, isRemoteEjb, isServiceEndpointEjb, prefixWithEjbSlash, shortEjbName, shouldTraverseSuperclassForDependentClass, symbolicClassName
delimit, expandClassName, generate, getCurrentClass, getCurrentClassTag, getCurrentConstructor, getCurrentField, getCurrentFieldTag, getCurrentMethod, getCurrentMethodTag, getCurrentPackage, getDocletContext, getEngine, getExpandedDelimitedTagValue, getTagValue, getTagValue, getTagValue, hasHavingClassTag, hasTag, isTagValueEqual, mandatoryParamNotFound, mandatoryTemplateTagParamNotFound, modifiers, popCurrentClass, pushCurrentClass, setCurrentClass, setCurrentClassTag, setCurrentConstructor, setCurrentField, setCurrentFieldTag, setCurrentMethod, setCurrentMethodTag, setCurrentPackage
getXJavaDoc, setXJavaDoc
public static java.lang.String getEntityCmpClassFor(xjavadoc.XClass clazz)
clazz
- Describe what the parameter doespublic static boolean isEntityCmp(xjavadoc.XClass clazz) throws XDocletException
clazz
- Description of ParameterXDocletException
public static boolean isUsingCmp2Impl(xjavadoc.XClass clazz) throws XDocletException
clazz
- XDocletException
public static java.lang.String getFieldNameFor(xjavadoc.XMethod method) throws XDocletException
method
- the methodXDocletException
protected static java.lang.String getEntityCmpClassPattern()
public java.lang.String entityCmpClass() throws XDocletException
XDocletException
public void ifUsingCmp2(java.lang.String template) throws XDocletException
template
- The body of the block tagXDocletException
isUsingCmp2Impl(xjavadoc.XClass)
,
ifNotUsingCmp2(java.lang.String)
public void ifNotUsingCmp2(java.lang.String template) throws XDocletException
template
- The body of the block tagXDocletException
isUsingCmp2Impl(xjavadoc.XClass)
,
ifUsingCmp2(java.lang.String)
public void ifEntityIsCmp(java.lang.String template) throws XDocletException
template
- The body of the block tagXDocletException
public void forAllCmpEntityBeans(java.lang.String template) throws XDocletException
template
- The body of the block tagXDocletException
isEntityCmp(xjavadoc.XClass)
public void forAllCmpFields(java.lang.String template) throws XDocletException
template
- The body of the block tagXDocletException
isEntityCmp(xjavadoc.XClass)
,
PersistentTagsHandler.isPersistentField(xjavadoc.XMethod)
,
MethodTagsHandler.isGetter(java.lang.String)
public java.lang.String dbmsColumn() throws XDocletException
XDocletException
public java.lang.String dbmsTable() throws XDocletException
XDocletException
public void ifIsPersistent(java.lang.String template) throws XDocletException
XDocletException
public java.lang.String fieldName() throws XDocletException
XDocletException