jrun.ejb.metadata
Class EntityMetaData

java.lang.Object
  |
  +--jrunx.xml.XMLMetaData
        |
        +--jrun.j2ee.metadata.DescriptionMetaData
              |
              +--jrun.j2ee.metadata.J2EEMetaData
                    |
                    +--jrun.j2ee.metadata.ServerJ2EEMetaData
                          |
                          +--jrun.ejb.metadata.EJBMetaData
                                |
                                +--jrun.ejb.metadata.ClientInvokableMetaData
                                      |
                                      +--jrun.ejb.metadata.EntityMetaData

All Implemented Interfaces:

Constants

public class EntityMetaData

extends ClientInvokableMetaData

implements Constants

Author:

Enrique Duvos, Paul Reilly

Inner classes inherited from class jrunx.xml.XMLMetaData

XMLMetaData.BaseException, XMLMetaData.CouldNotCreateDocumentException, XMLMetaData.CreateInstanceException, XMLMetaData.ElementRequiredException, XMLMetaData.IntegerExpectedException, XMLMetaData.InvalidElementException, XMLMetaData.InvalidObjectException, XMLMetaData.MetaDataExportIOException, XMLMetaData.NoLocationException, XMLMetaData.NoStringConstructorException, XMLMetaData.UnsupportedArrayTypeException

Field Summary

static java.lang.String	BEAN
static java.lang.String	CMP_1_VERSION
static java.lang.String	CMP_2_VERSION
static java.lang.String	COMMIT_OPTION_A
static java.lang.String	COMMIT_OPTION_B
static java.lang.String	COMMIT_OPTION_C
static java.lang.String	CONTAINER

Fields inherited from class jrun.j2ee.metadata.J2EEMetaData

FALSE, TRUE

Fields inherited from class jrunx.xml.XMLMetaData

logger

Fields inherited from interface jrunx.persistence.Constants

CMP20_STORE_MANAGER, CREATE_SQL, CREATE_TABLE_SQL, DEFAULT_CACHE_SIZE, DELETE_TABLE_SQL, FILE_NAME, FILE_STORE, FIND_BY_PRIMARY_KEY_SQL, JDBC_STORE, LOAD_SQL, REMOVE_SQL, STORE_SQL, TEMP_DIRECTORY

Constructor Summary

EntityMetaData()

Method Summary

void	addCMPField(CMPFieldMetaData cmpFieldMetaData)
void	addQuery(QueryMetaData queryMetaData)
void	addRelationship(EJBRelationMetaData ejbRelationMetaData)
protected QueryMetaData	createRelatedQueryMetaData(java.lang.String ejbName, CMRFieldMetaData cmrFieldMetaData, java.lang.String multiplicity)
java.lang.String	getAbstractSchemaName()
CMPFieldMetaData	getCMPField(java.lang.String fieldName)
java.util.List	getCMPFieldList()
java.util.Iterator	getCMPFields()
java.lang.String	getCMPVersion()
java.util.List	getCmrFieldRoles()
java.util.Map	getCmrFields()
java.lang.String	getCommitOption()
java.lang.String	getDefaultDataSource()
java.util.List	getEjbJarCmp20Beans() Get all CMP2.0 beans declared on the same ejb-jar.xml.
EjbQLDriver	getEjbqlDriver()
java.util.Iterator	getForeignKeyFields()
java.util.Map	getParsedEJBQLQueries()
java.lang.String	getPersistenceType()
java.lang.Class	getPrimaryKeyClass()
CMPFieldMetaData	getPrimaryKeyField(java.lang.String name)
java.util.Iterator	getPrimaryKeyFields()
java.lang.String	getPrimKeyClass()
java.lang.String	getPrimKeyField()
java.util.Iterator	getQueries()
QueryMetaData	getQuery(java.lang.String queryMethodName)
java.util.Set	getRelationships() Get all relationships in this ejb-jar.
StoreManagerMetaData	getStoreMetaData()
java.lang.String	getUnknownPrimaryKeyFieldName()
boolean	hasRelationships()
void	init()
void	initBeanClass()
void	initCMPFields()
void	initCMRFields()
void	initEJBQLQueries()
void	initQueries()
void	initQueryMethodMetaData(QueryMethodMetaData methodMetaData)
void	initRelationships()
boolean	isAlwaysDirty()
boolean	isBeanManaged()
boolean	isCMP11() return true if this is an EJB2.0 CMP Entitybean
boolean	isCMP20() return true if this is an EJB2.0 CMP Entitybean
boolean	isCMPField(java.lang.String cmpFieldName)
boolean	isContainerManaged()
boolean	isEntity()
boolean	isMessageDriven()
boolean	isPrimaryKeyClassUnknown() return true if the primary ey clas is java.lang.Object
boolean	isReentrant()
boolean	isSession()
void	setAbstractSchemaName(java.lang.String abstractSchemaName)
void	setAlwaysDirty(boolean isAlwaysDirty)
void	setCMPVersion(java.lang.String cmpVersion)
void	setCommitOption(java.lang.String commitOption)
void	setEJBQLDriver(EjbQLDriver ejbqlDriver)
void	setJDBCMappingsMetaData(JDBCMappingsMetaData jdbcMappingsMetaData)
void	setPersistenceType(java.lang.String persistenceType)
void	setPrimKeyClass(java.lang.String primKeyClass)
void	setPrimKeyField(java.lang.String primkeyField)
void	setReentrant(boolean reentrant)

