org.objectweb.jonas_ejb.genic.VcCMRField Class Reference

List of all members.

Public Member Functions
	VcCMRField (EjbRelationshipRoleDesc rsr) throws GenICException
String	getName ()
String	getTypeName ()
String	getUFLName ()
EjbRelationshipRoleDesc	getRsr ()
String	getOppositeUFLCMRName ()
String	getHelperClassName ()
String	getHelperFQClassName ()
String	getOppositeHelperClassName ()
String	getOppositeHelperFQClassName ()
String	getGenClassName ()
EntityCmp2Desc	getElement ()
String	upperFL (String word)
boolean	isOOu ()
boolean	isOOb ()
boolean	isOMu ()
boolean	isMOu ()
boolean	isMOb ()
boolean	isOMb ()
boolean	isMMu ()
boolean	isMMb ()
String	toString ()

---

Detailed Description

This class is used in the velocity context. It represents a CMR field.

Author:

S.Chassande-Barrioz : Initial developer

Helene Joanin

Definition at line 39 of file VcCMRField.java.

---

Constructor & Destructor Documentation

org.objectweb.jonas_ejb.genic.VcCMRField.VcCMRField (  EjbRelationshipRoleDesc  rsr  )  throws GenICException

It builds a cmr field descriptor usable in velocity context. Parameters: rsr  The EjbRelationshipRoleDesc where this CMR field is defined Exceptions: GenICException  if the Deployment Decriptor is not conform Definition at line 80 of file VcCMRField.java. References org.objectweb.jonas_ejb.deployment.api.EjbRelationshipRoleDesc.getCmrFieldName(), org.objectweb.jonas_ejb.deployment.api.EjbRelationshipRoleDesc.getCmrFieldType(), org.objectweb.jonas_ejb.deployment.api.EjbRelationshipRoleDesc.getName(), org.objectweb.jonas_ejb.deployment.api.EjbRelationshipRoleDesc.getOppositeRelationshipRole(), org.objectweb.jonas_ejb.deployment.api.EjbRelationshipRoleDesc.getRelationType(), org.objectweb.jonas_ejb.deployment.api.EjbRelationshipRoleDesc.getTargetBean(), and org.objectweb.jonas_ejb.deployment.api.EjbRelationshipRoleDesc.isTargetMultiple.

Here is the call graph for this function:

---

Member Function Documentation

EntityCmp2Desc org.objectweb.jonas_ejb.genic.VcCMRField.getElement (   )

Returns: the description of the field Definition at line 192 of file VcCMRField.java.

String org.objectweb.jonas_ejb.genic.VcCMRField.getGenClassName (   )

Returns: the class name of the gen class which must be used if the cmr is multiple and return null otherwise. The class which the is returned implements the interface which the name is returned by the 'getTypeName' method. Definition at line 185 of file VcCMRField.java.

String org.objectweb.jonas_ejb.genic.VcCMRField.getHelperClassName (   )

CoherenceHelper class is used to manage coherence in relations. Returns: The JOnAS CoherenceHelper class name Definition at line 142 of file VcCMRField.java. References org.objectweb.jonas_ejb.deployment.api.EjbRelationshipRoleDesc.getSourceBeanName().

Here is the call graph for this function:

String org.objectweb.jonas_ejb.genic.VcCMRField.getHelperFQClassName (   )

CoherenceHelper class is used to manage coherence in relations. Returns: The Fully Qualified JOnAS CoherenceHelper class name Definition at line 150 of file VcCMRField.java. References org.objectweb.jonas_ejb.deployment.api.BeanDesc.getFullDerivedBeanName(), and org.objectweb.jonas_ejb.deployment.api.EjbRelationshipRoleDesc.getTargetBean().

Here is the call graph for this function:

String org.objectweb.jonas_ejb.genic.VcCMRField.getName (   )

Returns: the name of the cmr field. Definition at line 103 of file VcCMRField.java.

String org.objectweb.jonas_ejb.genic.VcCMRField.getOppositeHelperClassName (   )

