Using the Wizard to Create an Entity EJB

Using the Wizard to Create an Entity Bean

The Entity Bean Wizard consists of several pages:

EJB Type Page
Database Table Page (CMP only)
Persistent Fields (CMP only)
Existing Bean and/or Primary Key Java Class (CMP only)
Components Page

EJB Type Page

Allows you to select the type of persistent storage your Entity EJB will use:

Bean Managed Persistence - This type of persistent storage is defined in your code. For example, JDBC calls to your database.
When you select the Bean Managed Persistence storage type, the EJB wizard proceeds to the Components Page where you can specify the EJB components.
Container Managed Persistence - This type of persistent storage is managed by your EJB application server. When you select this option, the EJB wizard displays the Container Managed Persistence Mapping options as follows:
- Select Database Table - select this option if you have a database defined and you want to have the wizard set up the persistent fields for the EJB you are creating based on the fields of the database.
  When you select this option, the wizard proceeds to the Database Table Page.
- Specify Persistent Fields - select this option if you want to specify the persistent fields for your EJB yourself. You may want to select this option if you don't have access to the database or you haven't created it yet.
  When you select this option, the wizard proceeds to the Persistent Fields Page.
- Select Existing Bean and/or Primary Key Java Class - select this option if you have an existing JavaBean, or primary key class, or both; and you want to use them as the model for the EJB you are creating.
  When you select this option, the wizard proceeds to the Existing Bean and/or Primary Key Page.
- No Mapping information at this time - select this option if you are not ready to define the EJB fields and primary key.
  When you select this option, the wizard proceeds to the Components Page.

Database Table Page

This page appears when you are creating a CMP EJB and you want the wizard to create the persistent fields for the EJB based on the fields of a table in an existing database. When you select this option, the EJB wizard displays the following page:

Select Database Table from Database Schema Object - If you have a database schema object defined for your database, navigate to it in the Explorer list and double-click to select it. You are then prompted to identify the fields to create in your EJB.
Note: you must have a schema defined in order to use this option. To define a schema, select Capture Database Schema from the Forte Tools menu.

Persistent Fields

This page appears when you are creating a CMP EJB and you have EJB persistent fields that map to fields in your database. You can identify multiple fields, but you cannot continue to the next page of the wizard until you designate a primary key field.

If you do not have a primary key defined in your database table, you will need to go back to the database schema and define a primary key so you can use this EJB wizard page.

To add a new field to the list:

Select Add.
In the Add Persistent Field dialog box, enter the name of the field and the data type for the field.
Press Enter or select OK to create the new field.

To edit a field in the list:

Select the field.
Select edit.
In the Edit Persistent Field dialog box, edit the fields as desired.
Press Enter or select OK to save your changes.

To delete a field:

Select the field.
Select the Remove button.

Existing Bean and/or Primary Key Java Class

This appears when you are creating a CMP and you have an existing JavaBean, or primary key class, or both; and you want to use them as the model for the EJB you are creating.

To use an existing bean class:

Select the Select Class... button.
Navigate to the desired bean class.
Optionally, select the Use Existing Bean Class checkbox to use this bean class in the creation of your EJB.

To use an existing primary key class:

Select the Select Class... button.
Navigate to the desired primary key class.
Optionally, select the Use Existing Primary Key Class checkbox to use this primary key class in the creation of your EJB.

You will not be able to proceed to the next page of the wizard if you don't have at least one checkbox selected.

Components Page

This page appears when you are creating a Bean Managed Persistence or you are creating a CMP bean with the No Mapping Information at this time option. You are prompted to identify the following fields:

Name Enter a name for the EJB. If you haven't set any of the related objects yet, you will see the default names change to match this one. The default names are based on the recommended default names in the J2EE specification available from the web page at http://java.sun.com/j2ee/.

Package Select the Browse button to choose the package that will contain the EJB.

Related Objects This section of the dialog box shows the standard components of an entity EJB that are automatically setup for you. If you want to specify any of these components yourself, select the Modify button next to the component. You will be able to enter your changes in the Modify Component dialog box.

Bean Class

javax.ejb.EntityBean

If the bean manages its own persistence, this class also contains the definitions for the ejbFindByPrimaryKey method for the bean and any finder methods specified in the home interface.

Remote Interface This interface inherits from javax.ejb.EJBObject and provides signatures for your business methods.

Home Interface This interface inherits from javax.ejb.EJBHome and provides signatures for your create methods, finder methods, and your findByPrimaryKey method.

Primary Key Class This class is the data type of the primary key to be used as a parameter to the findByPrimaryKey method defined in the Home interface.

See also
	Creating an EJB About Entity Beans

Legal Notices