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