Home > Articles > Web Services > XML

XDoclet: Entity Bean Relationships

Entity bean relationships are some of the most difficult parts of developing an EJB application, but help is on the way. Marcus Zarra tells you how the popular XDoclet tool can help define different relationship possibilities.
Like this article? We recommend

Auto-loading of children is one of the great timesavers in an EJB application. Knowing that when you load an entity all the children associated with it are also already populated makes developing an EJB application a lot more pleasurable than if it were missing this feature. Having said that, setting up relationships so that they load properly can be extremely difficult, especially given the diverse landscape of application servers that exist today. Fortunately, XDoclet makes this task somewhat less painful. However, even with XDoclet it is not a trivial matter.

I have found that if I approach a new EJB application with a to-do list, the initial creation of the EJBs, although tedious, becomes less painful. Generally, when the database is already designed and/or exists, I approach the application in the following order:

  1. Identify and code the entity objects.
  2. Test the entity objects to ensure that they load properly.
  3. Test the entity objects to ensure that they save properly.
  4. Identify and code the relationships between the objects.
  5. Test the entity relationships to ensure that they load properly.
  6. Test the entity relationships to ensure that they save properly.

It is quite common to see these six steps rolled up into one step, and that leads to difficulty and confusion. Invariably it becomes a chicken-and-egg situation. An entity object cannot be tested because it has dependencies on other entities that are not created yet and so forth. To avoid this situation, it is best to create each entity as its own separate object first and then tackle the job of associating the entities to each other.

Once the entities are defined, the job of associating them together becomes that much simpler. Detailed below are the most common types of relationships used in a normal enterprise application. For each of these types of relationships I have detailed how to define the relationship using XDoclet.

For each of these examples, I use two example entities. Although the relationship methods vary depending on the relationship involved, the rest of the objects remain the same. To make things clear most of the time, I will be using the following two objects.

First, the parent object used for these examples:

package com.dzrealms.example.entity;

import javax.ejb.EntityBean;
import javax.ejb.EntityContext;
import javax.ejb.RemoveException;
import javax.ejb.CreateException;
import javax.ejb.FinderException;
import java.util.Set;
import java.util.Collection;

/**
 * @ejb.bean name="ExampleBean"
 *   jndi-name="example/remote/ExampleBean"
 *   local-jndi-name="example/local/ExampleBean"
 *   cmp-version="2.x"
 *   primkey-field="ID"
 *   schema="Example"
 *
 * @ejb.persistence table-name="example"
 *
 * @ejb.interface remote-class="com.dzrealms.example.entity.ExampleRemote"
 *    local-class="com.dzrealms.example.entity.ExampleLocal"
 *
 * @ejb.home remote-class="com.dzrealms.example.entity.ExampleHomeRemote"
 *   local-class="com.dzrealms.example.entity.ExampleHomeLocal"
 *
 * @jboss.entity-command name="mysql-get-generated-keys"
 *
 * @jboss.unknown-pk class="java.lang.Integer"
 *     auto-increment="true"
 */
public abstract class ExampleBean implements EntityBean {

 /**
 * @ejb.create-method
 * @return Primary Key
 * @throws CreateException
 */
 public Integer ejbCreate() throws CreateException {
  return null;
 }

 public void ejbPostCreate() {

 }

 /**
 * @ejb.select query="select o.ID from Example o where o.name = ?1"
 * @param s Name we are searching with
 * @return Set of Primary Keys with that name
 * @throws FinderException
 */
 public abstract Set ejbSelectByName(String s) throws FinderException;

 /**
 * @ejb.interface-method
 * @ejb.persistence
 * @return Primary Key
 */
 public abstract Integer getID();

 /**
 * @param i Set the primary key
 */
 public abstract void setID(Integer i);

 /**
 * @ejb.interface-method
 * @ejb.persistence
 * @return the name of this bean
 */
 public abstract String getName();

 /**
 * @param s Set the name of this bean
 */
 public abstract void setName(String s);

 /**
 * @ejb.interface-method
 * @ejb.persistence
 * @return the value of this bean
 */
 public abstract String getValue();

 /**
 * @ejb.interface-method
 * @param s Set the value of this bean
 */
 public abstract void setValue(String s);

