/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can obtain
* a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
* or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
* Sun designates this particular file as subject to the "Classpath" exception
* as provided by Sun in the GPL Version 2 section of the License file that
* accompanied this code. If applicable, add the following below the License
* Header, with the fields enclosed by brackets [] replaced by your own
* identifying information: "Portions Copyrighted [year]
* [name of copyright owner]"
*
* Contributor(s):
*
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
/*
* AbstractNameMapper.java
*
* Created on October 28, 2004, 2:51 PM
*/
package com.sun.jdo.api.persistence.mapping.ejb;
import java.util.*;
/** This is a class which helps translate between the various names of the
* CMP (ejb name, abstract schema, abstract bean, concrete bean, local
* interface, remote interface) and the persistence-capable class name. It
* also has methods for translation of field names. The basic entry point
* is ejb name or persistence-capable class name.
*
* @author Rochelle Raccah
*/
abstract public class AbstractNameMapper {
public static final int USER_DEFINED_KEY_CLASS = 1;
public static final int PRIMARY_KEY_FIELD = 2;
public static final int UNKNOWN_KEY_CLASS = 3;
/** Defines key field name for unknown primary key */
public static final String GENERATED_KEY_FIELD_NAME = "generatedPKField"; // NOI18N
/** Defines version field name prefix for version consistency */
public static final String GENERATED_VERSION_FIELD_PREFIX =
"thisVersionFieldWasGeneratedByTheNameMapper"; // NOI18N
protected static final String GENERATED_CMR_FIELD_PREFIX =
"thisRelationshipFieldWasGeneratedByTheNameMapper"; // NOI18N
abstract protected Map getGeneratedFieldsMap();
abstract protected Map getInverseFieldsMap();
/** Determines if the specified name represents an ejb.
* @param name the fully qualified name to be checked
* @return <code>true</code> if this name represents an ejb;
* <code>false</code> otherwise.
*/
abstract public boolean isEjbName(String name);
/** Gets the name of the abstract bean class which corresponds to the
* specified ejb name.
* @param name the name of the ejb
* @return the name of the abstract bean for the specified ejb
*/
abstract public String getAbstractBeanClassForEjbName(String name);
/** Gets the name of the key class which corresponds to the specified
* ejb name.
* @param name the name of the ejb
* @return the name of the key class for the ejb
*/
abstract public String getKeyClassForEjbName(String name);
/** Gets the name of the key class which corresponds to the specified
* persistence-capable key class name. Returns <code>null</code> if the
* supplied className is not a persistence-capable key class name.
* @param className the name of the persistence-capable key class
* @return the name of the key class for the ejb
*/
public String getKeyClassForPersistenceKeyClass(String className) {
String ejbName = getEjbNameForPersistenceKeyClass(className);
return ((ejbName != null) ? getKeyClassForEjbName(ejbName) : null);
}
/** Gets the name of the ejb name which corresponds to the
* specified persistence-capable key class name. Returns
* <code>null</code> if the supplied className is not a
* persistence-capable key class name.
* @param className the name of the persistence-capable key class
* @return the name of the ejb for the specified persistence-capable
* key class
*/
public String getEjbNameForPersistenceKeyClass(String className) {
if (className.toUpperCase().endsWith("OID")) { // NOI18N
return getEjbNameForPersistenceClass(
className.substring(0, className.length() - 4));
}
return null;
}
/** Get the type of key class of this ejb.
* @return the key class type, one of {@link #USER_DEFINED_KEY_CLASS},
* {@link #PRIMARY_KEY_FIELD}, or {@link #UNKNOWN_KEY_CLASS}
*/
abstract public int getKeyClassTypeForEjbName (String name);
/** Gets the name of the abstract schema which corresponds to the
* specified ejb.
* @param name the name of the ejb
* @return the name of the abstract schema for the specified ejb
*/
abstract public String getAbstractSchemaForEjbName(String name);
/** Gets the name of the ejb name which corresponds to the
* specified persistence-capable class name.
* @param className the name of the persistence-capable
* @return the name of the ejb for the specified persistence-capable
*/
abstract public String getEjbNameForPersistenceClass(String className);
/** Gets the name of the persistence-capable class which corresponds to
* the specified ejb name.
* @param name the name of the ejb
* @return the name of the persistence-capable for the specified ejb
*/
abstract public String getPersistenceClassForEjbName(String name);
/** Determines if the specified name represents a local interface.
* @param name the fully qualified name to be checked
* @return <code>true</code> if this name represents a local interface;
* <code>false</code> otherwise.
*/
abstract public boolean isLocalInterface(String name);
/** Gets the name of the persistence-capable class which corresponds to
* the specified local interface name.
* @param className the name of the persistence-capable class which
* contains fieldName from which to find relationship and therefore the
* local interface
* @param fieldName the name of the field in the persistence-capable class
* @param interfaceName the name of the local interface
* @return the name of the persistence-capable for the specified
* local interface which is related to the specified class name, field name
* pair
*/
public String getPersistenceClassForLocalInterface(String className,
String fieldName, String interfaceName) {
if (isLocalInterface(interfaceName)) {
String ejbName = getEjbNameForPersistenceClass(className);
String ejbField =
getEjbFieldForPersistenceField(className, fieldName);
return getPersistenceClassForEjbName(
getEjbNameForLocalInterface(ejbName, ejbField, interfaceName));
}
return null;
}
/** Gets the name of the ejb which corresponds to the specified
* local interface name.
* @param ejbName the name of the ejb which contains fieldName
* from which to find relationship and therefore the local interface
* @param fieldName the name of the field in the ejb
* @param interfaceName the name of the local interface
* @return the name of the ejb for the specified local interface
*/
abstract public String getEjbNameForLocalInterface(String ejbName,
String fieldName, String interfaceName);
/** Gets the name of the local interface which corresponds to the
* specified ejb name.
* @param name the name of the ejb
* @return the name of the local interface for the specified ejb
*/
abstract public String getLocalInterfaceForEjbName(String name);
/** Determines if the specified name represents a remote interface.
* @param name the fully qualified name to be checked
* @return <code>true</code> if this name represents a remote interface;
* <code>false</code> otherwise.
*/
abstract public boolean isRemoteInterface(String name);
/** Gets the name of the persistence-capable class which corresponds to
* the specified remote interface name.
* @param className the name of the persistence-capable class which
* contains fieldName from which to find relationship and therefore the
* remote interface
* @param fieldName the name of the field in the persistence-capable class
* @param interfaceName the name of the remote interface
* @return the name of the persistence-capable for the specified
* remote interface which is related to the specified class name, field name
* pair
*/
public String getPersistenceClassForRemoteInterface(
String className, String fieldName, String interfaceName) {
if (isRemoteInterface(interfaceName)) {
String ejbName = getEjbNameForPersistenceClass(className);
String ejbField =
getEjbFieldForPersistenceField(className, fieldName);
return getPersistenceClassForEjbName(
getEjbNameForRemoteInterface(ejbName, ejbField, interfaceName));
}
return null;
}
/** Gets the name of the ejb which corresponds to the specified
* remote interface name.
* @param ejbName the name of the ejb which contains fieldName
* from which to find relationship and therefore the remote interface
* @param fieldName the name of the field in the ejb
* @param interfaceName the name of the remote interface
* @return the name of the ejb for the specified remote interface
*/
abstract public String getEjbNameForRemoteInterface(String ejbName,
String fieldName, String interfaceName);
/** Gets the name of the remote interface which corresponds to the
* specified ejb name.
* @param name the name of the ejb
* @return the name of the remote interface for the specified ejb
*/
abstract public String getRemoteInterfaceForEjbName(String name);
/** Gets the name of the field in the ejb which corresponds to the
* specified persistence-capable class name and field name pair.
* @param className the name of the persistence-capable
* @param fieldName the name of the field in the persistence-capable
* @return the name of the field in the ejb for the specified
* persistence-capable field
*/
abstract public String getEjbFieldForPersistenceField(String className,
String fieldName);
/** Gets the name of the field in the persistence-capable class which
* corresponds to the specified ejb name and field name pair.
* @param name the name of the ejb
* @param fieldName the name of the field in the ejb
* @return the name of the field in the persistence-capable for the
* specified ejb field
*/
abstract public String getPersistenceFieldForEjbField(String name,
String fieldName);
/** Returns <code>true</code> if the field is a generated field.
* That includes: relationships generated for 2 way managed relationships,
* key fields generated for use with {@link #UNKNOWN_KEY_CLASS}, or
* version fields generated to hold a version consistency column.
* @param name the name of the ejb
* @param fieldName the name of the field in the ejb
* @return <code>true</code> if the field is generated;<code>false</code>
* otherwise
*/
public boolean isGeneratedField(String name, String fieldName) {
return isGeneratedEjbRelationship(name, fieldName) ||
fieldName.equals(GENERATED_KEY_FIELD_NAME) ||
fieldName.startsWith(GENERATED_VERSION_FIELD_PREFIX);
}
/** Returns <code>true</code> if the field in the persistence-capable
* class which corresponds to the specified ejb name and field name pair
* is one which was generated automatically for 2 way managed
* relationships in the case that the ejb specifies one way
* relationships.
* @param className the name of the ejb
* @param fieldName the name of the field in the ejb
* @return <code>true</code> if the field is generated;<code>false</code>
* otherwise
*/
public boolean isGeneratedEjbRelationship(String name, String fieldName) {
return getGeneratedFieldsMap().keySet().contains(
Arrays.asList(new String[]{name, fieldName}));
}
/** The list contains generated relationship field names.
* @param name the name of the ejb
* @return a List of generated relationship names
*/
public List getGeneratedRelationshipsForEjbName(String name) {
Map generatedFieldsMap = getGeneratedFieldsMap();
Iterator iterator = generatedFieldsMap.keySet().iterator();
List returnList = new ArrayList();
while (iterator.hasNext()) {
List nextField = (List)iterator.next();
if (nextField.get(0).equals(name))
returnList.add(nextField.get(1));
}
return returnList;
}
/** Gets the name of the generated field in the ejb which corresponds to
* the specified ejb name and field name pair.
* @param name the name of the ejb
* @param fieldName the name of the field in the ejb
* @return a String array of the form {<ejb name>, <field name>} which
* represents the generated field for the ejb field
*/
public String[] getGeneratedFieldForEjbField(String name,
String fieldName) {
List field = (List)getInverseFieldsMap().get(
Arrays.asList(new String[]{name, fieldName}));
return ((field != null) ?
(String[])field.toArray(new String[2]) : null);
}
/** Gets the name of the ejb field which corresponds to the specified
* generated ejb name and field name pair.
* @param name the name of the ejb
* @param fieldName the name of the field in the ejb
* @return a String array of the form {<ejb name>, <field name>} which
* represents the inverse field for the generated field
*/
public String[] getEjbFieldForGeneratedField(String name, String fieldName)
{
List field = (List)getGeneratedFieldsMap().get(
Arrays.asList(new String[]{name, fieldName}));
return ((field != null) ?
(String[])field.toArray(new String[2]) : null);
}
}
|
