com.ibm.wala.j2ee
Interface DeploymentMetaData

All Known Implementing Classes:
DeploymentMetaDataImpl

public interface DeploymentMetaData

Interface to data from deployment descriptors.


Method Summary
 java.util.Set<FieldReference> getAllCMPFields()
          Method getAllCMPFields.
 java.util.Set<java.lang.Object> getAllCMRFields()
          Return a Set of the container managed relationship (cmr) fields.
 java.util.Map<MethodReference,FieldReference> getAllCMRGetters()
          Return the Set of methods corresponding to EJB CMR getter methods, as a mapping from MethodReference -> FieldReference
 java.util.Collection<MethodReference> getAllFinders()
          Return the Set of MethodReferences corresponding to EJB finder methods.
 BeanMetaData getBeanForInterface(TypeReference t)
          Return the entity bean implementation corresponding to the interface t
 BeanMetaData getBeanMetaData(TypeReference type)
          Return the BeanMetaData describing a particular bean, or null if the type does not correspond to an EJB.
 FieldReference getCMPField(MemberReference mr)
          Method getCMPField.
 TypeReference getCMPType(TypeReference typeReference)
          Method getCMPType.
 BeanMetaData getCMRBean(FieldReference field)
          Given a field that is populated by a CMR, return the descriptor of the Bean type that the field will point to.
 org.eclipse.jst.j2ee.ejb.EJBRelationshipRole getCMRRole(FieldReference field)
           
 TypeReference getFinderBeanType(MemberReference method)
           
 FieldReference getOppositeField(FieldReference field)
           
 boolean isCMPGetter(MemberReference mr)
          Method isCMPGetter.
 boolean isCMPSetter(MemberReference mr)
          Method isCMPSetter.
 boolean isCMRGetter(MemberReference method)
           
 boolean isCMRSetter(MemberReference method)
           
 boolean isContainerManaged(TypeReference t)
          Return true if the class is container managed.
 boolean isEJBInterface(TypeReference t)
          Is a class an EJB interface (any flavor)?
 boolean isFinder(MemberReference ref)
           
 boolean isHomeInterface(TypeReference t)
          Is a class an EJB home interface?
 boolean isLocalHomeInterface(TypeReference t)
          Is a class an EJB local home interface?
 boolean isLocalInterface(TypeReference t)
          Is a class an EJB local interface?
 boolean isMessageDriven(TypeReference type)
          Is type an MDB?
 boolean isRemoteInterface(TypeReference t)
          Is a class an EJB remote interface?
 java.util.Iterator<BeanMetaData> iterateEntities()
           
 java.util.Iterator<BeanMetaData> iterateMDBs()
           
 java.util.Iterator<BeanMetaData> iterateSessions()
           
 

Method Detail

getBeanMetaData

BeanMetaData getBeanMetaData(TypeReference type)
Return the BeanMetaData describing a particular bean, or null if the type does not correspond to an EJB.

Parameters:
type - TypeReference

getAllCMPFields

java.util.Set<FieldReference> getAllCMPFields()
Method getAllCMPFields.

Returns:
Set

getAllCMRFields

java.util.Set<java.lang.Object> getAllCMRFields()
Return a Set of the container managed relationship (cmr) fields.

Returns:
Set of container managed relationship fields.

isRemoteInterface

boolean isRemoteInterface(TypeReference t)
Is a class an EJB remote interface?


isHomeInterface

boolean isHomeInterface(TypeReference t)
Is a class an EJB home interface?


isLocalInterface

boolean isLocalInterface(TypeReference t)
Is a class an EJB local interface?


isLocalHomeInterface

boolean isLocalHomeInterface(TypeReference t)
Is a class an EJB local home interface?


isEJBInterface

boolean isEJBInterface(TypeReference t)
Is a class an EJB interface (any flavor)?


isMessageDriven

boolean isMessageDriven(TypeReference type)
Is type an MDB?


getBeanForInterface

BeanMetaData getBeanForInterface(TypeReference t)
Return the entity bean implementation corresponding to the interface t

Parameters:
t - the home or remote interface for a bean
Returns:
the BeanMetaData, or null if not found.

isContainerManaged

boolean isContainerManaged(TypeReference t)
Return true if the class is container managed.

Returns:
true if the class is container managed.

getCMPType

TypeReference getCMPType(TypeReference typeReference)
Method getCMPType.

Parameters:
typeReference -
Returns:
TypeReference

isCMPGetter

boolean isCMPGetter(MemberReference mr)
Method isCMPGetter.

Parameters:
mr -
Returns:
boolean

getCMPField

FieldReference getCMPField(MemberReference mr)
Method getCMPField.

Parameters:
mr -
Returns:
the CMP Field the method gets or sets.

isCMPSetter

boolean isCMPSetter(MemberReference mr)
Method isCMPSetter.

Parameters:
mr -
Returns:
boolean

getAllFinders

java.util.Collection<MethodReference> getAllFinders()
Return the Set of MethodReferences corresponding to EJB finder methods.

Returns:
Collection

getAllCMRGetters

java.util.Map<MethodReference,FieldReference> getAllCMRGetters()
Return the Set of methods corresponding to EJB CMR getter methods, as a mapping from MethodReference -> FieldReference

Returns:
Collection

getCMRBean

BeanMetaData getCMRBean(FieldReference field)
Given a field that is populated by a CMR, return the descriptor of the Bean type that the field will point to.

Parameters:
field -
Returns:
BeanMetaData

getFinderBeanType

TypeReference getFinderBeanType(MemberReference method)
Parameters:
method - a finder
Returns:
the type representing the bean that is returned by this finder

isFinder

boolean isFinder(MemberReference ref)
Parameters:
ref -
Returns:
true iff ref is finder method

iterateEntities

java.util.Iterator<BeanMetaData> iterateEntities()
Returns:
Iterator of all entity beans available

iterateSessions

java.util.Iterator<BeanMetaData> iterateSessions()
Returns:
Iterator of all session beans available

iterateMDBs

java.util.Iterator<BeanMetaData> iterateMDBs()
Returns:
Iterator of all message-driven beans available

isCMRGetter

boolean isCMRGetter(MemberReference method)
Parameters:
method -
Returns:
true iff method is a getter for a CMR.

isCMRSetter

boolean isCMRSetter(MemberReference method)
Parameters:
method -
Returns:
true iff method is a setter for a CMR.

getOppositeField

FieldReference getOppositeField(FieldReference field)
Parameters:
field - a field that represents a CMR
Returns:
the corresponding field on the opposite role of the CMR

getCMRRole

org.eclipse.jst.j2ee.ejb.EJBRelationshipRole getCMRRole(FieldReference field)
Parameters:
field - a field that represents a CMR
Returns:
the governing EJBRelationshipRole