oracle.toplink.essentials.querykeys.ForeignReferenceQueryKey Maven / Gradle / Ivy
The newest version!
/*
* The contents of this file are subject to the terms
* of the Common Development and Distribution License
* (the "License"). You may not use this file except
* in compliance with the License.
*
* You can obtain a copy of the license at
* glassfish/bootstrap/legal/CDDLv1.0.txt or
* https://glassfish.dev.java.net/public/CDDLv1.0.html.
* See the License for the specific language governing
* permissions and limitations under the License.
*
* When distributing Covered Code, include this CDDL
* HEADER in each file and include the License file at
* glassfish/bootstrap/legal/CDDLv1.0.txt. If applicable,
* add the following below this CDDL HEADER, with the
* fields enclosed by brackets "[]" replaced with your
* own identifying information: Portions Copyright [yyyy]
* [name of copyright owner]
*/
// Copyright (c) 1998, 2006, Oracle. All rights reserved.
package oracle.toplink.essentials.querykeys;
import java.security.AccessController;
import java.security.PrivilegedActionException;
import oracle.toplink.essentials.expressions.*;
import oracle.toplink.essentials.exceptions.ValidationException;
import oracle.toplink.essentials.internal.security.PrivilegedAccessHelper;
import oracle.toplink.essentials.internal.security.PrivilegedClassForName;
/**
*
* Purpose: Define an alias to a foreign object.
*
* Responsibilities:
*
* - Define the reference class of the foreign object.
*
*/
public class ForeignReferenceQueryKey extends QueryKey {
protected Class referenceClass;
protected String referenceClassName;
protected Expression joinCriteria;
/**
* INTERNAL:
* Convert all the class-name-based settings in this project to actual class-based
* settings
* @param classLoader
*/
public void convertClassNamesToClasses(ClassLoader classLoader){
Class referenceClass = null;
try{
if (referenceClassName != null){
if (PrivilegedAccessHelper.shouldUsePrivilegedAccess()){
try {
referenceClass = (Class)AccessController.doPrivileged(new PrivilegedClassForName(referenceClassName, true, classLoader));
} catch (PrivilegedActionException exception) {
throw ValidationException.classNotFoundWhileConvertingClassNames(referenceClassName, exception.getException());
}
} else {
referenceClass = oracle.toplink.essentials.internal.security.PrivilegedAccessHelper.getClassForName(referenceClassName, true, classLoader);
}
}
setReferenceClass(referenceClass);
} catch (ClassNotFoundException exc){
throw ValidationException.classNotFoundWhileConvertingClassNames(referenceClassName, exc);
}
}
/**
* PUBLIC:
* Return the join expression for the relationship defined by the query key.
*/
public Expression getJoinCriteria() {
return joinCriteria;
}
/**
* PUBLIC:
* Return the reference class of the relationship.
*/
public Class getReferenceClass() {
return referenceClass;
}
/**
* PUBLIC:
* Return the reference class name of the relationship.
*/
public String getReferenceClassName() {
if (referenceClassName == null && referenceClass != null){
referenceClassName = referenceClass.getName();
}
return referenceClassName;
}
/**
* INTERNAL:
* override the isForeignReferenceQueryKey() method in the superclass to return true.
* @return boolean
*/
public boolean isForeignReferenceQueryKey() {
return true;
}
/**
* PUBLIC:
* Set the join expression for the relationship defined by the query key.
* Example:
*
* builder.getField("ADDRESS.ADDRESS_ID").equal(builder.getParameter("EMPLOYEE.ADDR_ID");
*
*/
public void setJoinCriteria(Expression joinCriteria) {
this.joinCriteria = joinCriteria;
}
/**
* PUBLIC:
* Set the reference class of the relationship.
* This is not required for direct collection query keys.
*/
public void setReferenceClass(Class referenceClass) {
this.referenceClass = referenceClass;
}
/**
* PUBLIC:
* Set the reference class name for this relationship
* This is used when projects are built without using classes
* @param referenceClassName
*/
public void setReferenceClassName(String referenceClassName) {
this.referenceClassName = referenceClassName;
}
}