org.objectweb.jonas_ejb.deployment.api
Class EntityCmpDesc

java.lang.Object
  org.objectweb.jonas_lib.deployment.api.DescriptionGroupDesc
      org.objectweb.jonas_lib.deployment.api.JndiEnvRefsGroupDesc
          org.objectweb.jonas_ejb.deployment.api.BeanDesc
              org.objectweb.jonas_ejb.deployment.api.EntityDesc
                  org.objectweb.jonas_ejb.deployment.api.EntityCmpDesc

All Implemented Interfaces:

DescriptionGroup, JndiEnvRefsGroup

Direct Known Subclasses:

EntityCmp1Desc, EntityCmp2Desc

public abstract class EntityCmpDesc
extends EntityDesc

Base class to hold meta-information related to an entity of type CMP.

Author:

Christophe Ney [cney@batisseurs.com] : Initial developer, Helene Joanin, Jerome Camilleri : automatic PK

Field Summary

protected java.util.HashMap	fieldDesc
protected java.lang.String	jdbcAutomaticPkFieldName
protected java.lang.String	primaryKeyField

Fields inherited from class org.objectweb.jonas_ejb.deployment.api.EntityDesc

cleanup, CLEANUP_CREATE, CLEANUP_NONE, CLEANUP_REMOVEALL, CLEANUP_REMOVEDATA, deadlockTimeout, hardLimit, inactivityTimeout, jdbcAutomaticPk, LOCK_CONTAINER_READ_COMMITTED, LOCK_CONTAINER_READ_UNCOMMITTED, LOCK_CONTAINER_READ_WRITE, LOCK_CONTAINER_SERIALIZED, LOCK_CONTAINER_SERIALIZED_TRANSACTED, LOCK_DATABASE, LOCK_READ_ONLY, lockPolicy, maxWaitTime, METHODS_HOME_NO_TX, METHODS_REMOTE_NO_TX, passivationTimeout, pkObjectType, prefetch, primaryKeyClass, readTimeout, reentrant, shared

Fields inherited from class org.objectweb.jonas_ejb.deployment.api.BeanDesc

BEAN_TRANSACTION_TYPE, beanIdentification, bf, cacheMax, clusterHomeDistributor, clusterRemoteDistributor, clusterReplicated, CONTAINER_TRANSACTION_TYPE, deploymentDesc, derivedBeanName, ejb10EnvProps, ejbClass, ejbName, ejbTimeoutSignature, fullDerivedBeanName, GENERATED_PREFIX, home, jndiLocalName, jndiName, local, localhome, logger, poolMin, remote, securityRoleRefDescList, timerTxAttribute, TRANS

Fields inherited from class org.objectweb.jonas_lib.deployment.api.DescriptionGroupDesc

description, displayName, largeIcon, smallIcon

Constructor Summary

EntityCmpDesc(java.lang.ClassLoader classLoader, Entity ent, AssemblyDescriptor asd, JonasEntity jEnt, JLinkedList jMDRList, java.lang.String fileName)
constructor to be used by parent node.

Method Summary

FieldDesc	getCmpFieldDesc(java.lang.String fieldName) Get descriptor for a given field name Used by GenIC
java.util.Iterator	getCmpFieldDescIterator()
java.lang.String	getJdbcAutomaticPkFieldName() Get the associated field for auto genarated pk field specify by user
java.lang.String	getPrimaryKeyFieldName()
FieldDesc	getSimplePkField() Get the primary key field for the entity.
java.lang.String	getSimplePkFieldName() Get the primary key field name for the entity.
boolean	hasPrimaryKeyField()
boolean	hasSimplePkField() Indicate if the primary key field is only one field with a primary-key-field defined in the DD.
protected FieldDesc	newFieldDescInstance() factory method for field descriptors
java.lang.String	toString() String representation of the object for test purpose

Methods inherited from class org.objectweb.jonas_ejb.deployment.api.EntityDesc

checkTxAttribute, getCleanupPolicy, getDeadlockTimeout, getInactivityTimeout, getLockPolicy, getMaxWaitTime, getPassivationTimeout, getPrimaryKeyClass, getReadTimeout, isAutomaticPk, isHardLimit, isPrefetch, isReentrant, isShared, isUndefinedPK

Methods inherited from class org.objectweb.jonas_ejb.deployment.api.BeanDesc

