EntityCmpDesc.java

package org.objectweb.jonas_ejb.deployment.api;

import java.lang.reflect.Field;
import java.lang.reflect.Modifier;
import java.util.HashMap;
import java.util.Iterator;

import org.objectweb.jonas_ejb.deployment.xml.AssemblyDescriptor;
import org.objectweb.jonas_ejb.deployment.xml.Entity;
import org.objectweb.jonas_ejb.deployment.xml.CmpField;
import org.objectweb.jonas_ejb.deployment.xml.JonasEntity;
import org.objectweb.jonas_ejb.deployment.xml.JdbcMapping;
import org.objectweb.jonas_ejb.lib.BeanNaming;
import org.objectweb.jonas_lib.deployment.api.DeploymentDescException;
import org.objectweb.jonas_lib.deployment.xml.JLinkedList;

public abstract class EntityCmpDesc extends EntityDesc {

    protected HashMap fieldDesc = new HashMap();
    protected String primaryKeyField = null;
    protected String jdbcAutomaticPkFieldName = null;

    public EntityCmpDesc(ClassLoader classLoader, Entity ent,
             AssemblyDescriptor asd, JonasEntity jEnt,
             JLinkedList jMDRList, String fileName)
        throws DeploymentDescException {

        super(classLoader, ent, asd, jEnt, jMDRList, fileName);

        // field descriptors for persistent fields
        for (Iterator i = ent.getCmpFieldList().iterator(); i.hasNext();) {
            String fn = ((CmpField) i.next()).getFieldName();
            FieldDesc fd = this.newFieldDescInstance();
            fd.setName(fn);
            fd.setPrimaryKey(false);
            fieldDesc.put(fn, fd);

        }

        // jdbc pk auto field name
        JdbcMapping jm = jEnt.getJdbcMapping();
        if ((jm != null) && (jm.getJdbcAutomaticPkFieldName() != null)) {
            if (jm.getJdbcAutomaticPkFieldName().length() != 0) {
                jdbcAutomaticPkFieldName = jm.getJdbcAutomaticPkFieldName();
            }
        }
        if (jdbcAutomaticPkFieldName == null) {
            // Default value
            jdbcAutomaticPkFieldName =  "JPK_";
        }

        if (isUndefinedPK()) { // Automatic PK
           // If Primary Field is not declared (auto generated key field)
            primaryKeyField = "JONASAUTOPKFIELD";
        } else if (ent.getPrimkeyField() != null) {
            // primary key field
            primaryKeyField = ent.getPrimkeyField();
            FieldDesc fd = (FieldDesc) fieldDesc.get(primaryKeyField);
            if (fd == null) {
                throw new DeploymentDescException("primkey-field " + primaryKeyField + " is not listed as cmp-field in bean " + this.ejbName);
            }
            fd.setPrimaryKey(true);
        } else {
            // public fields of primary key class
            Field[] pcf = primaryKeyClass.getFields();
            for (int i = 0; i < pcf.length; i++) {
                if (Modifier.isPublic(pcf[i].getModifiers())) {
                    String pn = pcf[i].getName();
                    // exclude serialVersionUID field for jdk1.2.1 on solaris and
                    // exclude JProbe$ for JProbe using
                    if (!pn.equals("serialVersionUID") && !pn.startsWith("JProbe$")) {
                        FieldDesc fd = (FieldDesc) fieldDesc.get(pn);
                        if (fd == null) {
                            throw new DeploymentDescException("public field " + pn + " of primkey-class is not listed as cmp-field in bean " + this.ejbName);
                        }
                        fd.setPrimaryKey(true);
                    }
                }
            }
        }
        String packageName = BeanNaming.getPackageName(getEjbClass().getName());
        derivedBeanName = new String("JOnAS" + getIdentifier() + "Bean");
        fullDerivedBeanName = BeanNaming.getClassName(packageName, derivedBeanName);

        // automatic-pk
        // used of specific tag automatic-pk is deprecated so nothing in this code was about jdbc-mapping
        String primkeytype = ent.getPrimKeyClass();
        if ((jm != null) && (jm.getAutomaticPk() != null)) {
            // optional parameter automatic-pk
            jdbcAutomaticPk = jm.getAutomaticPk().equalsIgnoreCase("true");
            if (jdbcAutomaticPk && pkObjectType) {
                // You can't use specific tag 'automatic-pk' with prim-key-type=java.lang.Object
                throw new DeploymentDescException("Don't use specific tag 'automatic-pk' with prim-key-type=java.lang.Object in bean " + ent.getEjbName());
            }
        }
        if (pkObjectType && ent.getPrimkeyField() != null) {
             throw new DeploymentDescException("'prim-key-field' must not be set if your prim-key-type was java.lang.Object in bean " + ent.getEjbName());
        }
        if (this.isAutomaticPk()) { // Check if prim-key-class type is Integer or java.lang.Object
            if (!(primkeytype.equalsIgnoreCase("java.lang.Integer")
                    || primkeytype.equalsIgnoreCase("Integer"))) {
                throw new DeploymentDescException("You must used java.lang.Integer type for your auto-generate primary key field in bean " + ent.getEjbName());
            }
        }
    }

    public FieldDesc getCmpFieldDesc(String fieldName) {
        return (FieldDesc) fieldDesc.get(fieldName);
    }

    public boolean hasSimplePkField() {
        return primaryKeyField != null;
    }

    // TODO remove this method and keep only the hasSimplePkField method
    public boolean hasPrimaryKeyField() {
        return hasSimplePkField();
    }

    public FieldDesc getSimplePkField() {
        FieldDesc fd = (FieldDesc) fieldDesc.get(getSimplePkFieldName());
        return fd;
    }

    public String getSimplePkFieldName() {
        if (primaryKeyField == null) {
            throw new Error("No primary key field defined for bean " + this.ejbName);
        }
        return primaryKeyField;
    }

    // TODO remove this method and keep only the getSimplePkFieldName() method
    public String getPrimaryKeyFieldName() {
        return getSimplePkFieldName();
    }

    public String getJdbcAutomaticPkFieldName() {
        return jdbcAutomaticPkFieldName;
    }

    public Iterator getCmpFieldDescIterator() {
        return fieldDesc.values().iterator();
    }
    public String toString() {
        StringBuffer ret = new StringBuffer();
        ret.append(super.toString());
        for (Iterator i = fieldDesc.keySet().iterator(); i.hasNext();) {
            String f = (String) i.next();
            FieldDesc fd = (FieldDesc) fieldDesc.get(f);
            ret.append("\ngetCmpFieldDesc(" + f + ")=" + fd.getClass().getName());
            ret.append(fd.toString());
        }
        if (hasPrimaryKeyField()) {
            ret.append("\ngetPrimaryKeyField()=" + getPrimaryKeyFieldName());
        }
        return ret.toString();
    }

    protected FieldDesc newFieldDescInstance() {
        return new FieldJdbcDesc();
    }
}

---