oracle.toplink.tools.ejbjar
Class Entity

java.lang.Object
  |
  +--oracle.toplink.tools.ejbjar.DomObject
        |
        +--oracle.toplink.tools.ejbjar.Description
              |
              +--oracle.toplink.tools.ejbjar.EnterpriseObject
                    |
                    +--oracle.toplink.tools.ejbjar.Entity

All Implemented Interfaces:

EjbJarConstants

public class Entity

extends EnterpriseObject

Entity object that stores all deployment descriptor info pertaining to a particular entity bean.

Field Summary

Fields inherited from interface oracle.toplink.tools.ejbjar.EjbJarConstants

ABSTRACT_SCHEMA_NAME, ACKNOWLEDGE_MODE, APPLICATION_AUTH, ASSEMBLY_DESCRIPTOR, AUTO_ACKNOWLEDGE, BEAN_MANAGED, BOOLEAN_TYPE, BYTE_TYPE, CASCADE_DELETE, CMP_FIELD, CMP_VERSION, CMP_VERSION_1, CMP_VERSION_2, CMR_FIELD, CMR_FIELD_NAME, CMR_FIELD_TYPE, COLLECTION_TYPE, CONTAINER_AUTH, CONTAINER_MANAGED, CONTAINER_TRANSACTION, DESCRIPTION, DESTINATION_TYPE, DISPLAY_NAME, DOUBLE_TYPE, DUPS_OK_ACKNOWLEDGE, DURABLE, EJB_CLASS, EJB_CLIENT_JAR, EJB_JAR, EJB_LINK, EJB_LOCAL_REF, EJB_NAME, EJB_QL, EJB_REF, EJB_REF_NAME, EJB_REF_TYPE, EJB_RELATION, EJB_RELATION_NAME, EJB_RELATIONSHIP_ROLE, EJB_RELATIONSHIP_ROLE_NAME, ENTERPRISE_BEANS, ENTITY, ENTITY_REF_TYPE, ENV_ENTRY, ENV_ENTRY_NAME, ENV_ENTRY_TYPE, ENV_ENTRY_VALUE, EXCLUDE_LIST, FALSE_VALUE, FIELD_NAME, FLOAT_TYPE, HOME, INTEGER_TYPE, LARGE_ICON, LOCAL, LOCAL_HOME, LONG_TYPE, MANDATORY, MESSAGE_DRIVEN, MESSAGE_DRIVEN_DESTINATION, MESSAGE_SELECTOR, METHOD, METHOD_INTF, METHOD_NAME, METHOD_PARAM, METHOD_PARAMS, METHOD_PERMISSION, MULTIPLICITY, MULTIPLICITY_MANY, MULTIPLICITY_ONE, NEVER, NONDURABLE, NOT_SUPPORTED, PERSISTENCE_TYPE, PRIM_KEY_CLASS, PRIMKEY_FIELD, QUERY, QUERY_METHOD, QUEUE_TYPE, REENTRANT, RELATIONSHIP_ROLE_SOURCE, RELATIONSHIPS, REMOTE, REQUIRED, REQUIRES_NEW, RES_AUTH, RES_REF_NAME, RES_SHARING_SCOPE, RES_TYPE, RESOURCE_ENV_REF, RESOURCE_ENV_REF_NAME, RESOURCE_ENV_REF_TYPE, RESOURCE_REF, RESULT_TYPE_MAPPING, ROLE_LINK, ROLE_NAME, RUN_AS, SECURITY_IDENTITY, SECURITY_ROLE, SECURITY_ROLE_REF, SESSION, SESSION_REF_TYPE, SESSION_TYPE, SET_TYPE, SHAREABLE_SCOPE, SHORT_TYPE, SMALL_ICON, STATEFUL_TYPE, STATELESS_TYPE, STRING_TYPE, SUBSCRIPTION_DURABILITY, SUPPORTS, TOPIC_TYPE, TRANS_ATTRIBUTE, TRANSACTION_TYPE, TRUE_VALUE, UNCHECKED, UNSHAREABLE_SCOPE, USE_CALLER_IDENTITY

Constructor Summary

Entity()

Method Summary

void	addCmpField(java.lang.String cmpFieldName)
void	addQuery(Query query)
java.lang.String	getAbstractSchemaName()
CmpField	getCmpFieldNamed(java.lang.String name)
java.util.Vector	getCmpFields()
java.lang.String	getCmpVersion()
java.lang.String	getHome() Left for legacy reasons, it is superceded with getRemoteHome()
java.lang.String	getLocal()
java.lang.String	getLocalHome()
java.lang.String	getPersistenceType()
java.lang.String	getPrimaryKeyClass()
java.lang.String	getPrimaryKeyField()
java.util.Vector	getQueries()
boolean	getReentrant()
java.lang.String	getRemote()
java.lang.String	getRemoteHome() Preferred way of getting Remote home.
java.util.Vector	getSecurityRoleReferences()
boolean	isEntity() Return true if this is an entity object, false if not.
void	loadFromElement(org.w3c.dom.Element e) Load the data for this instance from the specified element.
void	setAbstractSchemaName(java.lang.String abstractName)
void	setCmpFields(java.util.Vector cmpFlds)
void	setCmpVersion(java.lang.String cmpVer)
void	setHome(java.lang.String h) Left for legacy reasons, it is superceeded with setRemoteHome()
void	setLocal(java.lang.String newLocal)
void	setLocalHome(java.lang.String newLocalHome)
void	setPersistenceType(java.lang.String pType)
void	setPrimaryKeyClass(java.lang.String primKeyCls)
void	setPrimaryKeyField(java.lang.String primKeyField)
void	setQueries(java.util.Vector q)
void	setReentrant(boolean flag)
void	setRemote(java.lang.String rem)
void	setRemoteHome(java.lang.String remoteHome) Just a helper method, preferred way of setting Remote home.
void	setSecurityRoleReferences(java.util.Vector securityRoleRefs)
org.w3c.dom.Element	toElement(org.w3c.dom.Document doc) Return the data from this instance as a DOM element.

