forAllRelationships
public void forAllRelationships(String template)
throws xdoclet.XDocletException
Evaluates the body block for each relationship. Relations are denoted by ejb:relation for the getter method of
the cmr-field.
template
- The body of the block tag
xdoclet.XDocletException
-
xdoclet.modules.ejb.entity.CmpTagsHandler.isEntityCmp(xjavadoc.XClass)
, xdoclet.modules.ejb.entity.PersistentTagsHandler.isPersistentField(xjavadoc.XMethod)
, xdoclet.tagshandler.MethodTagsHandler.isGetter(java.lang.String)
, isSetOrCollection(java.lang.String)
hasRelationships
protected boolean hasRelationships()
ifHasLeftRoleName
public void ifHasLeftRoleName(String template)
throws xdoclet.XDocletException
Describe what the method does
template
- Describe what the parameter does
xdoclet.XDocletException
-
ifHasRelationships
public void ifHasRelationships(String template)
throws xdoclet.XDocletException
Evaluates the body if at least one of the classes has an ejb:relation tag, otherwise not.
template
- The body of the block tag
xdoclet.XDocletException
-
ifHasRightRoleName
public void ifHasRightRoleName(String template)
throws xdoclet.XDocletException
Describe what the method does
template
- Describe what the parameter does
xdoclet.XDocletException
-
ifIsBidirectional
public void ifIsBidirectional(String template)
throws xdoclet.XDocletException
Describe what the method does
template
- Describe what the parameter does
xdoclet.XDocletException
-
ifIsLeftMany
public void ifIsLeftMany(String template)
throws xdoclet.XDocletException
Describe what the method does
template
- Describe what the parameter does
xdoclet.XDocletException
-
ifIsMany2Many
public void ifIsMany2Many(String template)
throws xdoclet.XDocletException
Evaluates the body block if the current relationship is a many to many type, meaning, both sides of the relation
returns java.util.Collection or java.util.Set. Used by forAllRelationships.
template
- The body of the block tag
xdoclet.XDocletException
-
forAllRelationships(java.lang.String)
ifIsNotACollection
public void ifIsNotACollection(String template)
throws xdoclet.XDocletException
Evaluates the body block if current method's return type is not a java.util.Collection or java.util.Set. Used by
forAllRelationships.
template
- The body of the block tag
xdoclet.XDocletException
-
forAllRelationships(java.lang.String)
ifIsOne2Many
public void ifIsOne2Many(String template)
throws xdoclet.XDocletException
Evaluates the body block if the current relationship is a one to many type, meaning, ONLY ONE side of the
relation returns java.util.Collection or java.util.Set. Used by forAllRelationships.
template
- The body of the block tag
xdoclet.XDocletException
-
forAllRelationships(java.lang.String)
ifIsOne2One
public void ifIsOne2One(String template)
throws xdoclet.XDocletException
Evaluates the body block if the current relationship is a one to one type, meaning, neither side of the relation
returns java.util.Collection or java.util.Set. Used by forAllRelationships.
template
- The body of the block tag
xdoclet.XDocletException
-
forAllRelationships(java.lang.String)
ifIsRightMany
public void ifIsRightMany(String template)
throws xdoclet.XDocletException
Describe what the method does
template
- Describe what the parameter does
xdoclet.XDocletException
-
ifIsUnidirectional
public void ifIsUnidirectional(String template)
throws xdoclet.XDocletException
Describe what the method does
template
- Describe what the parameter does
xdoclet.XDocletException
-
ifLeftCascadeDelete
public void ifLeftCascadeDelete(String template)
throws xdoclet.XDocletException
Evaluates the body if the left side of this relation has cascade-delete=yes
template
- The body of the block tag
xdoclet.XDocletException
-
ifLeftNavigable
public void ifLeftNavigable(String template)
throws xdoclet.XDocletException
Describe what the method does
template
- Describe what the parameter does
xdoclet.XDocletException
-
ifNotHasRelationships
public void ifNotHasRelationships(String template)
throws xdoclet.XDocletException
Evaluates the body if none of the classes has an ejb:relation tag, otherwise not.
template
- The body of the block tag
xdoclet.XDocletException
-
ifNotIsMany2Many
public void ifNotIsMany2Many(String template)
throws xdoclet.XDocletException
Evaluates the body block if the current relationship IS NOT a many to many type, meaning, at least one side of
the relation does not return java.util.Collection or java.util.Set. Used by forAllRelationships.
template
- The body of the block tag
xdoclet.XDocletException
-
forAllRelationships(java.lang.String)
ifNotIsOne2Many
public void ifNotIsOne2Many(String template)
throws xdoclet.XDocletException
Evaluates the body block if the current relationship IS NOT a one to many type, meaning, either both sides, or
neither side of the relation returns java.util.Collection or java.util.Set. Used by forAllRelationships.
template
- The body of the block tag
xdoclet.XDocletException
-
forAllRelationships(java.lang.String)
ifNotIsOne2One
public void ifNotIsOne2One(String template)
throws xdoclet.XDocletException
Evaluates the body block if the current relationship IS NOT a one to one type, meaning, at least one side of the
relation returns java.util.Collection or java.util.Set. Used by forAllRelationships.
template
- The body of the block tag
xdoclet.XDocletException
-
forAllRelationships(java.lang.String)
ifRightCascadeDelete
public void ifRightCascadeDelete(String template)
throws xdoclet.XDocletException
Evaluates the body if the right side of this relation has cascade-delete=yes, or the left side has
target-relation cascade-delete="yes"
template
- The body of the block tag
xdoclet.XDocletException
-
ifRightNavigable
public void ifRightNavigable(String template)
throws xdoclet.XDocletException
Describe what the method does
template
- Describe what the parameter does
xdoclet.XDocletException
-
isSetOrCollection
protected boolean isSetOrCollection(String type)
Returns true if current method's return type is a java.util.Collection or java.util.Set, false otherwise.
type
- Description of Parameter
- true if Collection or Set
leftEJBName
public String leftEJBName()
throws xdoclet.XDocletException
Returns the EJB Name of the left side of this relationship
xdoclet.XDocletException
-
leftFieldName
public String leftFieldName()
throws xdoclet.XDocletException
Describe what the method does
- Describe the return value
xdoclet.XDocletException
-
leftFieldType
public String leftFieldType()
throws xdoclet.XDocletException
Describe what the method does
- Describe the return value
xdoclet.XDocletException
-
leftMultiplicity
public String leftMultiplicity()
throws xdoclet.XDocletException
Describe what the method does
- Describe the return value
xdoclet.XDocletException
-
leftRoleName
public String leftRoleName()
throws xdoclet.XDocletException
Describe what the method does
- Describe the return value
xdoclet.XDocletException
-
relationComment
public String relationComment()
Describe what the method does
- Describe the return value
relationName
public String relationName()
throws xdoclet.XDocletException
- the name of the current relation
xdoclet.XDocletException
-
rightEJBName
public String rightEJBName()
throws xdoclet.XDocletException
Returns the EJB Name of the right side of this relationship
xdoclet.XDocletException
-
rightFieldName
public String rightFieldName()
throws xdoclet.XDocletException
Describe what the method does
- Describe the return value
xdoclet.XDocletException
-
rightFieldType
public String rightFieldType()
throws xdoclet.XDocletException
Describe what the method does
- Describe the return value
xdoclet.XDocletException
-
rightMultiplicity
public String rightMultiplicity()
throws xdoclet.XDocletException
Describe what the method does
- Describe the return value
xdoclet.XDocletException
-
rightRoleName
public String rightRoleName()
throws xdoclet.XDocletException
Describe what the method does
- Describe the return value
xdoclet.XDocletException
-