Methods inherited from class jrun.ejb.metadata.ClientInvokableMetaData

getEjbIORDescriptors, getHome, getLocal, getLocalHome, getRemote, getSecurityRoleRefs, isLocalInterfacesSupported, isMultiplexing, isRemoteInterfacesSupported, setEjbIORDescriptors, setHome, setLocal, setLocalHome, setMultiplexing, setRemote

Methods inherited from class jrun.ejb.metadata.EJBMetaData

addExcludeMethod, addMethodPermission, addMethodTransaction, getBeanClass, getEJBClass, getEJBJarMetaData, getEJBName, getJNDIName, getMethodPermissions, getMethodTransactionType, getPermissionMethods, getSecurityIdentityMetaData, getTransactionMethods, getTXDomainName, isClusterHome, isClusterObject, isMethodExcluded, setBeanClass, setClusterHome, setClusterObject, setEJBClass, setEJBJarMetaData, setEJBName, setJNDIName, setSecurityIdentityMetaData, setTXDomainName

Methods inherited from class jrun.j2ee.metadata.ServerJ2EEMetaData

addEJBLocalRef, clearEJBLocalRefs, getEJBLocalRefByName, getEJBLocalRefs, removeEJBLocalRef

Methods inherited from class jrun.j2ee.metadata.J2EEMetaData

addEJBRef, addEnvEntry, addResourceEnvRef, addResourceRef, clearEJBRefs, clearEnvEntries, clearResourceEnvRefs, clearResourceRefs, getDisplayName, getEJBRefByName, getEJBRefs, getEnvEntries, getEnvEntryByName, getIconMetaData, getJRunMetaData, getResourceEnvRefByName, getResourceEnvRefs, getResourceRefByName, getResourceRefs, removeEJBRef, removeEnvEntry, removeResourceEnvRef, removeResourceRef, setDisplayName, setIconMetaData, setJRunMetaData

Methods inherited from class jrun.j2ee.metadata.DescriptionMetaData

getDescription, setDescription

Methods inherited from class jrunx.xml.XMLMetaData

addAcronym, addAcronyms, addPackagePrefix, addPackagePrefixes, exportDocument, getAttribute, getMetaDataSource, getParent, getPersistenceContext, getText, importXML, importXML, remove, removeAttribute, setAttribute, setMetaDataSource, setMetaDataSource, setParent, setParent, setPersistenceContext, setPublicID, setSystemID, setText, sync, sync, toString

Methods inherited from class java.lang.Object

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

Field Detail

COMMIT_OPTION_A

public static final java.lang.String COMMIT_OPTION_A

COMMIT_OPTION_B

public static final java.lang.String COMMIT_OPTION_B

COMMIT_OPTION_C

public static final java.lang.String COMMIT_OPTION_C

CMP_2_VERSION

public static final java.lang.String CMP_2_VERSION

CMP_1_VERSION

public static final java.lang.String CMP_1_VERSION

BEAN

public static final java.lang.String BEAN

CONTAINER

public static final java.lang.String CONTAINER

Constructor Detail

EntityMetaData

public EntityMetaData()

Method Detail

addCMPField

public void addCMPField(CMPFieldMetaData cmpFieldMetaData)

addQuery

public void addQuery(QueryMetaData queryMetaData)

addRelationship

public void addRelationship(EJBRelationMetaData ejbRelationMetaData)

createRelatedQueryMetaData

protected QueryMetaData createRelatedQueryMetaData(java.lang.String ejbName,
                                                   CMRFieldMetaData cmrFieldMetaData,
                                                   java.lang.String multiplicity)
                                            throws DeploymentException

getAbstractSchemaName

