Tags used by the Value Object templates.
collectionType
public String collectionType()
throws xdoclet.XDocletException
Returns the collection type for the current field.
xdoclet.XDocletException
- if an error occures
concreteCollectionType
public String concreteCollectionType()
throws xdoclet.XDocletException
Type of the constructor for aggregates or compositions.
- Type of the constructor for aggregates or compositions.
xdoclet.XDocletException
-
currentAggregateName
public String currentAggregateName(Properties attributes)
Returns the current aggregate's name
- name = "plural"
optional = "true"
values = "true, false"
default = "false"
descriptions = "return
the plural of the aggregate's name if set to true"
- name = "decapitalize"
optional = "true"
values = "true, false"
default = "false"
descriptions = "return the decapitalize aggregate's name if set to true"
currentAggregateType
public String currentAggregateType(Properties attributes)
Returns the class name of the current aggregate attribute's type.
attributes
- The attributes of the template tag
- name = "short"
description = "Use the short (not fully-qualified) class name."
currentRelationBeanClass
public String currentRelationBeanClass()
Return the bean class name for the current relation.
currentValueObjectAttribute
public String currentValueObjectAttribute()
Return the current value object's attribute name.
currentValueObjectClass
public String currentValueObjectClass()
Return the current value object's class name.
currentValueObjectMatch
public String currentValueObjectMatch()
Return the current value object's match parameter.
extendsFrom
public String extendsFrom(Properties attributes)
throws xdoclet.XDocletException
Returns the name of the class the specified value object extends. If no extends
parameter exists on
the ejb.value-object
tag, java.lang.Object
is returned.
attributes
- The attributes of the template tag
- The name of generated PK class.
xdoclet.XDocletException
-
- name = "valueobject"
optional = "false"
description = "The name of the value object to
check."
forAllAggregates
public void forAllAggregates(String template,
Properties attributes)
throws xdoclet.XDocletException
Loop over all the aggregate fields in the given value object, and generate the body for each one.
template
- The body of the block tagattributes
- The attributes of the template tag
xdoclet.XDocletException
-
- name = "superclasses"
values = "true,false"
description = "Whether to include fields in
superclasses."
- name = "valueobject"
optional = "false"
description = "The value object name."
forAllComposes
public void forAllComposes(String template,
Properties attributes)
throws xdoclet.XDocletException
Loop over all the composed fields in the given value object, and generate the body for each one.
template
- The body of the block tagattributes
- The attributes of the template tag
xdoclet.XDocletException
-
- name = "superclasses"
values = "true,false"
description = "Whether to include fields in
superclasses."
- name = "valueobject"
optional = "false"
description = "The value object name."
forAllRelations
public void forAllRelations(String template,
Properties attributes)
throws xdoclet.XDocletException
Loop over all the relation fields in the given value object, and generate the body for each one.
template
- The body of the block tagattributes
- The attributes of the template tag
xdoclet.XDocletException
-
- name = "superclasses"
values = "true,false"
description = "Whether to include fields in
superclasses."
- name = "valueobject"
optional = "false"
description = "The value object name."
forAllSetters
protected void forAllSetters(String template,
String methodName)
throws xdoclet.XDocletException
forAllSuperSetValue
public void forAllSuperSetValue(String template)
throws xdoclet.XDocletException
Describe what the method does
template
- The body of the block tag
xdoclet.XDocletException
-
forAllValueObjects
public void forAllValueObjects(String pTemplate)
throws xdoclet.XDocletException
Loops over all the ejb.value-object tags in the class, and generates the body for each one.
pTemplate
- The body of the block tag
xdoclet.XDocletException
-
getCurrentValueObjectAttribute
public static String getCurrentValueObjectAttribute(XTag tag)
throws xdoclet.XDocletException
Gets the CurrentValueObjectAttribute attribute of the ValueObjectTagsHandler class
tag
- Describe what the parameter does
- The CurrentValueObjectAttribute value
xdoclet.XDocletException
-
getCurrentValueObjectClass
public static String getCurrentValueObjectClass(XClass clazz,
XTag tag)
throws xdoclet.XDocletException
Gets the CurrentValueObjectClass attribute of the ValueObjectTagsHandler class
clazz
- Describe what the parameter doestag
- Describe what the parameter does
- The CurrentValueObjectClass value
xdoclet.XDocletException
-
getCurrentValueObjectExtends
public static String getCurrentValueObjectExtends(XTag tag)
getCurrentValueObjectImplements
public static String getCurrentValueObjectImplements(XTag tag)
getCurrentValueObjectMatch
public static String getCurrentValueObjectMatch(XTag tag)
Gets the CurrentValueObjectMatch attribute of the ValueObjectTagsHandler class
tag
- Describe what the parameter does
- The CurrentValueObjectMatch value
getCurrentValueObjectName
public static String getCurrentValueObjectName(XTag tag)
throws xdoclet.XDocletException
Gets the CurrentValueObjectName attribute of the ValueObjectTagsHandler class
tag
- Describe what the parameter does
- The CurrentValueObjectName value
xdoclet.XDocletException
-
getValueMostSuperObjectClass
public String getValueMostSuperObjectClass(XClass clazz)
throws xdoclet.XDocletException
clazz
- Description of Parameter
- the full qualified data-object class name
xdoclet.XDocletException
-
ifGeneratePKConstructor
public void ifGeneratePKConstructor(String template,
Properties attributes)
throws xdoclet.XDocletException
Evaluates the body if the valueobject
subtask's generatePKConstructor
parameter is
true
.
template
- The body of the block tagattributes
- The attributes of the template tag
xdoclet.XDocletException
-
ifIsAbstractValueObject
public void ifIsAbstractValueObject(String template)
throws xdoclet.XDocletException
Evaluates the body if the abstract
parameter is set to true on the ejb.value-object tag for the
current VO.
template
- The body of the block tag
xdoclet.XDocletException
-
ifIsCollection
public void ifIsCollection(String template)
throws xdoclet.XDocletException
Executes the body only if the current field is a collection.
xdoclet.XDocletException
- if an error occures
ifIsNotCollection
public void ifIsNotCollection(String template)
throws xdoclet.XDocletException
Executes the body only if the current field is not a collection.
xdoclet.XDocletException
- if an error occures
ifNotIsAbstractValueObject
public void ifNotIsAbstractValueObject(String template)
throws xdoclet.XDocletException
Evaluates the body if the abstract
parameter is set to false (or is missing) on the ejb.value-object
tag for the current VO.
template
- The body of the block tag
xdoclet.XDocletException
-
ifUsingValueObject
public void ifUsingValueObject(String template)
throws xdoclet.XDocletException
Evaluate the body block if Value Object subtask being used.
template
- The body of the block tag
xdoclet.XDocletException
-
isAbstractValueObject
public boolean isAbstractValueObject(String valueObjectName,
XClass currentClass)
throws xdoclet.XDocletException
Whether or not the abstract
parameter is set to true on the supplied class' ejb.value-object tag for
the given VO name.
valueObjectName
- currentClass
-
xdoclet.XDocletException
-
isGenerationNeeded
public static boolean isGenerationNeeded(XClass clazz)
Gets the GenerationNeeded attribute of the ValueObjectTagsHandler class
clazz
- Describe what the parameter does
- The GenerationNeeded value
isValueObjectRelation
public static boolean isValueObjectRelation(XMethod method,
String valueObject)
Checks if a method is a value object relation (aggregate or compose) matching a certain valueObject
valueMostSuperObjectClass
public String valueMostSuperObjectClass()
throws xdoclet.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.
- The data-object class name highest in the hierarchy of derived beans.
xdoclet.XDocletException
-
valueObjectClass
public String valueObjectClass()
throws xdoclet.XDocletException
Return the current value object's class name.
xdoclet.XDocletException
-
valueObjectImplements
public String valueObjectImplements()
return interfaces to be implemented
valueObjectMatch
public String valueObjectMatch()
throws xdoclet.XDocletException
Return the current value object's match parameter.
xdoclet.XDocletException
-
valueObjectName
public String valueObjectName()
throws xdoclet.XDocletException
Return the current value object's name.
xdoclet.XDocletException
-