vdoclet.ejb
Class EjbRelationRole

java.lang.Object
  |
  +--vdoclet.ejb.EjbRelationRole

public class EjbRelationRole

extends Object

One end of an EjbRelation

Nested Class Summary

static class

EjbRelationRole.Multiplicity Enumeration of possible multiplicity values

Constructor Summary

EjbRelationRole(EjbInfo ejb)

EjbRelationRole(EjbInfo ejb, FieldInfo cmrField)

Method Summary

EjbInfo	getEjb() Get the source EJB
String	getFieldName() Get the name of the CMR-field for this role
String	getFieldType() Get the type of the CMR-field, if it's a collection
EjbRelationRole.Multiplicity	getMultiplicity() Get the multiplicity for this role.
String	getName() Get the canonical name of this role
String	getTagValue(String name) Return the named tag from the CMR-field.
String	getTagValue(String name, String defaultValue) Return the named tag from the CMR-field.
EjbRelationRole	getTarget() Get the target for this role.
void	setField(FieldInfo cmrField) Register a CMR-field for this role
void	setField(MethodInfo cmrMethod) Register a get-method that defines the CMR-field for this role
void	setTarget(EjbRelationRole target) Set the target for this role.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EjbRelationRole

public EjbRelationRole(EjbInfo ejb)

EjbRelationRole

public EjbRelationRole(EjbInfo ejb,
                       FieldInfo cmrField)

Method Detail

getEjb

public EjbInfo getEjb()

Get the source EJB

getName

public String getName()

Get the canonical name of this role

setField

public void setField(FieldInfo cmrField)

Register a CMR-field for this role

Parameters:

cmrField - CMR-field info

setField

public void setField(MethodInfo cmrMethod)

Register a get-method that defines the CMR-field for this role

getFieldName

public String getFieldName()

Get the name of the CMR-field for this role

Returns:

the name of the role's CMR-field, or null if undefined

getFieldType

public String getFieldType()

Get the type of the CMR-field, if it's a collection

getTagValue

public String getTagValue(String name,
                          String defaultValue)

Return the named tag from the CMR-field. Return the specified defaultValue if the tag is not present.

getTagValue

public String getTagValue(String name)

Return the named tag from the CMR-field. Return null if the tag is not present.

getTarget

public EjbRelationRole getTarget()

Get the target for this role.

setTarget

public void setTarget(EjbRelationRole target)

Set the target for this role.

getMultiplicity

public EjbRelationRole.Multiplicity getMultiplicity()

Get the multiplicity for this role.