com.ibm.wala.j2ee
Interface BeanMetaData

All Known Implementing Classes:
BeanMetaDataImpl

public interface BeanMetaData

Deployment descriptor data for a single EJB. TODO: this currently can represent either a session or entity bean. Introduce classes to distinguish between them.


Method Summary
 org.eclipse.jst.j2ee.ejb.EnterpriseBean getBean()
           
 java.util.Collection<FieldReference> getCMPFields()
          Return a Set of IFields, one corresponding to each CMP field in this bean.
 java.util.Set<java.lang.Object> getCMRFields()
          Return a Set of container managed relationship (cmr) fields, as FieldReference objects.
 java.util.Map<MethodReference,FieldReference> getCMRGetters()
          Return a Map of container created getter methods for CMRs, as a mapping from MethodReference->FieldReference.
 java.util.Map<MethodReference,FieldReference> getCMRSetters()
          Return a Map of container created setter methods for CMRs, as a mapping from MethodReference->FieldReference.
 TypeReference getEJBClass()
          Return the type of the EJB class for this entity bean
 org.eclipse.jst.j2ee.ejb.EJBJar getEJBJar()
           
 FieldReference getField(org.eclipse.jst.j2ee.ejb.CMRField firstField)
          Method getField.
 java.util.Set<MethodReference> getFinders()
          Return the Set of container created finder methods, as Method reference objects.
 java.util.Map<java.lang.Object,FieldReference> getGetterMethods()
          Return a Map of the container created getter methods, as MethodReference objects, and the field that the method references.
 TypeReference getHomeInterface()
           
 TypeReference getLocalHomeInterface()
           
 TypeReference getLocalInterface()
           
 TypeReference getPrimaryKeyType()
           
 TypeReference getRemoteInterface()
           
 java.util.Map<java.lang.Object,FieldReference> getSetterMethods()
          Return a Map of the container created setter methods, as MethodReference objects, and the field that the method references.
 boolean isBeanManaged()
          Return true if the bean uses BMP
 boolean isContainerManaged()
          Return true if the bean is container managed.
 boolean isContainerManagedEntity()
          Return true if the bean is a container managed entity.
 boolean isMessageDrivenBean()
          Return true if the bean is a message-driven
 boolean isSessionBean()
          Return true if the bean is a session bean.
 

Method Detail

getCMPFields

java.util.Collection<FieldReference> getCMPFields()
Return a Set of IFields, one corresponding to each CMP field in this bean.

Returns:
Set of IFields

getCMRFields

java.util.Set<java.lang.Object> getCMRFields()
Return a Set of container managed relationship (cmr) fields, as FieldReference objects.

Returns:
Set of cmrs

getGetterMethods

java.util.Map<java.lang.Object,FieldReference> getGetterMethods()
Return a Map of the container created getter methods, as MethodReference objects, and the field that the method references.

Returns:
Map of container created getter methods and field reference.

getSetterMethods

java.util.Map<java.lang.Object,FieldReference> getSetterMethods()
Return a Map of the container created setter methods, as MethodReference objects, and the field that the method references.

Returns:
Map of container created setter methods and field reference.

getCMRGetters

java.util.Map<MethodReference,FieldReference> getCMRGetters()
Return a Map of container created getter methods for CMRs, as a mapping from MethodReference->FieldReference. The container is responsible for creating a getter method for each container managed relationship.


getCMRSetters

java.util.Map<MethodReference,FieldReference> getCMRSetters()
Return a Map of container created setter methods for CMRs, as a mapping from MethodReference->FieldReference. The container is responsible for creating a setter method for each container managed relationship.


getEJBClass

TypeReference getEJBClass()
Return the type of the EJB class for this entity bean

Returns:
TypeReference

isContainerManaged

boolean isContainerManaged()
Return true if the bean is container managed.

Returns:
true if bean is container manged.

isContainerManagedEntity

boolean isContainerManagedEntity()
Return true if the bean is a container managed entity.

Returns:
true if bean is a container manged entity.

isBeanManaged

boolean isBeanManaged()
Return true if the bean uses BMP

Returns:
true if bean uses BMP

isSessionBean

boolean isSessionBean()
Return true if the bean is a session bean.

Returns:
true if bean is a session bean.

isMessageDrivenBean

boolean isMessageDrivenBean()
Return true if the bean is a message-driven

Returns:
true if bean is a message-driven

getFinders

java.util.Set<MethodReference> getFinders()
Return the Set of container created finder methods, as Method reference objects.

Returns:
Set of container created setter methods.

getField

FieldReference getField(org.eclipse.jst.j2ee.ejb.CMRField firstField)
Method getField.

Parameters:
firstField -
Returns:
FieldReference

getBean

org.eclipse.jst.j2ee.ejb.EnterpriseBean getBean()
Returns:
WCCM representation of this bean.

getEJBJar

org.eclipse.jst.j2ee.ejb.EJBJar getEJBJar()
Returns:
WCCM representation of this bean's container

getHomeInterface

TypeReference getHomeInterface()
Returns:
TypeReference representing this entity's home interface

getLocalHomeInterface

TypeReference getLocalHomeInterface()
Returns:
TypeReference representing this entity's local home interface

getRemoteInterface

TypeReference getRemoteInterface()
Returns:
TypeReference representing this entity's remote interface

getLocalInterface

TypeReference getLocalInterface()
Returns:
TypeReference representing this entity's local interface

getPrimaryKeyType

TypeReference getPrimaryKeyType()
Returns:
TypeReference representing this entity's primary key type.