CoherenceHelper class is used to manage coherence in relations. Returns: The JOnAS CoherenceHelper class name for opposite bean Definition at line 163 of file VcCMRField.java. References org.objectweb.jonas_ejb.deployment.api.EjbRelationshipRoleDesc.getSourceBeanName().

Here is the call graph for this function:

String org.objectweb.jonas_ejb.genic.VcCMRField.getOppositeHelperFQClassName (   )

CoherenceHelper class is used to manage coherence in relations. Returns: The JOnAS CoherenceHelper fully qualified class name for opposite bean Definition at line 171 of file VcCMRField.java. References org.objectweb.jonas_ejb.deployment.api.BeanDesc.getFullDerivedBeanName(), and org.objectweb.jonas_ejb.deployment.api.EjbRelationshipRoleDesc.getTargetBean().

Here is the call graph for this function:

String org.objectweb.jonas_ejb.genic.VcCMRField.getOppositeUFLCMRName (   )

Returns: the name of opposite cmr field with the first letter capitalized. Definition at line 134 of file VcCMRField.java. References org.objectweb.jonas_ejb.deployment.api.EjbRelationshipRoleDesc.getCmrFieldName().

Here is the call graph for this function:

EjbRelationshipRoleDesc org.objectweb.jonas_ejb.genic.VcCMRField.getRsr (   )

Returns: the JOnAS meta object where the CMR field is defined Definition at line 127 of file VcCMRField.java.

String org.objectweb.jonas_ejb.genic.VcCMRField.getTypeName (   )

Returns: the type name of the cmr field. It is the referenced class if the relation is multiple, otherwise the type of the multivalued relation (java.util.Collection or java.util.Set). Definition at line 112 of file VcCMRField.java.

String org.objectweb.jonas_ejb.genic.VcCMRField.getUFLName (   )

This is used to generate method names relative to the CMR Field Returns: the name of cmr field with the first letter capitalized. Definition at line 120 of file VcCMRField.java.

boolean org.objectweb.jonas_ejb.genic.VcCMRField.isMMb (   )

Returns: true if the relationship role is many-many bidirectional, false if not. Definition at line 257 of file VcCMRField.java.

boolean org.objectweb.jonas_ejb.genic.VcCMRField.isMMu (   )

Returns: true if the relationship role is many-many unidirectional, false if not. Definition at line 250 of file VcCMRField.java.

boolean org.objectweb.jonas_ejb.genic.VcCMRField.isMOb (   )

Returns: true if the relationship role is many-one bidirectional, false if not. Definition at line 236 of file VcCMRField.java.

boolean org.objectweb.jonas_ejb.genic.VcCMRField.isMOu (   )

Returns: true if the relationship role is many-one unidirectional, false if not. Definition at line 229 of file VcCMRField.java.

boolean org.objectweb.jonas_ejb.genic.VcCMRField.isOMb (   )

Returns: true if the relationship role is one-many bidirectional, false if not. Definition at line 243 of file VcCMRField.java.

boolean org.objectweb.jonas_ejb.genic.VcCMRField.isOMu (   )

Returns: true if the relationship role is one-many unidirectional, false if not. Definition at line 222 of file VcCMRField.java.

boolean org.objectweb.jonas_ejb.genic.VcCMRField.isOOb (   )

Returns: true if the relationship role is one-one bidirectional, false if not. Definition at line 215 of file VcCMRField.java.

boolean org.objectweb.jonas_ejb.genic.VcCMRField.isOOu (   )

Returns: true if the relationship role is one-one unidirectional, false if not. Definition at line 208 of file VcCMRField.java.

String org.objectweb.jonas_ejb.genic.VcCMRField.toString (   )

Returns: a string representation of the VcCMRField object for debug use Definition at line 264 of file VcCMRField.java.

String org.objectweb.jonas_ejb.genic.VcCMRField.upperFL (  String  word  )

It capitalizes the first letter of a word. Parameters: word  is the input string to capitalize the first letter Returns: a String with first letter capitalized Definition at line 201 of file VcCMRField.java.

---

The documentation for this class was generated from the following file:

• src/org/objectweb/jonas_ejb/genic/VcCMRField.java

---