Beispiel: Container Managed Relationship (JBoss 4.0)

• Zuerst einmal ändern wir die XDoclet-Definition im Klassenkopf:

   * @ejb.bean name="Kuchen"	
   *           description="A session bean named Kuchen"
   *           display-name="Kuchen"
   *           jndi-name="Kuchen"
   *           type="CMP" 
   *           transaction-type="Container" 
   *           cmp-version="2.x" 
   *           view-type="local" 
   *           primkey-field="id" 
   * @ejb.pk  
   *           class="java.lang.Integer" 
   *           generate="false"  

  Wir möchten eine CMP-Entity-Bean haben. Den Primary Key werden wir hier selbst generieren und den Typ "java.lang.Integer" verwenden (den XDoclet natürlich nicht als Klasse generieren soll). Das XDoclet-Tag @ejb.pk ist hier nicht nötig. Seeehr wichtig ist die Angabe das PrimaryKey-Felds in @ejb.bean !
  
  
• Die Dummy-Methode "foo" wird entfernt.
  
  
• Jetzt werden die Felder zugefügt: Name und ID (vom Typ java.lang.Integer).

    /**Abrufen der Kuchen-ID
     * @return Die Kuchen-ID
     * 
     * @ejb.persistence column-name="id" 
     * @ejb.interface-method view-type="local" 
     * @ejb.pk-field 
     */
    public abstract Integer getId();
  
    /**Setzen der Kuchen-Id.
     * @param int_Id Die neue ID.
     * 
     * @ejb.persistence column-name="id" 
     * @ejb.interface-method view-type="local" 
     * @ejb.pk-field 
     */
    public abstract void setId (Integer int_Id);
  
  
    /**Abrufen des Kuchen-Namens.
     * @return der Kuchen-Name.
     * 
     * @ejb.persistence column-name="name" sql-type="VARCHAR"  
     * @ejb.interface-method view-type="local" 
     */
    public abstract String getName();
  
    /**Setzen des Kuchen-Namens.
     * @param str_Name der Name
     * 
     * @ejb.persistence column-name="name" sql-type="VARCHAR" 
     * @ejb.interface-method view-type="local" 
     */
    public abstract void setName (String str_Name); 

  Man beachte das XDoclet-Tag @ejb.pk-field in getId/setId ! In diesen beiden Methoden habe ich im @ejb.persistence darauf verzichtet den Feldtyp anzugeben, es hätte auch so aussehen können:

  @ejb.persistence column-name="id" sql-type="INT"

  
  
• Die beiden ejbCreate-Methoden werden erzeugt, die jeweils als Rückgabewert einen Integer-Wert haben. "ejbCreate" mit dem Kuchennamen als Parameter sieht so aus (für ejbCreate ohne Parameter analog):
  

    /**Erzeugen eines Kuchen-Objekts, wobei der Name angegeben wird. Der Key wird automatisch erzeugt.
     * @param str_Name Der Name des Kuchens.
     * @return Die ID des Kuchens.
     * @exception CreateException Fehler beim Erzeugen.
     * 
     * @ejb.create-method view-type="local" 
     */
    public Integer ejbCreateByName (String str_Name) throws CreateException
    {
      KuchenBean.logger.info("ejbCreateByName: " + str_Name);
      this.setName(str_Name);
  
      //Key erzeugen:
      this.setId ( this.ejbHomeGetNextId() );
      //return null;
      return this.getId();
    } 

  Natürlich müssen die zugehörigen ejbPostCreate-Methoden ebenfalls deklariert werden.
  
  
• Die Deklaration der Finder-Methode wird im Klassen-Kopf zugefügt:

   * @ejb.finder 
   *           signature="java.util.Collection findAll()" 
   *           query="select Object(o) from Kuchen o order by o.name"  

  
  
  
• Die Select-Methode für das Ermitteln der maximalen ID wird angelegt:

   /**Ermitteln der maximalen Kuchen-ID in Datenbank
     * Der EJB-QL-Befehl wird per Deploytool festgelegt.
     * (select max (....)
     * @return Maximale ZutatID aus Datenbank.
     * 
     * @ejb.select query="select max (k.id) from Kuchen k" 
     */
    public abstract Integer ejbSelectMaxId() throws javax.ejb.FinderException; 

  
  
  
