Oracle Application Server TopLink API Reference
10g Release 2 (10.1.2)

B15903-01


oracle.toplink.tools.ejb11
Class EJBXmlEntityBeanDefinition

java.lang.Object
  extended byoracle.toplink.tools.ejb11.EJBXmlBeanDefinition
      extended byoracle.toplink.tools.ejb11.EJBXmlEntityBeanDefinition


public class EJBXmlEntityBeanDefinition
extends EJBXmlBeanDefinition

This type defines the entity fields used by the EJB XML deployment descriptor.


Field Summary
java.util.Vector cmpFields
java.lang.String persistenceType
java.lang.Class primKeyClass
java.lang.String primKeyField
boolean reentrant

Fields inherited from class oracle.toplink.tools.ejb11.EJBXmlBeanDefinition
BEAN, CONTAINER, ejbClass, ejbName, FALSE, home, MANDATORY, NEVER, NOT_SUPPORTED, remote, REQUIRED, REQUIRES_NEW, SUPPORTS, transAttribute, TRUE

Constructor Summary
EJBXmlEntityBeanDefinition(java.lang.String beanName)
EJBXmlEntityBeanDefinition constructor

Method Summary
java.util.Vector getCmpFields()
Return the fields that are container managed.
java.lang.String getPersistenceType()
Get the persistence type that specifies BMP or CMP.
java.lang.Class getPrimKeyClass()
Get the primary key class.
java.lang.String getPrimKeyField()
Get the primary key field.
boolean getReentrant()
Get the re-entrancy flag.
void initializeToDefaults()
Initialize this object to contain the default values.
void setCmpFields(java.util.Vector fields)
Set the fields that are container managed.
void setPersistenceType(java.lang.String type)
Set the persistence type that specifies BMP or CMP.
void setPrimKeyClass(java.lang.Class priKeyCls)
Set the class of the primary key.
void setPrimKeyField(java.lang.String fieldName)
Set the primary key field.
void setReentrant(boolean reentrantFlag)
Set the re-entrancy flag.
org.w3c.dom.Element storeBeanProperties(org.w3c.dom.Element parentElement, org.w3c.dom.Document xmlDoc)
Store the properties in the element passed in and using the XML document.

Methods inherited from class oracle.toplink.tools.ejb11.EJBXmlBeanDefinition
getEjbClass, getEjbName, getHomeClass, getRemoteClass, getTransAttribute, setEjbClass, setEjbName, setHomeClass, setRemoteClass, setTransAttribute, storeAssemblyProperties

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

persistenceType

public java.lang.String persistenceType

primKeyClass

public java.lang.Class primKeyClass

primKeyField

public java.lang.String primKeyField

reentrant

public boolean reentrant

cmpFields

public java.util.Vector cmpFields

Constructor Detail

EJBXmlEntityBeanDefinition

public EJBXmlEntityBeanDefinition(java.lang.String beanName)
EJBXmlEntityBeanDefinition constructor

Method Detail

getCmpFields

public java.util.Vector getCmpFields()
Return the fields that are container managed. This applies to entity beans only.
Returns:
Vector The collection of Strings that are the field names

getPersistenceType

public java.lang.String getPersistenceType()
Get the persistence type that specifies BMP or CMP. This applies to entity beans only.
Returns:
String Can return either BEAN or CONTAINER

getPrimKeyClass

public java.lang.Class getPrimKeyClass()
Get the primary key class. This applies to entity beans only.
Returns:
Class The primary key Class

getPrimKeyField

public java.lang.String getPrimKeyField()
Get the primary key field. This applies to entity beans only.
Returns:
String The name of the primary key attribute when the prikey is not a compound one

getReentrant

public boolean getReentrant()
Get the re-entrancy flag. This applies to entity beans only.
Returns:
boolean True if the entity bean methods are reentrant

initializeToDefaults

public void initializeToDefaults()
Initialize this object to contain the default values.
Overrides:
initializeToDefaults in class EJBXmlBeanDefinition

setCmpFields

public void setCmpFields(java.util.Vector fields)
Set the fields that are container managed. This applies to entity beans only.
Parameters:
fields - The collection of Strings that are the field names

setPersistenceType

public void setPersistenceType(java.lang.String type)
Set the persistence type that specifies BMP or CMP. This applies to entity beans only.
Parameters:
type - Can be set to either BEAN or CONTAINER

setPrimKeyClass

public void setPrimKeyClass(java.lang.Class priKeyCls)
Set the class of the primary key. This applies to entity beans only.
Parameters:
priKeyCls - The primary key Class

setPrimKeyField

public void setPrimKeyField(java.lang.String fieldName)
Set the primary key field. This applies to entity beans only.

setReentrant

public void setReentrant(boolean reentrantFlag)
Set the re-entrancy flag. This applies to entity beans only.
Parameters:
reentrantFlag - True if the entity bean methods are reentrant

storeBeanProperties

public org.w3c.dom.Element storeBeanProperties(org.w3c.dom.Element parentElement,
                                               org.w3c.dom.Document xmlDoc)
Store the properties in the element passed in and using the XML document.
Overrides:
storeBeanProperties in class EJBXmlBeanDefinition
Returns:
Element The parent element

Copyright © 1998, 2005 Oracle Corporation. All Rights Reserved.