addEJBMethodDesc, addMethodDesc, check, checkRemoteException, checkRunAsMapping, checkValidTypesForRmi, getBeanFactory, getCacheMax, getClusterHomeDistributor, getClusterRemoteDistributor, getDeploymentDesc, getDerivedBeanName, getEjb10Environment, getEjbClass, getEjbName, getEjbTimeoutSignature, getFullDerivedBeanName, getFullWrpHandleName, getFullWrpHomeName, getFullWrpLocalHomeName, getFullWrpLocalName, getFullWrpRemoteName, getHashCodeForIdentifier, getHomeClass, getIdentifier, getJndiLocalName, getJndiName, getLocalClass, getLocalHomeClass, getMethodDesc, getMethodDesc, getMethodDescIterator, getParentClass, getPoolMin, getRemoteClass, getRunAsPrincipalName, getRunAsRole, getSasComponent, getSecurityRoleRefDescList, getTimerTxAttribute, getWrpHandleName, getWrpHomeName, getWrpLocalHomeName, getWrpLocalName, getWrpRemoteName, hasDefinedLocalInterface, isClusterReplicated, loadExtraClasses, newMethodDescInstance, setBeanFactory, setClusterReplicated, setDeploymentDesc, setSasComponent, verifyRoleName

Methods inherited from class org.objectweb.jonas_lib.deployment.api.JndiEnvRefsGroupDesc

getEjbLocalRefDesc, getEjbRefDesc, getEnvEntryDesc, getMessageDestinationRefDesc, getResourceEnvRefDesc, getResourceRefDesc, getServiceRefDesc

Methods inherited from class org.objectweb.jonas_lib.deployment.api.DescriptionGroupDesc

getDescription, getDisplayName, getLargeIcon, getSAXMsg, getSmallIcon

Methods inherited from class java.lang.Object

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

Field Detail

fieldDesc

protected java.util.HashMap fieldDesc

primaryKeyField

protected java.lang.String primaryKeyField

jdbcAutomaticPkFieldName

protected java.lang.String jdbcAutomaticPkFieldName

Constructor Detail

EntityCmpDesc

public EntityCmpDesc(java.lang.ClassLoader classLoader,
                     Entity ent,
                     AssemblyDescriptor asd,
                     JonasEntity jEnt,
                     JLinkedList jMDRList,
                     java.lang.String fileName)
              throws DeploymentDescException

constructor to be used by parent node.

Parameters:

classLoader - class loader to use to laod bean's classes

ent - entity in the standard deployment descriptor

asd - assembly-descriptor in the standard deployment descriptor

jEnt - jonas-entity in the JOnAS deployment descriptor

fileName - jar or directory containing ejb

Throws:

DeploymentDescException - in error case.

Method Detail

getCmpFieldDesc

public FieldDesc getCmpFieldDesc(java.lang.String fieldName)

Get descriptor for a given field name Used by GenIC

Parameters:

fieldName - Name of the field

Returns:

Descriptor for the given field or null

hasSimplePkField

public boolean hasSimplePkField()

Indicate if the primary key field is only one field with a primary-key-field defined in the DD.

Returns:

true if the primary key field is only one field with a primary-key-field defined in the DD.

hasPrimaryKeyField

public boolean hasPrimaryKeyField()

getSimplePkField

public FieldDesc getSimplePkField()

Get the primary key field for the entity.

Returns:

Field for the primary key

getSimplePkFieldName

public java.lang.String getSimplePkFieldName()

Get the primary key field name for the entity.

Returns:

Field for the primary key

getPrimaryKeyFieldName

public java.lang.String getPrimaryKeyFieldName()

getJdbcAutomaticPkFieldName

public java.lang.String getJdbcAutomaticPkFieldName()

Get the associated field for auto genarated pk field specify by user

Returns:

Name of the field where automatic pk bean is stored

getCmpFieldDescIterator

public java.util.Iterator getCmpFieldDescIterator()

toString

public java.lang.String toString()

String representation of the object for test purpose

Specified by:

toString in interface DescriptionGroup

Overrides:

toString in class EntityDesc

Returns:

String representation of this object

newFieldDescInstance

protected FieldDesc newFieldDescInstance()

factory method for field descriptors

Returns:

a FieldDesc.