org.objectweb.jonas_ejb.genic
Class VcCMRField

java.lang.Object
  |
  +--org.objectweb.jonas_ejb.genic.VcCMRField

public class VcCMRField
extends java.lang.Object

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

Author:
S.Chassande-Barrioz

Constructor Summary
VcCMRField(EjbRelationshipRoleDesc rsr)
          It builds a cmr field descriptor usable in velocity contexts.
 
Method Summary
 EntityCmp2Desc getElement()
           
 java.lang.String getGenClassName()
          If the cmr is multiple, it returns the class name of the gen class which must be used, otherwise null.
 java.lang.String getHelperClassName()
           
 java.lang.String getHelperFQClassName()
           
 java.lang.String getName()
          It returns the name of the cmr field.
 java.lang.String getOppositeHelperClassName()
           
 java.lang.String getOppositeHelperFQClassName()
           
 java.lang.String getOppositeUFLCMRName()
          It returns the JOnAS meta object which represents the opposite cmr field, a EjbRelationshipRoleDesc.
 EjbRelationshipRoleDesc getRsr()
          It returns the JOnAS meta object which represents the cmr field, a EjbRelationshipRoleDesc.
 java.lang.String getTypeName()
          It returns the type name of the cmr field.
 java.lang.String getUFLName()
          It returns the name of cmr field with the first letter capitalized.
 boolean isMMb()
           
 boolean isMMu()
           
 boolean isMOb()
           
 boolean isMOu()
           
 boolean isOMb()
           
 boolean isOMu()
           
 boolean isOOb()
           
 boolean isOOu()
           
 java.lang.String toString()
           
 java.lang.String upperFL(java.lang.String word)
          It capitallizes the first letter of a word.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

VcCMRField

public VcCMRField(EjbRelationshipRoleDesc rsr)
           throws GenICException
It builds a cmr field descriptor usable in velocity contexts.
Method Detail

getName

public java.lang.String getName()
It returns the name of the cmr field.

getTypeName

public java.lang.String getTypeName()
It 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).

getUFLName

public java.lang.String getUFLName()
It returns the name of cmr field with the first letter capitalized.

getRsr

public EjbRelationshipRoleDesc getRsr()
It returns the JOnAS meta object which represents the cmr field, a EjbRelationshipRoleDesc.

getOppositeUFLCMRName

public java.lang.String getOppositeUFLCMRName()
It returns the JOnAS meta object which represents the opposite cmr field, a EjbRelationshipRoleDesc.

getHelperClassName

public java.lang.String getHelperClassName()

getHelperFQClassName

public java.lang.String getHelperFQClassName()

getOppositeHelperClassName

public java.lang.String getOppositeHelperClassName()

getOppositeHelperFQClassName

public java.lang.String getOppositeHelperFQClassName()

getGenClassName

public java.lang.String getGenClassName()
If the cmr is multiple, it returns the class name of the gen class which must be used, otherwise null. The class which the is returned implements the interface which the name is returned by the 'getTypeName' method.

getElement

public EntityCmp2Desc getElement()

upperFL

public java.lang.String upperFL(java.lang.String word)
It capitallizes the first letter of a word.

isOOu

public boolean isOOu()

isOOb

public boolean isOOb()

isOMu

public boolean isOMu()

isMOu

public boolean isMOu()

isMOb

public boolean isMOb()

isOMb

public boolean isOMb()

isMMu

public boolean isMMu()

isMMb

public boolean isMMb()

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object