xdoclet.ejb.tags
Class ValueObjectTagsHandler

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

public class ValueObjectTagsHandler
extends EjbTagsHandler

Version:
$Revision: 1.7 $
Author:
Vincent Harcq (vincent.harcq@hubmethods.com)

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
ValueObjectTagsHandler()
           
 
Method Summary
 java.lang.String currentAggregateName()
           
 java.lang.String currentAggregateType(java.util.Properties attributes)
           
 java.lang.String currentRelationBeanClass()
           
 java.lang.String currentValueObjectAttribute()
           
 java.lang.String currentValueObjectClass()
           
 java.lang.String currentValueObjectMatch()
           
 java.lang.String extendsFrom()
          Returns the name of the class dataobject class extends.
 void forAllAggregates(java.lang.String template, java.util.Properties attributes)
           
 void forAllComposes(java.lang.String template, java.util.Properties attributes)
           
 void forAllRelations(java.lang.String template, java.util.Properties attributes)
           
protected  void forAllSetters(java.lang.String template, java.lang.String methodName)
           
 void forAllSuperSetValue(java.lang.String template)
           
 void forAllValueObjects(java.lang.String pTemplate)
           
static java.lang.String getCurrentValueObjectAttribute(com.sun.javadoc.ClassDoc clazz, com.sun.javadoc.Tag tag)
           
static java.lang.String getCurrentValueObjectClass(com.sun.javadoc.ClassDoc clazz, com.sun.javadoc.Tag tag)
           
static java.lang.String getCurrentValueObjectMatch(com.sun.javadoc.ClassDoc clazz, com.sun.javadoc.Tag tag)
           
static java.lang.String getCurrentValueObjectName(com.sun.javadoc.ClassDoc clazz, com.sun.javadoc.Tag tag)
           
 java.lang.String getValueMostSuperObjectClass(com.sun.javadoc.ClassDoc clazz)
           
 void ifEagerInstantiation(java.lang.String template)
           
 void ifUsingValueObject(java.lang.String template)
          Evaluate the body block if Value Object subtask being used.
static boolean isGenerationNeeded(com.sun.javadoc.ClassDoc clazz)
           
 java.lang.String serialVersionUID()
           
 java.lang.String valueMostSuperObjectClass()
          Returns the data-object class name highest in the hierarchy of derived beans.
 java.lang.String valueObjectClass()
           
 java.lang.String valueObjectMatch()
           
 java.lang.String valueObjectName()
           
 
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

ValueObjectTagsHandler

public ValueObjectTagsHandler()
Method Detail

isGenerationNeeded

public static boolean isGenerationNeeded(com.sun.javadoc.ClassDoc clazz)

getCurrentValueObjectClass

public static java.lang.String getCurrentValueObjectClass(com.sun.javadoc.ClassDoc clazz,
                                                          com.sun.javadoc.Tag tag)
                                                   throws XDocletException

getCurrentValueObjectName

public static java.lang.String getCurrentValueObjectName(com.sun.javadoc.ClassDoc clazz,
                                                         com.sun.javadoc.Tag tag)
                                                  throws XDocletException

getCurrentValueObjectAttribute

public static java.lang.String getCurrentValueObjectAttribute(com.sun.javadoc.ClassDoc clazz,
                                                              com.sun.javadoc.Tag tag)
                                                       throws XDocletException

getCurrentValueObjectMatch

public static java.lang.String getCurrentValueObjectMatch(com.sun.javadoc.ClassDoc clazz,
                                                          com.sun.javadoc.Tag tag)
                                                   throws XDocletException

getValueMostSuperObjectClass

public java.lang.String getValueMostSuperObjectClass(com.sun.javadoc.ClassDoc clazz)
                                              throws XDocletException
Parameters:
clazz - Description of Parameter
Returns:
the full qualified data-object class name
Throws:
XDocletException - Description of Exception

serialVersionUID

public java.lang.String serialVersionUID()
                                  throws XDocletException
Returns:
Description of the Returned Value
Throws:
XDocletException - Description of Exception

valueObjectClass

public java.lang.String valueObjectClass()
                                  throws XDocletException

valueObjectName

public java.lang.String valueObjectName()
                                 throws XDocletException

valueObjectMatch

public java.lang.String valueObjectMatch()
                                  throws XDocletException

extendsFrom

public java.lang.String extendsFrom()
                             throws XDocletException
Returns the name of the class dataobject class extends.
Returns:
The name of generated PK class.
Throws:
XDocletException - Description of Exception

forAllValueObjects

public void forAllValueObjects(java.lang.String pTemplate)
                        throws XDocletException
Parameters:
pTemplate -  
Throws:
XDocletException -  

currentValueObjectClass

public java.lang.String currentValueObjectClass()

currentValueObjectAttribute

public java.lang.String currentValueObjectAttribute()

currentValueObjectMatch

public java.lang.String currentValueObjectMatch()

currentAggregateType

public java.lang.String currentAggregateType(java.util.Properties attributes)

currentAggregateName

public java.lang.String currentAggregateName()

currentRelationBeanClass

public java.lang.String currentRelationBeanClass()

valueMostSuperObjectClass

public java.lang.String valueMostSuperObjectClass()
                                           throws XDocletException
Returns the data-object class name highest in the hierarchy of derived beans. Because of possible inheritance between entity bean, the type of the generated getData method must be the one of the most super class of the current entity bean. The current Data class must extend the corresponding super Data class.
Returns:
The data-object class name highest in the hierarchy of derived beans.
Throws:
XDocletException - Description of Exception

forAllSuperSetValue

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

ifEagerInstantiation

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

forAllAggregates

public void forAllAggregates(java.lang.String template,
                             java.util.Properties attributes)
                      throws XDocletException

forAllComposes

public void forAllComposes(java.lang.String template,
                           java.util.Properties attributes)
                    throws XDocletException

forAllRelations

public void forAllRelations(java.lang.String template,
                            java.util.Properties attributes)
                     throws XDocletException

ifUsingValueObject

public void ifUsingValueObject(java.lang.String template)
                        throws XDocletException
Evaluate the body block if Value Object subtask being used.
Parameters:
template -  
Throws:
XDocletException - Description of Exception

forAllSetters

protected void forAllSetters(java.lang.String template,
                             java.lang.String methodName)
                      throws XDocletException