Methods inherited from class oracle.toplink.tools.ejbjar.EnterpriseObject

getDisplayName, getEjbClass, getEjbLocalReferences, getEjbName, getEjbReferences, getEnvEntries, getLargeIcon, getResourceEnvReferences, getResourceReferences, getSecurityIdentity, getSmallIcon, inheritedFields, isMessageDriven, isSession, setDisplayName, setEjbClass, setEjbLocalReferences, setEjbName, setEjbReferences, setEnvEntries, setLargeIcon, setResourceReferences, setSecurityIdentity, setSmallIcon

Methods inherited from class oracle.toplink.tools.ejbjar.Description

getDescription, setDescription

Methods inherited from class oracle.toplink.tools.ejbjar.DomObject

trace

Methods inherited from class java.lang.Object

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

Constructor Detail

Entity

public Entity()

Method Detail

addCmpField

public void addCmpField(java.lang.String cmpFieldName)

addQuery

public void addQuery(Query query)

getAbstractSchemaName

public java.lang.String getAbstractSchemaName()

getCmpFieldNamed

public CmpField getCmpFieldNamed(java.lang.String name)

getCmpFields

public java.util.Vector getCmpFields()

getCmpVersion

public java.lang.String getCmpVersion()

getHome

public java.lang.String getHome()

Left for legacy reasons, it is superceded with getRemoteHome()

getLocalHome

public java.lang.String getLocalHome()

getLocal

public java.lang.String getLocal()

getPersistenceType

public java.lang.String getPersistenceType()

getPrimaryKeyClass

public java.lang.String getPrimaryKeyClass()

getPrimaryKeyField

public java.lang.String getPrimaryKeyField()

getQueries

public java.util.Vector getQueries()

getReentrant

public boolean getReentrant()

getRemote

public java.lang.String getRemote()

getRemoteHome

public java.lang.String getRemoteHome()

Preferred way of getting Remote home.

setRemoteHome

public void setRemoteHome(java.lang.String remoteHome)

Just a helper method, preferred way of setting Remote home.

getSecurityRoleReferences

public java.util.Vector getSecurityRoleReferences()

isEntity

public boolean isEntity()

Description copied from class: EnterpriseObject

Return true if this is an entity object, false if not.

Overrides:

isEntity in class EnterpriseObject

setAbstractSchemaName

public void setAbstractSchemaName(java.lang.String abstractName)

Parameters:

abstractName - the abstract schema name String

setCmpFields

public void setCmpFields(java.util.Vector cmpFlds)

Parameters:

cmpFlds - the collection of CmpField

setCmpVersion

public void setCmpVersion(java.lang.String cmpVer)

Parameters:

cmpVer - the cmp version String

setHome

public void setHome(java.lang.String h)

Left for legacy reasons, it is superceeded with setRemoteHome()

Parameters:

h - the home String

setLocal

public void setLocal(java.lang.String newLocal)

setLocalHome

public void setLocalHome(java.lang.String newLocalHome)

setPersistenceType

public void setPersistenceType(java.lang.String pType)

Parameters:

pType - the persistence type String

setPrimaryKeyClass

public void setPrimaryKeyClass(java.lang.String primKeyCls)

Parameters:

primKeyCls - the primary key class String

setPrimaryKeyField

public void setPrimaryKeyField(java.lang.String primKeyField)

Parameters:

primKeyField - the primary key field String

setQueries

public void setQueries(java.util.Vector q)

Parameters:

q - the collection of Query

setReentrant

public void setReentrant(boolean flag)

Parameters:

flag - true if reentrant, false if not

setRemote

public void setRemote(java.lang.String rem)

Parameters:

rem - the remote String

setSecurityRoleReferences

public void setSecurityRoleReferences(java.util.Vector securityRoleRefs)

Parameters:

securityRoleRefs - the collection of SecurityRoleReference

loadFromElement

public void loadFromElement(org.w3c.dom.Element e)

Load the data for this instance from the specified element.

Overrides:

loadFromElement in class EnterpriseObject

Parameters:

e - the DOM element

toElement

public org.w3c.dom.Element toElement(org.w3c.dom.Document doc)

Return the data from this instance as a DOM element.

Specified by:

toElement in class EnterpriseObject

Parameters:

doc - a Document instance used to create elements