All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class javax.ejb.deployment.EntityDescriptor 

java.lang.Object
   |
   +----javax.ejb.deployment.DeploymentDescriptor
           |
           +----javax.ejb.deployment.EntityDescriptor
public class EntityDescriptor
extends DeploymentDescriptor
The EntityDescriptor class defines the deployment descriptor for an entity enterprise Bean.

A serialized instance of the EntityDescriptor class is used as the standard format for passing the entity enterprise Bean's declarative deployment attributes in the ejb-jar file.

The Bean provider tools use the setter functions to initialize an instance of the deployment descriptor. The Bean provider tools then serialize the instance into the ejb-jar file.

The getter functions are used by the container tools at deployment time. The tools deserialize the instance from the ejb-jar file, and use the getter functions to obtain information about the enterprise Bean.

Note that the Enterprise JavaBeans architecture does not prescribe whether the actual deployment descriptor class is used by the container at runtime. Therefore, the container is allowed to import the information from the deployment descriptor at deployment time, and store the information in a container-specific format. The container is however required to enforce the declarative attributes at runtime, as specified by the Enterprise JavaBeans specification.

After an enterprise Bean has been installed into a container, the container tools can be then used to view and change the values of the deployment attributes. As changing the values of the deployment descriptor attributes may alter the semantics of a deployed application, the container may restrict changes to certain attributes.

The methods of the EntityDescriptor class conform to the JavaBeans property design pattern.

Constructor Index

o EntityDescriptor()
Create an instance of EntityDescriptor.

Method Index

o getContainerManagedFields()
Get the array of the container-managed fields.
o getContainerManagedFields(int)
Get the name of field at the given index in the array of container-managed fields.
o getPrimaryKeyClassName()
Get the full class name of the enterprise Bean's primary key.
o setContainerManagedFields(Field[])
Set the array of the names of the container-managed fields.
o setContainerManagedFields(int, Field)
Set the field at the given index in the array of container-managed fields.
o setPrimaryKeyClassName(String)
Set the full class name of the enterprise Bean's primary key.

Constructors

o EntityDescriptor 
 public EntityDescriptor()
Create an instance of EntityDescriptor.

Methods

o getPrimaryKeyClassName 
 public String getPrimaryKeyClassName()
Get the full class name of the enterprise Bean's primary key.

Returns:
The primary key class name.
o setPrimaryKeyClassName 
 public void setPrimaryKeyClassName(String value)
Set the full class name of the enterprise Bean's primary key.

Returns:
The primary key class name.
o getContainerManagedFields 
 public Field[] getContainerManagedFields()
Get the array of the container-managed fields.

Returns:
The array of the container-managed fields.
o setContainerManagedFields 
 public void setContainerManagedFields(Field values[])
Set the array of the names of the container-managed fields.

Parameters:
value - The array of the names of the container-managed fields.
o getContainerManagedFields 
 public Field getContainerManagedFields(int index)
Get the name of field at the given index in the array of container-managed fields.

Parameters:
index - The index in the array.
Returns:
The container-managed field at the specified index.
o setContainerManagedFields 
 public void setContainerManagedFields(int index,
                                       Field value)
Set the field at the given index in the array of container-managed fields.

Parameters:
index - The index in the array.
value - The container-managed field to be set at the index. 
All Packages  Class Hierarchy  This Package  Previous  Next  Index