 public void setEntityContext(EntityContext context) {}

 public void unsetEntityContext() {}

 public void ejbRemove() throws RemoveException {}

 public void ejbActivate() {}

 public void ejbPassivate() {}

 public void ejbLoad() {}

 public void ejbStore() {}
}

Second, the child object used for these examples:

package com.dzrealms.example.entity;

import javax.ejb.EntityBean;
import javax.ejb.EntityContext;
import javax.ejb.RemoveException;
import javax.ejb.CreateException;

/**
 * @ejb.bean name="ExampleChildBean"
 *   jndi-name="example/remote/ExampleChildBean"
 *   local-jndi-name="example/local/ExampleChildBean"
 *   cmp-version="2.x"
 *   primkey-field="ID"
 *   schema="ExampleChild"
 *
 * @ejb.persistence table-name="exampleChild"
 *
 * @ejb.interface 
 *  remote-class="com.dzrealms.example.entity.ExampleChildRemote"
 *  local-class="com.dzrealms.example.entity.ExampleChildLocal"
 *
 * @ejb.home 
 *  remote-class="com.dzrealms.example.entity.ExampleChildHomeRemote"
 *  local-class="com.dzrealms.example.entity.ExampleChildHomeLocal"
 *
 * @jboss.entity-command name="mysql-get-generated-keys"
 *
 * @jboss.unknown-pk class="java.lang.Integer"
 *     auto-increment="true"
 */
public abstract class ExampleChildBean implements EntityBean {

 /**
 * @ejb.create-method
 * @return Primary Key
 * @throws javax.ejb.CreateException
 */
 public Integer ejbCreate() throws CreateException {
  return null;
 }

 public void ejbPostCreate() {}

 /**
 * @ejb.interface-method
 * @ejb.persistence
 * @return Primary Key
 */
 public abstract Integer getID();

 /**
 * @param i Set the primary key
 */
 public abstract void setID(Integer i);

 /**
 * @ejb.interface-method
 * @ejb.persistence
 * @return the test variable
 */
 public abstract String getTestVariable();

 /**
 * @ejb.interface-method
 * @param s sets the test variable
 */
 public abstract void setTestVariable(String s);

 public void setEntityContext(EntityContext context) {}

 public void unsetEntityContext() {}

 public void ejbRemove() throws RemoveException {}

 public void ejbActivate() {}

 public void ejbPassivate() {}

 public void ejbLoad() {}

 public void ejbStore() {}
}

One to Many

Arguably the most common relationship used, the one-to-many relationship, is also fairly easy to define in XDoclet. In our example, the parent object (ExampleBean) will contain a collection of children (ExampleChildBean). Therefore, the following methods need to be added to the parent with the corresponding XDoclet tags:

 /**
 * @ejb.interface-method
 *
 * @ejb.relation name="Parent-to-Children"
 *    role-name="Parent-has-many-Children"
 *    target-ejb="ExampleChildBean"
 *    target-role-name="Child-has-one-parent"
 *
 * @jboss.relation fk-column="parentID"
 *     related-pk-field="ID"
 *
 * @return
 */
 public abstract Collection getChildren();

 /**
 * @ejb.interface-method
 */
 public abstract void setChildren(Collection c);

Here is a breakdown of the XDoclet tags that explain this relationship:

  • @ejb.interface-method

    This is a standard XDoclet tag that identifies this method as one that is to be included in the local and/or remote interface. Without this tag, XDoclet would not add this method to the interfaces and therefore it could be used only by the bean itself.

  • @ejb.relation name

    This tag sets the name of this relationship. This tag is used both to describe the relationship and to provide a unique reference so that the two sides of the relationship can be paired up during the code-generation phase.

  • @ejb.relation role-name

    This tag defines the name of this side of the relationship. This tag is used to describe this bean's role in the relationship and is used as a reference for XDoclet to determine which methods are associated with what relationship. See @ejb. relation target-role-name below.

  • @ejb.relation target-ejb

    Defines the name of the bean on the other side of the relationship. This tag tells XDoclet where to look for the corresponding relationship methods.

  • @ejb.relation target-role-name

    This is the other bean's role-name. XDoclet uses this tag to match up the two sides of the relationship.

  • @jboss.relation fk-column

    This is the foreign key column name. Note that this is the name of the column itself, not the name of a getter method inside the bean. Because a getter is not required in a relationship, XDoclet refers to the column in the database itself.

  • @jboss.relation related-pk-field

    This is the key column on the other bean that links up with the foreign key column in this bean's table. Note again that it references the column itself, not a getter method inside of the bean.

The child side of this relationship looks quite similar to the parent side. The following methods need to be added to the ExampleChildBean class:

 /**
 * @ejb.interface-method
 *
 * @ejb.relation name="Parent-to-Children"
 *    role-name="Child-has-one-parent"
 *    target-ejb="ExampleBean"
 *    target-role-name="Parent-has-many-Children"
 *    target-multiple="true"
 *
 * @jboss.relation fk-column="parentID"
 *     related-pk-field="ID"
 *
 * @return
 */

 public abstract ExampleLocal getParent();
 /**
 * @ejb.interface-method
 */
 public abstract void setParent(ExampleLocal el);

As you can see, most of the tags are simply the mirror of the tags defined in the parent object. The role-name is naturally changed, as is the target-role-name and the target-ejb tags. The only new tag in the child is @ejb.relation target-multiple. This is a simple true/false tag that tells XDoclet whether or not this is the many side of a one-to-many relationship.

InformIT Promotional Mailings & Special Offers

I would like to receive exclusive offers and hear about products from InformIT and its family of brands. I can unsubscribe at any time.

Overview


Pearson Education, Inc., 221 River Street, Hoboken, New Jersey 07030, (Pearson) presents this site to provide information about products and services that can be purchased through this site.

This privacy notice provides an overview of our commitment to privacy and describes how we collect, protect, use and share personal information collected through this site. Please note that other Pearson websites and online products and services have their own separate privacy policies.

Collection and Use of Information


To conduct business and deliver products and services, Pearson collects and uses personal information in several ways in connection with this site, including:

Questions and Inquiries

For inquiries and questions, we collect the inquiry or question, together with name, contact details (email address, phone number and mailing address) and any other additional information voluntarily submitted to us through a Contact Us form or an email. We use this information to address the inquiry and respond to the question.

Online Store

For orders and purchases placed through our online store on this site, we collect order details, name, institution name and address (if applicable), email address, phone number, shipping and billing addresses, credit/debit card information, shipping options and any instructions. We use this information to complete transactions, fulfill orders, communicate with individuals placing orders or visiting the online store, and for related purposes.

Surveys

Pearson may offer opportunities to provide feedback or participate in surveys, including surveys evaluating Pearson products, services or sites. Participation is voluntary. Pearson collects information requested in the survey questions and uses the information to evaluate, support, maintain and improve products, services or sites, develop new products and services, conduct educational research and for other purposes specified in the survey.

Contests and Drawings

Occasionally, we may sponsor a contest or drawing. Participation is optional. Pearson collects name, contact information and other information specified on the entry form for the contest or drawing to conduct the contest or drawing. Pearson may collect additional personal information from the winners of a contest or drawing in order to award the prize and for tax reporting purposes, as required by law.

Newsletters

If you have elected to receive email newsletters or promotional mailings and special offers but want to unsubscribe, simply email information@informit.com.

Service Announcements

On rare occasions it is necessary to send out a strictly service related announcement. For instance, if our service is temporarily suspended for maintenance we might send users an email. Generally, users may not opt-out of these communications, though they can deactivate their account information. However, these communications are not promotional in nature.

Customer Service

We communicate with users on a regular basis to provide requested services and in regard to issues relating to their account we reply via email or phone in accordance with the users' wishes when a user submits their information through our Contact Us form.

Other Collection and Use of Information


Application and System Logs

Pearson automatically collects log data to help ensure the delivery, availability and security of this site. Log data may include technical information about how a user or visitor connected to this site, such as browser type, type of computer/device, operating system, internet service provider and IP address. We use this information for support purposes and to monitor the health of the site, identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents and appropriately scale computing resources.

Web Analytics

Pearson may use third party web trend analytical services, including Google Analytics, to collect visitor information, such as IP addresses, browser types, referring pages, pages visited and time spent on a particular site. While these analytical services collect and report information on an anonymous basis, they may use cookies to gather web trend information. The information gathered may enable Pearson (but not the third party web trend services) to link information with application and system log data. Pearson uses this information for system administration and to identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents, appropriately scale computing resources and otherwise support and deliver this site and its services.

Cookies and Related Technologies

This site uses cookies and similar technologies to personalize content, measure traffic patterns, control security, track use and access of information on this site, and provide interest-based messages and advertising. Users can manage and block the use of cookies through their browser. Disabling or blocking certain cookies may limit the functionality of this site.

Do Not Track

This site currently does not respond to Do Not Track signals.

Security


Pearson uses appropriate physical, administrative and technical security measures to protect personal information from unauthorized access, use and disclosure.

Children


This site is not directed to children under the age of 13.

Marketing


Pearson may send or direct marketing communications to users, provided that

  • Pearson will not use personal information collected or processed as a K-12 school service provider for the purpose of directed or targeted advertising.
  • Such marketing is consistent with applicable law and Pearson's legal obligations.
  • Pearson will not knowingly direct or send marketing communications to an individual who has expressed a preference not to receive marketing.
  • Where required by applicable law, express or implied consent to marketing exists and has not been withdrawn.

Pearson may provide personal information to a third party service provider on a restricted basis to provide marketing solely on behalf of Pearson or an affiliate or customer for whom Pearson is a service provider. Marketing preferences may be changed at any time.

Correcting/Updating Personal Information


If a user's personally identifiable information changes (such as your postal address or email address), we provide a way to correct or update that user's personal data provided to us. This can be done on the Account page. If a user no longer desires our service and desires to delete his or her account, please contact us at customer-service@informit.com and we will process the deletion of a user's account.

Choice/Opt-out


Users can always make an informed choice as to whether they should proceed with certain services offered by InformIT. If you choose to remove yourself from our mailing list(s) simply visit the following page and uncheck any communication you no longer want to receive: www.informit.com/u.aspx.

Sale of Personal Information


Pearson does not rent or sell personal information in exchange for any payment of money.

While Pearson does not sell personal information, as defined in Nevada law, Nevada residents may email a request for no sale of their personal information to NevadaDesignatedRequest@pearson.com.

Supplemental Privacy Statement for California Residents


California residents should read our Supplemental privacy statement for California residents in conjunction with this Privacy Notice. The Supplemental privacy statement for California residents explains Pearson's commitment to comply with California law and applies to personal information of California residents collected in connection with this site and the Services.

Sharing and Disclosure


Pearson may disclose personal information, as follows:

  • As required by law.
  • With the consent of the individual (or their parent, if the individual is a minor)
  • In response to a subpoena, court order or legal process, to the extent permitted or required by law
  • To protect the security and safety of individuals, data, assets and systems, consistent with applicable law
  • In connection the sale, joint venture or other transfer of some or all of its company or assets, subject to the provisions of this Privacy Notice
  • To investigate or address actual or suspected fraud or other illegal activities
  • To exercise its legal rights, including enforcement of the Terms of Use for this site or another contract
  • To affiliated Pearson companies and other companies and organizations who perform work for Pearson and are obligated to protect the privacy of personal information consistent with this Privacy Notice
  • To a school, organization, company or government agency, where Pearson collects or processes the personal information in a school setting or on behalf of such organization, company or government agency.

Links


This web site contains links to other sites. Please be aware that we are not responsible for the privacy practices of such other sites. We encourage our users to be aware when they leave our site and to read the privacy statements of each and every web site that collects Personal Information. This privacy statement applies solely to information collected by this web site.

Requests and Contact


Please contact us about this Privacy Notice or if you have any requests or questions relating to the privacy of your personal information.

Changes to this Privacy Notice


We may revise this Privacy Notice through an updated posting. We will identify the effective date of the revision in the posting. Often, updates are made to provide greater clarity or to comply with changes in regulatory requirements. If the updates involve material changes to the collection, protection, use or disclosure of Personal Information, Pearson will provide notice of the change through a conspicuous notice on this site or other appropriate way. Continued use of the site after the effective date of a posted revision evidences acceptance. Please contact us if you have questions or concerns about the Privacy Notice or any objection to any revisions.

Last Update: November 17, 2020