• Zu guter letzt noch die Hilfsmethode "getNextId" zufügen, die aus den ejbCreate-Methoden aufgerufen wird und die ejbSelect-Methode aufruft.
  
  

 /**Abrufen aller Zutaten dieses Kuchens.
   * @return Collection von Zutat-Objekten.
   * @ejb.interface-method view-type="local" 
   * @ejb.relation 
   *   name="KuchenZutaten" 
   *   role-name="kuchen-hat-zutaten" 
   */
  public abstract Collection getZutaten();

  /**Setzen der kompletten Zutaten-Liste des Kuchens.
   * Wird vom Container übernommen.
   * @param coll_Zutaten Liste der Zutaten.
   * 
   * @ejb.interface-method view-type="local" 
   */
  public abstract void setZutaten (Collection coll_Zutaten); 

  /**Abrufen des Kuchens, zu dem die Zutat gehört.
   * @return Den Kuchen der Zutat.
   *
   * @ejb.interface-method view-type="local" 
   * @ejb.relation   
   *   name="KuchenZutaten"   
   *   role-name="zutat-hat-kuchen"  
   *   cascade-delete="yes" 
   * @jboss.relation fk-constraint="true" 
   *   related-pk-field="id" 
   *   fk-column="kuchen_fk" 
   */
   */
  public abstract KuchenLocal getKuchen();

  /**Setzen des Kuchens, zu dem die Zutat gehört.
   * @param kuchen Der Kuchen der Zutat.
   * 
   * @ejb.interface-method view-type="local" 
   */
  public abstract void setKuchen(KuchenLocal kuchen); 

21:20:02,250 WARN  [ServiceController] Problem starting service jboss.j2ee:jndiName=KuchenLocal,service=EJB
org.jboss.deployment.DeploymentException: Atleast one role of a foreign-key mapped relationship must have key fields (or <primkey-field> is missing from ejb-jar.xml): ejb-relation-name=KuchenZutaten
... 

   <relationships >
      <ejb-relation >
         <ejb-relation-name>KuchenZutaten</ejb-relation-name>

         <ejb-relationship-role >
            <ejb-relationship-role-name>zutat-hat-kuchen</ejb-relationship-role-name>
            <multiplicity>Many</multiplicity>
            <cascade-delete/>
            <relationship-role-source >
               <ejb-name>Zutat</ejb-name>
            </relationship-role-source>
            <cmr-field >
               <cmr-field-name>kuchen</cmr-field-name>
            </cmr-field>
         </ejb-relationship-role>

         <ejb-relationship-role >
            <ejb-relationship-role-name>kuchen-hat-zutaten</ejb-relationship-role-name>
            <multiplicity>One</multiplicity>
            <relationship-role-source >
               <ejb-name>Kuchen</ejb-name>
            </relationship-role-source>
            <cmr-field >
               <cmr-field-name>zutaten</cmr-field-name>
               <cmr-field-type>java.util.Collection</cmr-field-type>
            </cmr-field>
         </ejb-relationship-role>
   </relationships>

  <relationships>
    <ejb-relation>
      <ejb-relation-name>KuchenZutaten</ejb-relation-name>

      <ejb-relationship-role>
          <ejb-relationship-role-name>zutat-hat-kuchen</ejb-relationship-role-name>
          <fk-constraint>true</fk-constraint>
		  <key-fields/>

      </ejb-relationship-role>
      <ejb-relationship-role>
          <ejb-relationship-role-name>kuchen-hat-zutaten</ejb-relationship-role-name>
          <key-fields>
             <key-field>
               <field-name>id</field-name>
               <column-name>kuchen_fk</column-name>
             </key-field>
          </key-fields>

      </ejb-relationship-role>
    </ejb-relation>
  </relationships> 

<ejb-local-ref>
	<ejb-ref-name>ejb/Zutat</ejb-ref-name>
	<ejb-ref-type>Entity</ejb-ref-type>
	<local-home>com.knauf.ejb.kuchenzutat.ZutatLocalHome</local-home>
	<local>com.knauf.ejb.kuchenzutat.ZutatLocal</local>
	<ejb-link>Zutat</ejb-link>
</ejb-local-ref>
<ejb-local-ref>
	<ejb-ref-name>ejb/Kuchen</ejb-ref-name>
	<ejb-ref-type>Entity</ejb-ref-type>
	<local-home>com.knauf.ejb.kuchenzutat.KuchenLocalHome</local-home>
	<local>com.knauf.ejb.kuchenzutat.KuchenLocal</local>
	<ejb-link>Kuchen</ejb-link>
</ejb-local-ref>