public java.lang.String getAbstractSchemaName()

getUnknownPrimaryKeyFieldName

public java.lang.String getUnknownPrimaryKeyFieldName()

getCMPField

public CMPFieldMetaData getCMPField(java.lang.String fieldName)

getCMPFields

public java.util.Iterator getCMPFields()

getCMPFieldList

public java.util.List getCMPFieldList()

getCMPVersion

public java.lang.String getCMPVersion()

getCmrFields

public java.util.Map getCmrFields()

getCmrFieldRoles

public java.util.List getCmrFieldRoles()

getCommitOption

public java.lang.String getCommitOption()

getDefaultDataSource

public java.lang.String getDefaultDataSource()

getForeignKeyFields

public java.util.Iterator getForeignKeyFields()

getParsedEJBQLQueries

public java.util.Map getParsedEJBQLQueries()

getPersistenceType

public java.lang.String getPersistenceType()

getPrimKeyClass

public java.lang.String getPrimKeyClass()

getPrimKeyField

public java.lang.String getPrimKeyField()

getPrimaryKeyClass

public java.lang.Class getPrimaryKeyClass()
                                   throws DeploymentException

getPrimaryKeyField

public CMPFieldMetaData getPrimaryKeyField(java.lang.String name)

getPrimaryKeyFields

public java.util.Iterator getPrimaryKeyFields()

getQueries

public java.util.Iterator getQueries()

getQuery

public QueryMetaData getQuery(java.lang.String queryMethodName)

getRelationships

public java.util.Set getRelationships()

Get all relationships in this ejb-jar.

Returns:

a Set of EJBRelationMetaData objects.

getEjbJarCmp20Beans

public java.util.List getEjbJarCmp20Beans()

Get all CMP2.0 beans declared on the same ejb-jar.xml.

Returns:

a Set of EntityMetaData objects.

getStoreMetaData

public StoreManagerMetaData getStoreMetaData()

hasRelationships

public boolean hasRelationships()

init

public void init()
          throws DeploymentException

Overrides:

init in class ClientInvokableMetaData

initBeanClass

public void initBeanClass()
                   throws DeploymentException

Overrides:

initBeanClass in class EJBMetaData

initCMPFields

public void initCMPFields()
                   throws java.lang.Exception

initCMRFields

public void initCMRFields()
                   throws java.lang.Exception

initQueries

public void initQueries()
                 throws java.lang.Exception

initQueryMethodMetaData

public void initQueryMethodMetaData(QueryMethodMetaData methodMetaData)
                             throws DeploymentException

initRelationships

public void initRelationships()
                       throws DeploymentException

isAlwaysDirty

public boolean isAlwaysDirty()

isBeanManaged

public boolean isBeanManaged()

isCMPField

public boolean isCMPField(java.lang.String cmpFieldName)

isPrimaryKeyClassUnknown

public boolean isPrimaryKeyClassUnknown()

return true if the primary ey clas is java.lang.Object

isCMP20

public boolean isCMP20()

return true if this is an EJB2.0 CMP Entitybean

isCMP11

public boolean isCMP11()

return true if this is an EJB2.0 CMP Entitybean

isContainerManaged

public boolean isContainerManaged()

isEntity

public boolean isEntity()

Overrides:

isEntity in class EJBMetaData

isMessageDriven

public boolean isMessageDriven()

Overrides:

isMessageDriven in class EJBMetaData

isSession

public boolean isSession()

Overrides:

isSession in class EJBMetaData

isReentrant

public boolean isReentrant()

setAlwaysDirty

public void setAlwaysDirty(boolean isAlwaysDirty)

setEJBQLDriver

public void setEJBQLDriver(EjbQLDriver ejbqlDriver)

setAbstractSchemaName

public void setAbstractSchemaName(java.lang.String abstractSchemaName)

setCMPVersion

public void setCMPVersion(java.lang.String cmpVersion)

setCommitOption

public void setCommitOption(java.lang.String commitOption)

setJDBCMappingsMetaData

public void setJDBCMappingsMetaData(JDBCMappingsMetaData jdbcMappingsMetaData)

setPersistenceType

public void setPersistenceType(java.lang.String persistenceType)

setPrimKeyClass

public void setPrimKeyClass(java.lang.String primKeyClass)

setPrimKeyField

public void setPrimKeyField(java.lang.String primkeyField)

setReentrant

public void setReentrant(boolean reentrant)

getEjbqlDriver

public EjbQLDriver getEjbqlDriver()

initEJBQLQueries

public void initEJBQLQueries()
                      throws DeploymentException