|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectxdoclet.template.TemplateTagHandler
xdoclet.XDocletTagSupport
xdoclet.modules.ejb.EjbTagsHandler
xdoclet.modules.ejb.entity.ValueObjectTagsHandler
public class ValueObjectTagsHandler
Tags used by the Value Object templates.
Field Summary |
---|
Fields inherited from class xdoclet.modules.ejb.EjbTagsHandler |
---|
ALL, LOCAL_SUFFIX, SERVICE_ENDPOINT, SERVICE_ENDPOINT_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 |
collectionType()
Returns the collection type for the current field. |
java.lang.String |
concreteCollectionType()
Type of the constructor for aggregates or compositions. |
java.lang.String |
currentAggregateName(java.util.Properties attributes)
Returns the current aggregate's name |
java.lang.String |
currentAggregateType(java.util.Properties attributes)
Returns the class name of the current aggregate attribute's type. |
java.lang.String |
currentRelationBeanClass()
Return the bean class name for the current relation. |
java.lang.String |
currentValueObjectAttribute()
Return the current value object's attribute name. |
java.lang.String |
currentValueObjectClass()
Return the current value object's class name. |
java.lang.String |
currentValueObjectMatch()
Return the current value object's match parameter. |
java.lang.String |
extendsFrom(java.util.Properties attributes)
Returns the name of the class the specified value object extends. |
void |
forAllAggregates(java.lang.String template,
java.util.Properties attributes)
Loop over all the aggregate fields in the given value object, and generate the body for each one. |
void |
forAllComposes(java.lang.String template,
java.util.Properties attributes)
Loop over all the composed fields in the given value object, and generate the body for each one. |
void |
forAllRelations(java.lang.String template,
java.util.Properties attributes)
Loop over all the relation fields in the given value object, and generate the body for each one. |
protected void |
forAllSetters(java.lang.String template,
java.lang.String methodName)
|
void |
forAllSuperSetValue(java.lang.String template)
Describe what the method does |
void |
forAllValueObjects(java.lang.String pTemplate)
Loops over all the ejb.value-object tags in the class, and generates the body for each one. |
static java.lang.String |
getCurrentValueObjectAttribute(xjavadoc.XTag tag)
Gets the CurrentValueObjectAttribute attribute of the ValueObjectTagsHandler class |
static java.lang.String |
getCurrentValueObjectClass(xjavadoc.XClass clazz,
xjavadoc.XTag tag)
Gets the CurrentValueObjectClass attribute of the ValueObjectTagsHandler class |
static java.lang.String |
getCurrentValueObjectExtends(xjavadoc.XTag tag)
|
static java.lang.String |
getCurrentValueObjectImplements(xjavadoc.XTag tag)
|
static java.lang.String |
getCurrentValueObjectMatch(xjavadoc.XTag tag)
Gets the CurrentValueObjectMatch attribute of the ValueObjectTagsHandler class |
static java.lang.String |
getCurrentValueObjectName(xjavadoc.XTag tag)
Gets the CurrentValueObjectName attribute of the ValueObjectTagsHandler class |
java.lang.String |
getValueMostSuperObjectClass(xjavadoc.XClass clazz)
|
void |
ifGeneratePKConstructor(java.lang.String template,
java.util.Properties attributes)
Evaluates the body if the valueobject subtask's generatePKConstructor parameter is
true . |
void |
ifIsAbstractValueObject(java.lang.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(java.lang.String template)
Executes the body only if the current field is a collection. |
void |
ifIsNotCollection(java.lang.String template)
Executes the body only if the current field is not a collection. |
void |
ifNotIsAbstractValueObject(java.lang.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(java.lang.String template)
Evaluate the body block if Value Object subtask being used. |
boolean |
isAbstractValueObject(java.lang.String valueObjectName,
xjavadoc.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(xjavadoc.XClass clazz)
Gets the GenerationNeeded attribute of the ValueObjectTagsHandler class |
static boolean |
isValueObjectRelation(xjavadoc.XMethod method,
java.lang.String valueObject)
Checks if a method is a value object relation (aggregate or compose) matching a certain valueObject |
java.lang.String |
valueMostSuperObjectClass()
Returns the data-object class name highest in the hierarchy of derived beans. |
java.lang.String |
valueObjectClass()
Return the current value object's class name. |
java.lang.String |
valueObjectImplements()
return interfaces to be implemented |
java.lang.String |
valueObjectMatch()
Return the current value object's match parameter. |
java.lang.String |
valueObjectName()
Return the current value object's name. |
Methods inherited from class xdoclet.template.TemplateTagHandler |
---|
getXJavaDoc, setXJavaDoc |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ValueObjectTagsHandler()
Method Detail |
---|
public static boolean isValueObjectRelation(xjavadoc.XMethod method, java.lang.String valueObject)
method
- valueObject
-
public static boolean isGenerationNeeded(xjavadoc.XClass clazz)
clazz
- Describe what the parameter does
public static java.lang.String getCurrentValueObjectClass(xjavadoc.XClass clazz, xjavadoc.XTag tag) throws XDocletException
clazz
- Describe what the parameter doestag
- Describe what the parameter does
XDocletException
public static java.lang.String getCurrentValueObjectName(xjavadoc.XTag tag) throws XDocletException
tag
- Describe what the parameter does
XDocletException
public static java.lang.String getCurrentValueObjectAttribute(xjavadoc.XTag tag) throws XDocletException
tag
- Describe what the parameter does
XDocletException
public static java.lang.String getCurrentValueObjectMatch(xjavadoc.XTag tag)
tag
- Describe what the parameter does
public static java.lang.String getCurrentValueObjectImplements(xjavadoc.XTag tag)
public static java.lang.String getCurrentValueObjectExtends(xjavadoc.XTag tag)
public boolean isAbstractValueObject(java.lang.String valueObjectName, xjavadoc.XClass currentClass) throws XDocletException
abstract
parameter is set to true on the supplied class' ejb.value-object tag for
the given VO name.
valueObjectName
- currentClass
-
XDocletException
public java.lang.String getValueMostSuperObjectClass(xjavadoc.XClass clazz) throws XDocletException
clazz
- Description of Parameter
XDocletException
public void ifGeneratePKConstructor(java.lang.String template, java.util.Properties attributes) throws XDocletException
valueobject
subtask's generatePKConstructor
parameter is
true
.
template
- The body of the block tagattributes
- The attributes of the template tag
XDocletException
public void ifIsAbstractValueObject(java.lang.String template) throws XDocletException
abstract
parameter is set to true on the ejb.value-object tag for the
current VO.
template
- The body of the block tag
XDocletException
public void ifNotIsAbstractValueObject(java.lang.String template) throws XDocletException
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
XDocletException
public java.lang.String valueObjectClass() throws XDocletException
XDocletException
public java.lang.String valueObjectName() throws XDocletException
XDocletException
public java.lang.String valueObjectMatch() throws XDocletException
XDocletException
public java.lang.String extendsFrom(java.util.Properties attributes) throws XDocletException
extends
parameter exists on
the ejb.value-object
tag, java.lang.Object
is returned.
attributes
- The attributes of the template tag
XDocletException
public void forAllValueObjects(java.lang.String pTemplate) throws XDocletException
pTemplate
- The body of the block tag
XDocletException
public java.lang.String currentValueObjectClass()
public java.lang.String currentValueObjectAttribute()
public java.lang.String currentValueObjectMatch()
public java.lang.String currentAggregateType(java.util.Properties attributes)
attributes
- The attributes of the template tag
public java.lang.String valueObjectImplements()
public java.lang.String currentAggregateName(java.util.Properties attributes)
attributes
-
XDocletException
- if an error occurespublic java.lang.String currentRelationBeanClass()
public java.lang.String concreteCollectionType() throws XDocletException
XDocletException
public java.lang.String collectionType() throws XDocletException
XDocletException
- if an error occurespublic void ifIsCollection(java.lang.String template) throws XDocletException
template
- the template
XDocletException
- if an error occurespublic void ifIsNotCollection(java.lang.String template) throws XDocletException
template
- the template
XDocletException
- if an error occurespublic java.lang.String valueMostSuperObjectClass() throws XDocletException
XDocletException
public void forAllSuperSetValue(java.lang.String template) throws XDocletException
template
- The body of the block tag
XDocletException
public void forAllAggregates(java.lang.String template, java.util.Properties attributes) throws XDocletException
template
- The body of the block tagattributes
- The attributes of the template tag
XDocletException
public void forAllComposes(java.lang.String template, java.util.Properties attributes) throws XDocletException
template
- The body of the block tagattributes
- The attributes of the template tag
XDocletException
public void forAllRelations(java.lang.String template, java.util.Properties attributes) throws XDocletException
template
- The body of the block tagattributes
- The attributes of the template tag
XDocletException
public void ifUsingValueObject(java.lang.String template) throws XDocletException
template
- The body of the block tag
XDocletException
protected void forAllSetters(java.lang.String template, java.lang.String methodName) throws XDocletException
XDocletException
|
http://xdoclet.sourceforge.net/ | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |