oracle.toplink.essentials.internal.queryframework.ExpressionQueryMechanism Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* // Copyright (c) 1998, 2007, Oracle. 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.
*/
package oracle.toplink.essentials.internal.queryframework;
import java.util.*;
import oracle.toplink.essentials.internal.descriptors.OptimisticLockingPolicy;
import oracle.toplink.essentials.internal.helper.*;
import oracle.toplink.essentials.internal.expressions.*;
import oracle.toplink.essentials.expressions.*;
import oracle.toplink.essentials.logging.SessionLog;
import oracle.toplink.essentials.mappings.DatabaseMapping;
import oracle.toplink.essentials.mappings.DirectCollectionMapping;
import oracle.toplink.essentials.mappings.ManyToManyMapping;
import oracle.toplink.essentials.exceptions.*;
import oracle.toplink.essentials.mappings.OneToOneMapping;
import oracle.toplink.essentials.queryframework.*;
import oracle.toplink.essentials.descriptors.InheritancePolicy;
import oracle.toplink.essentials.descriptors.DescriptorQueryManager;
import oracle.toplink.essentials.internal.sessions.AbstractRecord;
import oracle.toplink.essentials.internal.sessions.UnitOfWorkImpl;
import oracle.toplink.essentials.internal.sessions.AbstractSession;
import oracle.toplink.essentials.descriptors.ClassDescriptor;
/**
* Purpose:
* Mechanism used for all expression read queries.
* ExpressionQueryInterface understands how to deal with expressions.
*
*
Responsibilities:
* Translates the expression and creates the appropriate SQL statements.
* Retrieves the data from the database and return the results to the query.
*
* @author Yvon Lavoie
* @since TOPLink/Java 1.0
*/
public class ExpressionQueryMechanism extends StatementQueryMechanism {
protected Expression selectionCriteria;
/**
* Initialize the state of the query
* @param query - owner of mechanism
*/
public ExpressionQueryMechanism(DatabaseQuery query) {
super(query);
}
/**
* Initialize the state of the query
* @param query - owner of mechanism
* @param expression - selection criteria
*/
public ExpressionQueryMechanism(DatabaseQuery query, Expression expression) {
super(query);
this.selectionCriteria = expression;
}
/**
* Alias the supplied fields with respect to the expression node. Return copies of the fields
*/
protected Vector aliasFields(ObjectExpression node, Vector fields) {
Vector result = new Vector(fields.size());
for (Enumeration e = fields.elements(); e.hasMoreElements();) {
DatabaseField eachField = (DatabaseField)((DatabaseField)e.nextElement()).clone();
eachField.setTable(node.aliasForTable(eachField.getTable()));
result.addElement(eachField);
}
return result;
}
/**
* If the fields in the statement have breen pre-set, e.g. for a subset of the fields
* in a partial attribute read, report query, or just a query for the class indicator,
* then try to alias those. Right now this just guesses that they're all from the base.
*/
public Vector aliasPresetFields(SQLSelectStatement statement) {
Vector fields = statement.getFields();
Expression exp = statement.getWhereClause();
if (exp == null) {
return fields;
} else {
ExpressionBuilder base = exp.getBuilder();
return aliasFields(base, fields);
}
}
/**
* Create the appropriate where clause.
* Since this is where the selection criteria gets cloned for the first time
* (long after the owning query has been) many interesting things happen here.
*/
public Expression buildBaseSelectionCriteria(boolean isSubSelect, Dictionary clonedExpressions) {
Expression expression = getSelectionCriteria();
// For Flashback: builder.asOf(value) counts as a non-trivial selection criteria.
// Also for bug 2612185 try to preserve the original builder as far as possible.
if ((expression == null) && getQuery().isObjectLevelReadQuery()) {
expression = ((ObjectLevelReadQuery)getQuery()).getExpressionBuilder();
}
// Subselects are not cloned, as they are cloned in the context of the parent expression.
if ((!isSubSelect) && (expression != null)) {
// For bug 2612185 specify the identity hashtable to be used in cloning so
// it is not thrown away at the end of cloning.
expression = expression.copiedVersionFrom(clonedExpressions);
}
DescriptorQueryManager queryManager = getDescriptor().getQueryManager();
// Leaf inheritence and multiple table join.
if (queryManager.getAdditionalJoinExpression() != null) {
// CR#3701077, additional join not required for view, view does join.
if (! (getDescriptor().hasInheritance() && (getDescriptor().getInheritancePolicy().hasView()))) {
Expression additionalJoin = (Expression)queryManager.getAdditionalJoinExpression();
// If there's an expression, then we know we'll have to rebuild anyway, so don't clone.
if (expression == null) {
// Should never happen...
expression = (Expression)additionalJoin.clone();
} else {
if (query.isObjectLevelReadQuery()){
ExpressionBuilder builder = ((ObjectLevelReadQuery)query).getExpressionBuilder();
if ((additionalJoin.getBuilder() != builder) && (additionalJoin.getBuilder().getQueryClass() == null)) {
if ((!isSubSelect) && (builder != null)) {
builder = (ExpressionBuilder)builder.copiedVersionFrom(clonedExpressions);
}
additionalJoin = additionalJoin.rebuildOn(builder);
}
}
expression = expression.and(additionalJoin);
}
// set wasAdditionalJoinCriteriaUsed on the addionalJoin because the expression may not have the correct builder as its left most builder
additionalJoin.getBuilder().setWasAdditionJoinCriteriaUsed(true);
}
}
return expression;
}
/**
* Return the appropriate select statement containing the fields in the table.
*/
public SQLSelectStatement buildBaseSelectStatement(boolean isSubSelect, Dictionary clonedExpressions) {
SQLSelectStatement selectStatement = new SQLSelectStatement();
selectStatement.setLockingClause(((ObjectLevelReadQuery)getQuery()).getLockingClause());
selectStatement.setDistinctState(((ObjectLevelReadQuery)getQuery()).getDistinctState());
selectStatement.setTables((Vector)getDescriptor().getTables().clone());
selectStatement.setWhereClause(buildBaseSelectionCriteria(isSubSelect, clonedExpressions));
if (getQuery().isReadAllQuery() && ((ReadAllQuery)getQuery()).hasOrderByExpressions()) {
//For bug 2641, the clone of the OrderBy expressions needs to be used to ensure they are normalized
//every time when select SQL statement gets re-prepared, which will further guarantee the calculation
//of table alias always be correct
selectStatement.setOrderByExpressions(cloneExpressions(((ReadAllQuery)getQuery()).getOrderByExpressions(),clonedExpressions));
}
selectStatement.setTranslationRow(getTranslationRow());
return selectStatement;
}
/**
* Return the appropriate select statement containing the fields in the table.
* This is used as a second read to a concrete class with subclasses in an abstract-multiple table read.
*/
protected SQLSelectStatement buildConcreteSelectStatement() {
// 2612538 - the default size of IdentityHashtable (32) is appropriate
IdentityHashtable clonedExpressions = new IdentityHashtable();
SQLSelectStatement selectStatement = buildBaseSelectStatement(false, clonedExpressions);
// Case of class with subclasses that also has instances on abstract-multiple table read.
if (getDescriptor().hasInheritance() && getDescriptor().getInheritancePolicy().shouldReadSubclasses()) {
Expression concrete = (Expression)getDescriptor().getInheritancePolicy().getOnlyInstancesExpression();
if ((concrete != null) && (selectStatement.getWhereClause() != null)) {
selectStatement.setWhereClause(selectStatement.getWhereClause().and(concrete));
} else if (concrete != null) {
selectStatement.setWhereClause((Expression)concrete.clone());
}
}
selectStatement.setFields(getSelectionFields(selectStatement, false));
selectStatement.normalize(getSession(), getDescriptor(), clonedExpressions);
// Allow for joining indexes to be computed to ensure distinct rows
((ObjectLevelReadQuery)getQuery()).getJoinedAttributeManager().computeJoiningMappingIndexes(false, getSession(), 0);
return selectStatement;
}
/**
* Return the appropriate delete statement
* Passing of a call/ statement pair is used because the same pair
* may be used several times.
* More elegant orangement of passing just a statement and creating the call
* in the method was rejected because the same call would've been potentially
* re-created several times.
* Preconditions:
* if selectCallForExist != null then selectStatementForExist != null;
* if selectCallForNotExist != null then selectStatementForNotExist != null.
* @return SQLDeleteStatement
*/
protected SQLDeleteStatement buildDeleteAllStatement(DatabaseTable table, Expression inheritanceExpression,
SQLCall selectCallForExist, SQLSelectStatement selectStatementForExist,
SQLCall selectCallForNotExist, SQLSelectStatement selectStatementForNotExist,
Collection primaryKeyFields) {
if(selectCallForExist == null && selectCallForNotExist == null) {
return buildDeleteStatementForDeleteAllQuery(table, inheritanceExpression);
}
SQLDeleteAllStatement deleteAllStatement = new SQLDeleteAllStatement();
deleteAllStatement.setTable(table);
deleteAllStatement.setTranslationRow(getTranslationRow());
if(selectCallForExist != null) {
deleteAllStatement.setSelectCallForExist(selectCallForExist);
// if selectStatementForExist doesn't require aliasing and targets the same
// table as the statement to be built,
// then instead of creating sql with "WHERE EXISTS("
// sql is created by extracting where clause from selectStatementForExist,
// for instance:
// DELETE FROM PROJECT WHERE (PROJ_NAME = ?)
// instead of the wrong one:
// DELETE FROM PROJECT WHERE EXISTS(SELECT PROJ_ID FROM PROJECT WHERE (PROJ_NAME = ?) AND PROJECT.PROJ_ID = PROJECT.PROJ_ID)
deleteAllStatement.setShouldExtractWhereClauseFromSelectCallForExist(!selectStatementForExist.requiresAliases() && table.equals(selectStatementForExist.getTables().firstElement()));
deleteAllStatement.setTableAliasInSelectCallForExist(getAliasTableName(selectStatementForExist, table));
} else {
// inheritanceExpression is irrelevant in case selectCallForExist != null
if(inheritanceExpression != null) {
deleteAllStatement.setInheritanceExpression((Expression)inheritanceExpression.clone());
}
}
if(selectCallForNotExist != null) {
deleteAllStatement.setSelectCallForNotExist(selectCallForNotExist);
deleteAllStatement.setTableAliasInSelectCallForNotExist(getAliasTableName(selectStatementForNotExist, table));
}
deleteAllStatement.setPrimaryKeyFieldsForAutoJoin(primaryKeyFields);
return deleteAllStatement;
}
protected SQLDeleteStatement buildDeleteAllStatementForMapping(SQLCall selectCallForExist, SQLSelectStatement selectStatementForExist, Vector sourceFields, Vector targetFields) {
DatabaseTable targetTable = ((DatabaseField)targetFields.firstElement()).getTable();
if(selectCallForExist == null) {
return buildDeleteStatementForDeleteAllQuery(targetTable);
}
SQLDeleteAllStatement deleteAllStatement = new SQLDeleteAllStatement();
deleteAllStatement.setTable(targetTable);
deleteAllStatement.setTranslationRow(getTranslationRow());
deleteAllStatement.setSelectCallForExist(selectCallForExist);
DatabaseTable sourceTable = ((DatabaseField)sourceFields.firstElement()).getTable();
if(selectStatementForExist != null) {
deleteAllStatement.setTableAliasInSelectCallForExist(getAliasTableName(selectStatementForExist, sourceTable));
}
deleteAllStatement.setAliasedFieldsForJoin(sourceFields);
deleteAllStatement.setOriginalFieldsForJoin(targetFields);
return deleteAllStatement;
}
protected static String getAliasTableName(SQLSelectStatement selectStatement, DatabaseTable table) {
if(!selectStatement.requiresAliases()) {
return null;
}
HashSet aliasTables = new HashSet();
Iterator itEntries = selectStatement.getTableAliases().entrySet().iterator();
DatabaseTable aliasTable = null;
while(itEntries.hasNext()) {
Map.Entry entry = (Map.Entry)itEntries.next();
if(table.equals(entry.getValue())) {
aliasTable = (DatabaseTable)entry.getKey();
aliasTables.add(aliasTable);
}
}
if(aliasTables.isEmpty()) {
return null;
} else if(aliasTables.size() == 1) {
return aliasTable.getQualifiedName();
}
// The table has several aliases,
// remove the aliases that used by DataExpressions
// with baseExpression NOT the expressionBuilder used by the statement
ExpressionIterator expIterator = new ExpressionIterator() {
public void iterate(Expression each) {
if(each instanceof DataExpression) {
DataExpression dataExpression = (DataExpression)each;
DatabaseField field = dataExpression.getField();
if(field != null) {
if(dataExpression.getBaseExpression() != getStatement().getBuilder()) {
((Collection)getResult()).remove(dataExpression.getAliasedField().getTable());
}
}
}
}
public boolean shouldIterateOverSubSelects() {
return true;
}
};
expIterator.setStatement(selectStatement);
expIterator.setResult(aliasTables);
expIterator.iterateOn(selectStatement.getWhereClause());
if(aliasTables.size() == 1) {
aliasTable = (DatabaseTable)aliasTables.iterator().next();
return aliasTable.getQualifiedName();
} else if(aliasTables.isEmpty()) {
// should never happen
return aliasTable.getQualifiedName();
} else {
// should never happen
aliasTable = (DatabaseTable)aliasTables.iterator().next();
return aliasTable.getQualifiedName();
}
}
/**
* Used by DeleteAllQuery to create DeleteStatement in a simple case
* when selectionCriteria==null.
*/
protected SQLDeleteStatement buildDeleteStatementForDeleteAllQuery(DatabaseTable table) {
return buildDeleteStatementForDeleteAllQuery(table, null);
}
/**
* Used by DeleteAllQuery to create DeleteStatement in a simple case
* when selectionCriteria==null.
*/
protected SQLDeleteStatement buildDeleteStatementForDeleteAllQuery(DatabaseTable table, Expression inheritanceExpression) {
SQLDeleteStatement deleteStatement = new SQLDeleteStatement();
if(inheritanceExpression != null) {
deleteStatement.setWhereClause((Expression)inheritanceExpression.clone());
}
deleteStatement.setTable(table);
deleteStatement.setTranslationRow(getTranslationRow());
return deleteStatement;
}
/**
* Return the appropriate delete statement
*/
protected SQLDeleteStatement buildDeleteStatement(DatabaseTable table) {
SQLDeleteStatement deleteStatement = new SQLDeleteStatement();
Expression whereClause;
whereClause = getDescriptor().getObjectBuilder().buildDeleteExpression(table, getTranslationRow());
deleteStatement.setWhereClause(whereClause);
deleteStatement.setTable(table);
deleteStatement.setTranslationRow(getTranslationRow());
return deleteStatement;
}
/**
* Return the appropriate insert statement
*/
protected SQLInsertStatement buildInsertStatement(DatabaseTable table) {
SQLInsertStatement insertStatement = new SQLInsertStatement();
insertStatement.setTable(table);
insertStatement.setModifyRow(getModifyRow());
return insertStatement;
}
/**
* Return the appropriate select statement containing the fields in the table.
*/
protected SQLSelectStatement buildNormalSelectStatement() {
// From bug 2612185 Remember the identity hashtable used in cloning the selection criteria even in the normal case
// for performance, in case subqueries need it, or for order by expressions.
// 2612538 - the default size of IdentityHashtable (32) is appropriate
IdentityHashtable clonedExpressions = new IdentityHashtable();
SQLSelectStatement selectStatement = buildBaseSelectStatement(false, clonedExpressions);
// Case, normal read for branch inheritence class that reads subclasses all in its own table(s).
if (getDescriptor().hasInheritance()) {
getDescriptor().getInheritancePolicy().appendWithAllSubclassesExpression(selectStatement);
}
selectStatement.setFields(getSelectionFields(selectStatement, true));
selectStatement.setNonSelectFields(getNonSelectionFields());
selectStatement.normalize(getSession(), getDescriptor(), clonedExpressions);
// Allow for joining indexes to be computed to ensure distinct rows
((ObjectLevelReadQuery)getQuery()).getJoinedAttributeManager().computeJoiningMappingIndexes(true, getSession(),0);
return selectStatement;
}
/**
* Return the appropriate select statement containing the fields in the table.
* Similar to super except the buildBaseSelectStatement will look after setting
* the fields to select.
*/
protected SQLSelectStatement buildReportQuerySelectStatement(boolean isSubSelect) {
return buildReportQuerySelectStatement(isSubSelect, false, null);
}
/**
* Customary inheritance expression is required for DeleteAllQuery and UpdateAllQuery preparation.
*/
protected SQLSelectStatement buildReportQuerySelectStatement(boolean isSubSelect, boolean useCustomaryInheritanceExpression, Expression inheritanceExpression) {
// For bug 2612185: Need to know which original bases were mapped to which cloned bases.
// Note: subSelects are already cloned so this table is not needed.
// 2612538 - the default size of IdentityHashtable (32) is appropriate
IdentityHashtable clonedExpressions = isSubSelect ? null : new IdentityHashtable();
SQLSelectStatement selectStatement = buildBaseSelectStatement(isSubSelect, clonedExpressions);
selectStatement.setGroupByExpressions(((ReportQuery)getQuery()).getGroupByExpressions());
selectStatement.setHavingExpression(((ReportQuery)getQuery()).getHavingExpression());
if (getDescriptor().hasInheritance()) {
if(useCustomaryInheritanceExpression) {
if(inheritanceExpression != null) {
if (selectStatement.getWhereClause() == null) {
selectStatement.setWhereClause((Expression)inheritanceExpression.clone());
} else {
selectStatement.setWhereClause(selectStatement.getWhereClause().and(inheritanceExpression));
}
}
} else {
getDescriptor().getInheritancePolicy().appendWithAllSubclassesExpression(selectStatement);
}
}
Vector fieldExpressions = ((ReportQuery)getQuery()).getQueryExpressions();
int itemOffset = fieldExpressions.size();
for (Iterator items = ((ReportQuery)getQuery()).getItems().iterator(); items.hasNext();){
ReportItem item = (ReportItem) items.next();
if(item.isContructorItem()){
ConstructorReportItem citem= (ConstructorReportItem)item;
List reportItems = citem.getReportItems();
int size = reportItems.size();
for(int i=0;i 1;
SQLSelectStatement selectStatementForNotExist = null;
SQLCall selectCallForNotExist = null;
// inheritanceExpression is always null in a nested method call.
Expression inheritanceExpression = null;
if(tablesToIgnore == null) {
// It's original (not a nested) method call.
if(hasInheritance) {
if(getDescriptor().getInheritancePolicy().shouldReadSubclasses()) {
inheritanceExpression = getDescriptor().getInheritancePolicy().getWithAllSubclassesExpression();
} else {
inheritanceExpression = getDescriptor().getInheritancePolicy().getOnlyInstancesExpression();
}
}
}
SQLSelectStatement selectStatementForExist = createSQLSelectStatementForModifyAll(whereClause);
// Main Case: Descriptor is mapped to more than one table and/or the query references other tables
boolean isMainCase = selectStatementForExist.requiresAliases();
if(isMainCase) {
if(whereClause != null) {
if(getSession().getPlatform().shouldAlwaysUseTempStorageForModifyAll() && tablesToIgnore == null) {
// currently DeleteAll using Oracle anonymous block is not implemented
if(!getSession().getPlatform().isOracle()) {
prepareDeleteAllUsingTempStorage();
return;
}
}
if(isSelectCallForNotExistRequired) {
selectStatementForNotExist = createSQLSelectStatementForModifyAll(null, null);
selectCallForNotExist = (SQLCall)selectStatementForNotExist.buildCall(getSession());
}
} else {
//whereClause = null
if(getSession().getPlatform().shouldAlwaysUseTempStorageForModifyAll() && tablesToIgnore == null) {
// currently DeleteAll using Oracle anonymous block is not implemented
if(!getSession().getPlatform().isOracle()) {
// the only case to handle without temp storage is inheritance root without inheritanceExpression:
// in this case all generated delete calls will have no where clauses.
if(hasInheritance && !(inheritanceExpression == null && getDescriptor().getInheritancePolicy().isRootParentDescriptor())) {
prepareDeleteAllUsingTempStorage();
return;
}
}
}
}
} else {
// simple case: Descriptor is mapped to a single table and the query references no other tables.
if(whereClause != null) {
if(getSession().getPlatform().shouldAlwaysUseTempStorageForModifyAll() && tablesToIgnore == null) {
// currently DeleteAll using Oracle anonymous block is not implemented
if(!getSession().getPlatform().isOracle()) {
// if there are derived classes with additional tables - use temporary storage
if(hasInheritance && getDescriptor().getInheritancePolicy().hasMultipleTableChild()) {
prepareDeleteAllUsingTempStorage();
return;
}
}
}
}
}
// Don't use selectCallForExist in case there is no whereClause -
// a simpler sql will be created if possible.
if(whereClause != null) {
selectCallForExist = (SQLCall)selectStatementForExist.buildCall(getSession());
}
if(isMainCase) {
// Main case: Descriptor is mapped to more than one table and/or the query references other tables
//
// Add and prepare to a call a delete statement for each table.
// In the case of multiple tables, build the sql statements Vector in insert order. When the
// actual SQL calls are sent they are sent in the reverse of this order.
for (Enumeration tablesEnum = tablesInInsertOrder.elements(); tablesEnum.hasMoreElements();) {
DatabaseTable table = (DatabaseTable)tablesEnum.nextElement();
Collection primaryKeyFields = getPrimaryKeyFieldsForTable(table);
SQLDeleteStatement deleteStatement;
// In Employee example, query with reference class:
// Employee will build "EXISTS" for SALARY and "NOT EXISTS" for EMPLOYEE;
// LargeProject will build "EXISTS" for LPROJECT and "NOT EXISTS" for Project.
// The situation is a bit more complex if more than two levels of inheritance is involved:
// both "EXISTS" and "NOT EXISTS" used for the "intermediate" (not first and not last) tables.
if(!isSelectCallForNotExistRequired) {
// isSelectCallForNotExistRequired == false:
// either tablesToIgnore != null: it's a nested method call.
// Example:
// In Employee example, query with reference class
// Project will get here to handle LPROJECT table
// or tablesInInsertOrder.size() == 1: there is only one table,
// but there is joining to at least one other table (otherwise would've been isMainCase==false).
//
// Note that buildDeleteAllStatement ignores inheritanceExpression if selectCallForExist!=null.
deleteStatement = buildDeleteAllStatement(table, inheritanceExpression, selectCallForExist, selectStatementForExist, null, null, primaryKeyFields);
} else {
// isSelectCallForNotExistRequired==true: original call, multiple tables.
// indicates whether the table is the last in insertion order
boolean isLastTable = table.equals((DatabaseTable)tablesInInsertOrder.lastElement());
if(inheritanceExpression == null) {
if(isLastTable) {
// In Employee example, query with reference class Employee calls this for SALARY table;
deleteStatement = buildDeleteAllStatement(table, null, selectCallForExist, selectStatementForExist, null, null, primaryKeyFields);
} else {
// In Employee example, query with reference class Employee calls this for EMPLOYEE table
deleteStatement = buildDeleteAllStatement(table, null, null, null, selectCallForNotExist, selectStatementForNotExist, primaryKeyFields);
}
} else {
// there is inheritance
if(table.equals(getDescriptor().getMultipleTableInsertOrder().firstElement())) {
// This is the highest table in inheritance hierarchy - the one that contains conditions
// (usually class indicator fields) that defines the class identity.
// inheritanceExpression is for this table (it doesn't reference any other tables).
// In Employee example, query with reference class LargeProject calls this for PROJECT table
deleteStatement = buildDeleteAllStatement(table, inheritanceExpression, null, null, selectCallForNotExist, selectStatementForNotExist, primaryKeyFields);
} else {
ClassDescriptor desc = getHighestDescriptorMappingTable(table);
if(desc == getDescriptor()) {
if(isLastTable) {
// In Employee example, query with reference class LargeProject calls this for LPROJECT table;
deleteStatement = buildDeleteAllStatement(table, null, selectCallForExist, selectStatementForExist, null, null, primaryKeyFields);
} else {
// Class has multiple tables that are not inherited.
// In extended Employee example:
// Employee2 class inherits from Employee and
// mapped to two additional tables: EMPLOYEE2 and SALARY2.
// Query with reference class Employee2 calls this for EMPLOYEE2 table.
deleteStatement = buildDeleteAllStatement(table, null, null, null, selectCallForNotExist, selectStatementForNotExist, primaryKeyFields);
}
} else {
// This table is mapped through descriptor that stands higher in inheritance hierarchy
// (but not the highest one - this is taken care in another case).
//
// inheritanceSelectStatementForExist is created for the higher descriptor,
// but the inheritance expression from the current descriptor is used.
// Note that this trick doesn't work in case the higher descriptor was defined with
// inheritance policy set not to read subclasses
// (descriptor.getInheritancePolicy().dontReadSubclassesOnQueries()).
// In that case inheritance expression for the higher descriptor can't
// be removed - it still appears in the sql and collides with the inheritance
// expression from the current descriptor - the selection expression is never true.
//
// In extended Employee example:
// VeryLargeProject inherits from LargeProject,
// mapped to an additional table VLPROJECT;
// VeryVeryLargeProject inherits from VeryLargeProject,
// mapped to the same tables as it's parent.
//
// Note that this doesn't work in case LargeProject descriptor was set not to read subclasses:
// in that case the selection expression will have (PROJ_TYPE = 'L') AND (PROJ_TYPE = 'V')
//
SQLSelectStatement inheritanceSelectStatementForExist = createSQLSelectStatementForModifyAll(null, inheritanceExpression, desc);
SQLCall inheritanceSelectCallForExist = (SQLCall)inheritanceSelectStatementForExist.buildCall(getSession());
if(isLastTable) {
// In extended Employee example:
// Query with reference class VeryVeryLargeProject calls this for VLPROJECT table.
deleteStatement = buildDeleteAllStatement(table, null, inheritanceSelectCallForExist, inheritanceSelectStatementForExist, null, null, primaryKeyFields);
} else {
// In extended Employee example:
// Query with reference class VeryLargeProject calls this for LPROJECT table.
// Note that both EXISTS and NOT EXISTS clauses created.
deleteStatement = buildDeleteAllStatement(table, null, inheritanceSelectCallForExist, inheritanceSelectStatementForExist, selectCallForNotExist, selectStatementForNotExist, primaryKeyFields);
}
}
}
}
}
if (getDescriptor().getTables().size() > 1) {
getSQLStatements().addElement(deleteStatement);
} else {
setSQLStatement(deleteStatement);
}
}
} else {
// A simple case:
// there is only one table mapped to the descriptor, and
// selection criteria doesn't reference any other tables
// A simple sql call with no subselect should be built.
// In Employee example, query with reference class:
// Project will build a simple sql call for PROJECT(and will make nested method calls for LargeProject and SmallProject);
// SmallProject will build a simple sql call for PROJECT
setSQLStatement(buildDeleteAllStatement(getDescriptor().getDefaultTable(), inheritanceExpression, selectCallForExist, selectStatementForExist, null, null, null));
}
if(selectCallForExist == null) {
// Getting there means there is no whereClause.
// To handle the mappings selectCallForExist may be required in this case, too.
if(hasInheritance && (tablesToIgnore != null || inheritanceExpression != null)) {
// The only case NOT to create the call for no whereClause is either no inheritance,
// or it's an original (not a nested) method call and there is no inheritance expression.
// In Employee example:
// query with reference class Project and no where clause for m-to-m mapping generates:
// DELETE FROM EMP_PROJ;
// as opposed to query with reference class SmallProject:
// DELETE FROM EMP_PROJ WHERE EXISTS(SELECT PROJ_ID FROM PROJECT WHERE (PROJ_TYPE = ?) AND PROJ_ID = EMP_PROJ.PROJ_ID).
//
selectCallForExist = (SQLCall)selectStatementForExist.buildCall(getSession());
}
}
// Add statements for ManyToMany and DirectCollection mappings
Vector deleteStatementsForMappings = buildDeleteAllStatementsForMappings(selectCallForExist, selectStatementForExist, tablesToIgnore == null);
if(!deleteStatementsForMappings.isEmpty()) {
if(getSQLStatement() != null) {
getSQLStatements().add(getSQLStatement());
setSQLStatement(null);
}
getSQLStatements().addAll(deleteStatementsForMappings);
}
}
// Indicates whether the descriptor has children using extra tables.
boolean hasChildrenWithExtraTables = hasInheritance && getDescriptor().getInheritancePolicy().hasChildren() && getDescriptor().getInheritancePolicy().hasMultipleTableChild();
// TBD: should we ignore subclasses in case descriptor doesn't want us to read them in?
//** Currently in this code we do ignore.
//** If it will be decided that we need to handle children in all cases
//** the following statement should be changed to: boolean shouldHandleChildren = hasChildrenWithExtraTables;
boolean shouldHandleChildren = hasChildrenWithExtraTables && getDescriptor().getInheritancePolicy().shouldReadSubclasses();
// Perform a nested method call for each child
if(shouldHandleChildren) {
// In Employee example: query for Project will make nested calls to
// LargeProject and SmallProject and ask them to ignore PROJECT table
Vector tablesToIgnoreForChildren = new Vector();
// The tables this descriptor has ignored, its children also should ignore.
if(tablesToIgnore != null) {
tablesToIgnoreForChildren.addAll(tablesToIgnore);
}
// If the desctiptor reads subclasses there is no need for
// subclasses to process its tables for the second time.
if (getDescriptor().getInheritancePolicy().shouldReadSubclasses()) {
tablesToIgnoreForChildren.addAll(tablesInInsertOrder);
}
Iterator it = getDescriptor().getInheritancePolicy().getChildDescriptors().iterator();
while(it.hasNext()) {
// Define the same query for the child
ClassDescriptor childDescriptor = (ClassDescriptor)it.next();
// Need to process only "multiple tables" child descriptors
if ((childDescriptor.getTables().size() > getDescriptor().getTables().size()) ||
(childDescriptor.getInheritancePolicy().hasMultipleTableChild()))
{
DeleteAllQuery childQuery = new DeleteAllQuery();
childQuery.setReferenceClass(childDescriptor.getJavaClass());
childQuery.setSelectionCriteria(getSelectionCriteria());
childQuery.setDescriptor(childDescriptor);
childQuery.setSession(getSession());
ExpressionQueryMechanism childMechanism = (ExpressionQueryMechanism)childQuery.getQueryMechanism();
// nested call
childMechanism.prepareDeleteAll(tablesToIgnoreForChildren);
// Copy the statements from child query mechanism.
// In Employee example query for Project will pick up a statement for
// LPROJECT table from LargeProject and nothing from SmallProject.
Vector childStatements = new Vector();
if(childMechanism.getCall() != null) {
childStatements.add(childMechanism.getSQLStatement());
} else if(childMechanism.getSQLStatements() != null) {
childStatements.addAll(childMechanism.getSQLStatements());
}
if(!childStatements.isEmpty()) {
if(getSQLStatement() != null) {
getSQLStatements().add(getSQLStatement());
setSQLStatement(null);
}
getSQLStatements().addAll(childStatements);
}
}
}
}
// Nested method call doesn't need to call this.
if(tablesToIgnore == null) {
((DeleteAllQuery)getQuery()).setIsPreparedUsingTempStorage(false);
super.prepareDeleteAll();
}
}
protected void prepareDeleteAllUsingTempStorage() {
if(getSession().getPlatform().supportsTempTables()) {
prepareDeleteAllUsingTempTables();
} else {
throw QueryException.tempTablesNotSupported(getQuery(), Helper.getShortClassName(getSession().getPlatform()));
}
}
protected void prepareDeleteAllUsingTempTables() {
getSQLStatements().addAll(buildStatementsForDeleteAllForTempTables());
((DeleteAllQuery)getQuery()).setIsPreparedUsingTempStorage(true);
super.prepareDeleteAll();
}
/**
* Create SQLDeleteAllStatements for mappings that may be responsible for references
* to the objects to be deleted
* in the tables NOT mapped to any class: ManyToManyMapping and DirectCollectionMapping
*
* NOTE: A similar pattern also used in method buildDeleteAllStatementsForMappingsWithTempTable():
* if you are updating this method consider applying a similar update to that method as well.
*
* @return Vector
*/
protected Vector buildDeleteAllStatementsForMappings(SQLCall selectCallForExist, SQLSelectStatement selectStatementForExist, boolean dontCheckDescriptor) {
Vector deleteStatements = new Vector();
Iterator itMappings = getDescriptor().getMappings().iterator();
while(itMappings.hasNext()) {
DatabaseMapping mapping = (DatabaseMapping)itMappings.next();
if(mapping.isManyToManyMapping() || mapping.isDirectCollectionMapping()) {
if(dontCheckDescriptor || mapping.getDescriptor().equals(getDescriptor())) {
Vector sourceFields = null;
Vector targetFields = null;
if(mapping.isManyToManyMapping()) {
sourceFields = ((ManyToManyMapping)mapping).getSourceKeyFields();
targetFields = ((ManyToManyMapping)mapping).getSourceRelationKeyFields();
} else if(mapping.isDirectCollectionMapping()) {
sourceFields = ((DirectCollectionMapping)mapping).getSourceKeyFields();
targetFields = ((DirectCollectionMapping)mapping).getReferenceKeyFields();
}
deleteStatements.addElement(buildDeleteAllStatementForMapping(selectCallForExist, selectStatementForExist, sourceFields, targetFields));
}
}
}
return deleteStatements;
}
/**
* Build delete statements with temporary table for ManyToMany and DirectCollection mappings.
*
* NOTE: A similar pattern also used in method buildDeleteAllStatementsForMappings():
* if you are updating this method consider applying a similar update to that method as well.
*
* @return Vector
*/
protected Vector buildDeleteAllStatementsForMappingsWithTempTable(ClassDescriptor descriptor, DatabaseTable rootTable, Collection rootTablePrimaryKeyFields, boolean dontCheckDescriptor) {
Vector deleteStatements = new Vector();
Iterator itMappings = descriptor.getMappings().iterator();
while(itMappings.hasNext()) {
DatabaseMapping mapping = (DatabaseMapping)itMappings.next();
if(mapping.isManyToManyMapping() || mapping.isDirectCollectionMapping()) {
if(dontCheckDescriptor || mapping.getDescriptor().equals(descriptor)) {
Vector sourceFields = null;
Vector targetFields = null;
if(mapping.isManyToManyMapping()) {
sourceFields = ((ManyToManyMapping)mapping).getSourceKeyFields();
targetFields = ((ManyToManyMapping)mapping).getSourceRelationKeyFields();
} else if(mapping.isDirectCollectionMapping()) {
sourceFields = ((DirectCollectionMapping)mapping).getSourceKeyFields();
targetFields = ((DirectCollectionMapping)mapping).getReferenceKeyFields();
}
DatabaseTable targetTable = ((DatabaseField)targetFields.firstElement()).getTable();
SQLDeleteAllStatementForTempTable deleteStatement
= buildDeleteAllStatementForTempTable(rootTable, rootTablePrimaryKeyFields, targetTable, targetFields);
deleteStatements.addElement(deleteStatement);
}
}
}
return deleteStatements;
}
protected SQLSelectStatement createSQLSelectStatementForModifyAll(Expression whereClause) {
return createSQLSelectStatementForModifyAll(whereClause, null, getDescriptor(), false);
}
protected SQLSelectStatement createSQLSelectStatementForModifyAll(Expression whereClause, Expression inheritanceExpression) {
return createSQLSelectStatementForModifyAll(whereClause, inheritanceExpression, getDescriptor(), true);
}
protected SQLSelectStatement createSQLSelectStatementForModifyAll(Expression whereClause, Expression inheritanceExpression,
ClassDescriptor desc)
{
return createSQLSelectStatementForModifyAll(whereClause, inheritanceExpression, desc, true);
}
protected SQLSelectStatement createSQLSelectStatementForModifyAll(Expression whereClause, Expression inheritanceExpression,
ClassDescriptor desc, boolean useCustomaryInheritanceExpression)
{
ExpressionBuilder builder;
if(whereClause != null) {
whereClause = (Expression)whereClause.clone();
builder = whereClause.getBuilder();
} else {
builder = new ExpressionBuilder();
}
ReportQuery reportQuery = new ReportQuery(desc.getJavaClass(), builder);
reportQuery.setDescriptor(desc);
reportQuery.setShouldRetrieveFirstPrimaryKey(true);
reportQuery.setSelectionCriteria(whereClause);
reportQuery.setSession(getSession());
return ((ExpressionQueryMechanism)reportQuery.getQueryMechanism()).buildReportQuerySelectStatement(false, useCustomaryInheritanceExpression, inheritanceExpression);
}
protected SQLSelectStatement createSQLSelectStatementForAssignedExpressionForUpdateAll(Expression value)
{
ReportQuery reportQuery = new ReportQuery(getQuery().getReferenceClass(), value.getBuilder());
reportQuery.setDescriptor(getQuery().getDescriptor());
reportQuery.setSession(getSession());
reportQuery.addAttribute("", value);
return ((ExpressionQueryMechanism)reportQuery.getQueryMechanism()).buildReportQuerySelectStatement(false);
}
/**
* This method return the clones of the given expressions.
*
* @param originalExpressions
* @param clonedExpressions
* @return Vector
*/
private Vector cloneExpressions(Vector originalExpressions,Dictionary clonedExpressions){
if(originalExpressions==null || originalExpressions.size()==0){
return originalExpressions;
}
Vector newExpressions = new Vector(originalExpressions.size());
Iterator i = originalExpressions.iterator();
while (i.hasNext()){
Expression e = (Expression)i.next();
newExpressions.add(e.copiedVersionFrom(clonedExpressions));
}
return newExpressions;
}
/**
* Pre-build the SQL statement from the expression.
*/
public void prepareDeleteObject() {
// Add and prepare to a call a delete statement for each table.
// In the case of multiple tables, build the sql statements Vector in insert order. When the
// actual SQL calls are sent they are sent in the reverse of this order.
for (Enumeration tablesEnum = getDescriptor().getMultipleTableInsertOrder().elements();
tablesEnum.hasMoreElements();) {
DatabaseTable table = (DatabaseTable)tablesEnum.nextElement();
SQLDeleteStatement deleteStatement = buildDeleteStatement(table);
if (getDescriptor().getTables().size() > 1) {
getSQLStatements().addElement(deleteStatement);
} else {
setSQLStatement(deleteStatement);
}
}
super.prepareDeleteObject();
}
/**
* Pre-build the SQL statement from the expression.
*/
public void prepareDoesExist(DatabaseField field) {
setSQLStatement(buildSelectStatementForDoesExist(field));
super.prepareDoesExist(field);
}
/**
* Pre-build the SQL statement from the expression.
*/
public void prepareInsertObject() {
// Require modify row to prepare.
if (getModifyRow() == null) {
return;
}
// Add and prepare to a call a update statement for each table.
// In the case of multiple tables, build the sql statements Vector in insert order.
for (Enumeration tablesEnum = getDescriptor().getMultipleTableInsertOrder().elements();
tablesEnum.hasMoreElements();) {
DatabaseTable table = (DatabaseTable)tablesEnum.nextElement();
SQLInsertStatement insertStatement = buildInsertStatement(table);
if (getDescriptor().getTables().size() > 1) {
getSQLStatements().addElement(insertStatement);
} else {
setSQLStatement(insertStatement);
}
}
super.prepareInsertObject();
}
/**
* Pre-build the SQL statement from the expression.
*/
public void prepareReportQuerySelectAllRows() {
SQLSelectStatement statement = buildReportQuerySelectStatement(false);
setSQLStatement(statement);
setCallFromStatement();
// The statement is no longer require so can be released.
setSQLStatement(null);
getCall().returnManyRows();
prepareCall();
}
/**
* Pre-build the SQL statement from the expression.
* This is used for subselects, so does not normalize or generate the SQL as it needs the outer expression for this.
*/
public void prepareReportQuerySubSelect() {
setSQLStatement(buildReportQuerySelectStatement(true));
// The expression is no longer require so can be released.
setSelectionCriteria(null);
}
/**
* Pre-build the SQL statement from the expression.
*/
public void prepareSelectAllRows() {
if (getDescriptor().hasInheritance() && getDescriptor().getInheritancePolicy().requiresMultipleTableSubclassRead()) {
if (getDescriptor().getInheritancePolicy().hasView()) {
// CR#3158703 if the descriptor has a view, then it requires a single select,
// so can be prepared.
setSQLStatement(getDescriptor().getInheritancePolicy().buildViewSelectStatement((ObjectLevelReadQuery)getQuery()));
super.prepareSelectAllRows();
} else if (!getDescriptor().getInheritancePolicy().hasClassExtractor()) {
// CR#3158703 otherwise if using a type indicator at least the type select can be prepared.
setSQLStatement(getDescriptor().getInheritancePolicy().buildClassIndicatorSelectStatement((ObjectLevelReadQuery)getQuery()));
super.prepareSelectAllRows();
}
// else - otherwise cannot prepare the select.
} else {
setSQLStatement(buildNormalSelectStatement());
super.prepareSelectAllRows();
}
}
/**
* Pre-build the SQL statement from the expression.
*/
public void prepareSelectOneRow() {
if (getDescriptor().hasInheritance() && getDescriptor().getInheritancePolicy().requiresMultipleTableSubclassRead()) {
if (getDescriptor().getInheritancePolicy().hasView()) {
// CR#3158703 if the descriptor has a view, then it requires a single select,
// so can be prepared.
setSQLStatement(getDescriptor().getInheritancePolicy().buildViewSelectStatement((ObjectLevelReadQuery)getQuery()));
super.prepareSelectOneRow();
} else if (!getDescriptor().getInheritancePolicy().hasClassExtractor()) {
// CR#3158703 otherwise if using a type indicator at least the type select can be prepared.
setSQLStatement(getDescriptor().getInheritancePolicy().buildClassIndicatorSelectStatement((ObjectLevelReadQuery)getQuery()));
super.prepareSelectOneRow();
}
// else - otherwise cannot prepare the select.
} else {
setSQLStatement(buildNormalSelectStatement());
super.prepareSelectOneRow();
}
}
/**
* Pre-build the SQL statement from the expression.
*/
public void prepareUpdateObject() {
// Require modify row to prepare.
if (getModifyRow() == null) {
return;
}
// Add and prepare to a call a update statement for each table.
int tablesSize = getDescriptor().getTables().size();
for (int index = 0; index < tablesSize; index++) {
DatabaseTable table = (DatabaseTable)getDescriptor().getTables().get(index);
SQLUpdateStatement updateStatement = buildUpdateStatement(table);
if (tablesSize > 1) {
getSQLStatements().addElement(updateStatement);
} else {
setSQLStatement(updateStatement);
}
}
super.prepareUpdateObject();
}
/**
* Pre-build the SQL statement from the expressions.
*/
public void prepareUpdateAll() {
ExpressionBuilder builder = ((UpdateAllQuery)getQuery()).getExpressionBuilder();
HashMap updateClauses = ((UpdateAllQuery)getQuery()).getUpdateClauses();
// Add a statement to update the optimistic locking field if their is one.
OptimisticLockingPolicy policy = getDescriptor().getOptimisticLockingPolicy();
if (policy != null) {
if(policy.getWriteLockField() != null) {
Expression writeLock = builder.getField(policy.getWriteLockField());
Expression writeLockUpdateExpression = policy.getWriteLockUpdateExpression(builder);
if (writeLockUpdateExpression != null) {
// clone it to keep user's original data intact
updateClauses = (HashMap)updateClauses.clone();
updateClauses.put(writeLock, writeLockUpdateExpression);
}
}
}
HashMap tables_databaseFieldsToValues = new HashMap();
HashMap tablesToPrimaryKeyFields = new HashMap();
Iterator it = updateClauses.entrySet().iterator();
while(it.hasNext()) {
Map.Entry entry = (Map.Entry)it.next();
Object fieldObject = entry.getKey();
DataExpression fieldExpression = null;
Expression baseExpression = null; // QueryKeyExpression or FieldExpression of the field
String attributeName = null;
if(fieldObject instanceof String) {
attributeName = (String)fieldObject;
} else {
// it should be either QueryKeyExpression or FieldExpression
fieldExpression = (DataExpression)fieldObject;
}
DatabaseField field = null;
DatabaseMapping mapping = null;
if(attributeName != null) {
mapping = getDescriptor().getObjectBuilder().getMappingForAttributeName(attributeName);
if (mapping != null && !mapping.getFields().isEmpty()) {
field = (DatabaseField)mapping.getFields().firstElement();
}
if(field == null) {
throw QueryException.updateAllQueryAddUpdateDoesNotDefineField(getDescriptor(), getQuery(), attributeName);
}
baseExpression = ((UpdateAllQuery)getQuery()).getExpressionBuilder().get(attributeName);
} else if (fieldExpression != null) {
// it should be either QueryKeyExpression or ExpressionBuilder
if (fieldExpression.getBaseExpression() instanceof ExpressionBuilder) {
field = getDescriptor().getObjectBuilder().getFieldForQueryKeyName(fieldExpression.getName());
}
if(field == null) {
DataExpression fieldExpressionClone = (DataExpression)fieldExpression.clone();
fieldExpressionClone.getBuilder().setQueryClass(getQuery().getReferenceClass());
fieldExpressionClone.getBuilder().setSession(getSession().getRootSession(null));
field = fieldExpressionClone.getField();
if(field == null) {
throw QueryException.updateAllQueryAddUpdateDoesNotDefineField(getDescriptor(), getQuery(), fieldExpression.toString());
}
}
mapping = getDescriptor().getObjectBuilder().getMappingForField(field);
baseExpression = fieldExpression;
}
Object valueObject = entry.getValue();
Vector fields;
Vector values;
Vector baseExpressions;
if(mapping != null && mapping.isOneToOneMapping()) {
fields = mapping.getFields();
int fieldsSize = fields.size();
values = oracle.toplink.essentials.internal.helper.NonSynchronizedVector.newInstance(fieldsSize);
baseExpressions = oracle.toplink.essentials.internal.helper.NonSynchronizedVector.newInstance(fieldsSize);
for(int i=0; i=0; i--) {
if(beforeTables.elementAt(i).equals(firstTable)) {
beforeTables.remove(i);
afterTables.remove(i);
}
}
// Add firstTable to orderedTables
orderedTables.addElement(firstTable);
}
}
// now all the remaining ones - there are no dependencies between them
// so the order is arbitrary.
Iterator itTables = tables_databaseFieldsToValues.keySet().iterator();
while(itTables.hasNext()) {
DatabaseTable table = (DatabaseTable)itTables.next();
if(!orderedTables.contains(table)) {
orderedTables.add(table);
}
}
// finally create statements
for(int i=0; i < orderedTables.size(); i++) {
DatabaseTable table = (DatabaseTable)orderedTables.elementAt(i);
HashMap databaseFieldsToValues = (HashMap)tables_databaseFieldsToValues.get(table);
Collection primaryKeyFields = (Collection)tablesToPrimaryKeyFields.get(table);
getSQLStatements().addElement(buildUpdateAllStatement(table, databaseFieldsToValues, selectCallForExist, selectStatementForExist, primaryKeyFields));
}
}
((UpdateAllQuery)getQuery()).setIsPreparedUsingTempStorage(false);
super.prepareUpdateAll();
}
protected SQLSelectStatement createSQLSelectStatementForUpdateAllForOracleAnonymousBlock(HashMap tables_databaseFieldsToValues)
{
ExpressionBuilder builder = ((UpdateAllQuery)getQuery()).getExpressionBuilder();
Expression whereClause = getSelectionCriteria();
ReportQuery reportQuery = new ReportQuery(getDescriptor().getJavaClass(), builder);
reportQuery.setDescriptor(getDescriptor());
reportQuery.setSelectionCriteria(whereClause);
reportQuery.setSession(getSession());
reportQuery.setShouldRetrievePrimaryKeys(true);
Iterator itDatabaseFieldsToValues = tables_databaseFieldsToValues.values().iterator();
while(itDatabaseFieldsToValues.hasNext()) {
HashMap databaseFieldsToValues = (HashMap)itDatabaseFieldsToValues.next();
Iterator itValues = databaseFieldsToValues.values().iterator();
while(itValues.hasNext()) {
reportQuery.addAttribute("", (Expression)itValues.next());
}
}
return ((ExpressionQueryMechanism)reportQuery.getQueryMechanism()).buildReportQuerySelectStatement(false);
}
protected SQLSelectStatement createSQLSelectStatementForModifyAllForTempTable(HashMap databaseFieldsToValues)
{
ExpressionBuilder builder = ((ModifyAllQuery)getQuery()).getExpressionBuilder();
Expression whereClause = getSelectionCriteria();
ReportQuery reportQuery = new ReportQuery(getDescriptor().getJavaClass(), builder);
reportQuery.setDescriptor(getDescriptor());
reportQuery.setSelectionCriteria(whereClause);
reportQuery.setSession(getSession());
reportQuery.setShouldRetrievePrimaryKeys(true);
if(databaseFieldsToValues != null) {
Iterator itValues = databaseFieldsToValues.values().iterator();
while(itValues.hasNext()) {
reportQuery.addAttribute("", (Expression)itValues.next());
}
}
return ((ExpressionQueryMechanism)reportQuery.getQueryMechanism()).buildReportQuerySelectStatement(false);
}
protected SQLModifyStatement buildUpdateAllStatementForOracleAnonymousBlock(HashMap tables_databaseFieldsToValues, HashMap tablesToPrimaryKeyFields) {
SQLSelectStatement selectStatement = createSQLSelectStatementForUpdateAllForOracleAnonymousBlock(tables_databaseFieldsToValues);
SQLCall selectCall = (SQLCall)selectStatement.buildCall(getSession());
SQLUpdateAllStatementForOracleAnonymousBlock updateAllStatement = new SQLUpdateAllStatementForOracleAnonymousBlock();
updateAllStatement.setTranslationRow(getTranslationRow());
updateAllStatement.setSelectCall(selectCall);
updateAllStatement.setTables_databaseFieldsToValues(tables_databaseFieldsToValues);
updateAllStatement.setTablesToPrimaryKeyFields(tablesToPrimaryKeyFields);
updateAllStatement.setTable((DatabaseTable)getDescriptor().getTables().firstElement());
return updateAllStatement;
}
protected void prepareUpdateAllUsingTempStorage(HashMap tables_databaseFieldsToValues, HashMap tablesToPrimaryKeyFields) {
if(getSession().getPlatform().supportsTempTables()) {
prepareUpdateAllUsingTempTables(tables_databaseFieldsToValues, tablesToPrimaryKeyFields);
} else if(getSession().getPlatform().isOracle()) {
prepareUpdateAllUsingOracleAnonymousBlock(tables_databaseFieldsToValues, tablesToPrimaryKeyFields);
} else {
throw QueryException.tempTablesNotSupported(getQuery(), Helper.getShortClassName(getSession().getPlatform()));
}
}
/**
* Pre-build the SQL statement from the expressions.
*/
protected void prepareUpdateAllUsingOracleAnonymousBlock(HashMap tables_databaseFieldsToValues, HashMap tablesToPrimaryKeyFields) {
setSQLStatement(buildUpdateAllStatementForOracleAnonymousBlock(tables_databaseFieldsToValues, tablesToPrimaryKeyFields));
((UpdateAllQuery)getQuery()).setIsPreparedUsingTempStorage(true);
super.prepareUpdateAll();
}
/**
* Pre-build the SQL statement from the expressions.
*/
protected void prepareUpdateAllUsingTempTables(HashMap tables_databaseFieldsToValues, HashMap tablesToPrimaryKeyFields) {
int nTables = tables_databaseFieldsToValues.size();
Vector createTableStatements = oracle.toplink.essentials.internal.helper.NonSynchronizedVector.newInstance(nTables);
Vector selectStatements = oracle.toplink.essentials.internal.helper.NonSynchronizedVector.newInstance(nTables);
Vector updateStatements = oracle.toplink.essentials.internal.helper.NonSynchronizedVector.newInstance(nTables);
Vector cleanupStatements = oracle.toplink.essentials.internal.helper.NonSynchronizedVector.newInstance(nTables);
Iterator itEntrySets = tables_databaseFieldsToValues.entrySet().iterator();
while(itEntrySets.hasNext()) {
Map.Entry entry = (Map.Entry)itEntrySets.next();
DatabaseTable table = (DatabaseTable)entry.getKey();
HashMap databaseFieldsToValues = (HashMap)entry.getValue();
Collection primaryKeyFields = (Collection)tablesToPrimaryKeyFields.get(table);
Vector statementsForTable = buildStatementsForUpdateAllForTempTables(table, databaseFieldsToValues, primaryKeyFields);
createTableStatements.add(statementsForTable.elementAt(0));
selectStatements.add(statementsForTable.elementAt(1));
updateStatements.add(statementsForTable.elementAt(2));
cleanupStatements.add(statementsForTable.elementAt(3));
}
getSQLStatements().addAll(createTableStatements);
getSQLStatements().addAll(selectStatements);
getSQLStatements().addAll(updateStatements);
getSQLStatements().addAll(cleanupStatements);
if(getSession().getPlatform().dontBindUpdateAllQueryUsingTempTables()) {
if(getQuery().shouldBindAllParameters() || (getQuery().shouldIgnoreBindAllParameters() && getSession().getPlatform().shouldBindAllParameters())) {
getQuery().setShouldBindAllParameters(false);
getSession().warning("update_all_query_cannot_use_binding_on_this_platform", SessionLog.QUERY);
}
}
((UpdateAllQuery)getQuery()).setIsPreparedUsingTempStorage(true);
super.prepareUpdateAll();
}
/**
* Build SQLStatements for delete all using temporary table.
* @return Vector
*/
protected Vector buildStatementsForDeleteAllForTempTables() {
Vector statements = oracle.toplink.essentials.internal.helper.NonSynchronizedVector.newInstance();
// retrieve rootTable and its primary key fields for composing temporary table
DatabaseTable rootTable = (DatabaseTable)getDescriptor().getMultipleTableInsertOrder().firstElement();
Collection rootTablePrimaryKeyFields = getPrimaryKeyFieldsForTable(rootTable);
ClassDescriptor rootDescriptor = getDescriptor();
if(getDescriptor().hasInheritance()) {
rootDescriptor = rootDescriptor.getInheritancePolicy().getRootParentDescriptor();
}
Vector allFields = oracle.toplink.essentials.internal.helper.NonSynchronizedVector.newInstance();
Iterator it = rootDescriptor.getFields().iterator();
while(it.hasNext()) {
DatabaseField field = (DatabaseField)it.next();
if(rootTable.equals(field.getTable())) {
allFields.add(field);
}
}
// statements will be executed in reverse order
// statement for temporary table cleanup (Drop table or Delete from temp_table)
SQLDeleteAllStatementForTempTable cleanupStatement = new SQLDeleteAllStatementForTempTable();
cleanupStatement.setMode(SQLModifyAllStatementForTempTable.CLEANUP_TEMP_TABLE);
cleanupStatement.setTable(rootTable);
statements.addElement(cleanupStatement);
// delete statements using temporary table
Vector deleteStatements = buildDeleteAllStatementsForTempTable(getDescriptor(), rootTable, rootTablePrimaryKeyFields, null);
statements.addAll(deleteStatements);
// Insert statement populating temporary table with criteria
SQLSelectStatement selectStatement = createSQLSelectStatementForModifyAllForTempTable(null);
SQLCall selectCall = (SQLCall)selectStatement.buildCall(getSession());
SQLDeleteAllStatementForTempTable insertStatement = new SQLDeleteAllStatementForTempTable();
insertStatement.setMode(SQLModifyAllStatementForTempTable.INSERT_INTO_TEMP_TABLE);
insertStatement.setTable(rootTable);
insertStatement.setTranslationRow(getTranslationRow());
insertStatement.setSelectCall(selectCall);
insertStatement.setPrimaryKeyFields(rootTablePrimaryKeyFields);
statements.addElement(insertStatement);
// Create temporary table statement
SQLDeleteAllStatementForTempTable createTempTableStatement = new SQLDeleteAllStatementForTempTable();
createTempTableStatement.setMode(SQLModifyAllStatementForTempTable.CREATE_TEMP_TABLE);
createTempTableStatement.setTable(rootTable);
createTempTableStatement.setAllFields(allFields);
createTempTableStatement.setPrimaryKeyFields(rootTablePrimaryKeyFields);
statements.addElement(createTempTableStatement);
return statements;
}
/**
* Build delete all SQLStatements using temporary table.
* This is recursively called for multiple table child descriptors.
*
* NOTE: A similar pattern also used in method prepareDeleteAll():
* if you are updating this method consider applying a similar update to that method as well.
*
* @return Vector
*/
private Vector buildDeleteAllStatementsForTempTable(ClassDescriptor descriptor, DatabaseTable rootTable, Collection rootTablePrimaryKeyFields, Vector tablesToIgnore) {
Vector statements = oracle.toplink.essentials.internal.helper.NonSynchronizedVector.newInstance();
Vector tablesInInsertOrder;
if(tablesToIgnore == null) {
// It's original (not a nested) method call.
tablesInInsertOrder = descriptor.getMultipleTableInsertOrder();
} else {
// It's a nested method call: tableInInsertOrder filled with descriptor's tables (in insert order),
// the tables found in tablesToIgnore are thrown away -
// they have already been taken care of by the caller.
// In Employee example, query with reference class Project gets here
// to handle LPROJECT table; tablesToIgnore contains PROJECT table.
tablesInInsertOrder = new Vector(descriptor.getMultipleTableInsertOrder().size());
for (Iterator tablesEnum = descriptor.getMultipleTableInsertOrder().iterator();
tablesEnum.hasNext();) {
DatabaseTable table = (DatabaseTable)tablesEnum.next();
if(!tablesToIgnore.contains(table)) {
tablesInInsertOrder.addElement(table);
}
}
}
if(!tablesInInsertOrder.isEmpty()) {
Iterator itTables = tablesInInsertOrder.iterator();
while(itTables.hasNext()) {
DatabaseTable table = (DatabaseTable)itTables.next();
SQLDeleteAllStatementForTempTable deleteStatement
= buildDeleteAllStatementForTempTable(rootTable, rootTablePrimaryKeyFields, table, getPrimaryKeyFieldsForTable(descriptor, table));
statements.addElement(deleteStatement);
}
// Add statements for ManyToMany and DirectCollection mappings
Vector deleteStatementsForMappings
= buildDeleteAllStatementsForMappingsWithTempTable(descriptor, rootTable, rootTablePrimaryKeyFields, tablesToIgnore == null);
statements.addAll(deleteStatementsForMappings);
}
// Indicates whether the descriptor has children using extra tables.
boolean hasChildrenWithExtraTables = descriptor.hasInheritance() && descriptor.getInheritancePolicy().hasChildren() && descriptor.getInheritancePolicy().hasMultipleTableChild();
// TBD: should we ignore subclasses in case descriptor doesn't want us to read them in?
//** Currently in this code we do ignore.
//** If it will be decided that we need to handle children in all cases
//** the following statement should be changed to: boolean shouldHandleChildren = hasChildrenWithExtraTables;
boolean shouldHandleChildren = hasChildrenWithExtraTables && descriptor.getInheritancePolicy().shouldReadSubclasses();
// Perform a nested method call for each child
if(shouldHandleChildren) {
// In Employee example: query for Project will make nested calls to
// LargeProject and SmallProject and ask them to ignore PROJECT table
Vector tablesToIgnoreForChildren = new Vector();
// The tables this descriptor has ignored, its children also should ignore.
if(tablesToIgnore != null) {
tablesToIgnoreForChildren.addAll(tablesToIgnore);
}
// If the desctiptor reads subclasses there is no need for
// subclasses to process its tables for the second time.
if (descriptor.getInheritancePolicy().shouldReadSubclasses()) {
tablesToIgnoreForChildren.addAll(tablesInInsertOrder);
}
Iterator it = descriptor.getInheritancePolicy().getChildDescriptors().iterator();
while(it.hasNext()) {
ClassDescriptor childDescriptor = (ClassDescriptor)it.next();
// Need to process only "multiple tables" child descriptors
if ((childDescriptor.getTables().size() > descriptor.getTables().size()) ||
(childDescriptor.getInheritancePolicy().hasMultipleTableChild()))
{
//recursively build for child desciptors
Vector childStatements = buildDeleteAllStatementsForTempTable(childDescriptor, rootTable, rootTablePrimaryKeyFields, tablesToIgnoreForChildren);
statements.addAll(childStatements);
}
}
}
return statements;
}
/**
* Build SQL delete statement which delete from target table using temporary table.
* @return SQLDeleteAllStatementForTempTable
*/
private SQLDeleteAllStatementForTempTable buildDeleteAllStatementForTempTable(DatabaseTable rootTable, Collection rootTablePrimaryKeyFields, DatabaseTable targetTable, Collection targetTablePrimaryKeyFields) {
SQLDeleteAllStatementForTempTable deleteStatement = new SQLDeleteAllStatementForTempTable();
deleteStatement.setMode(SQLModifyAllStatementForTempTable.UPDATE_ORIGINAL_TABLE);
deleteStatement.setTable(rootTable);
deleteStatement.setPrimaryKeyFields(rootTablePrimaryKeyFields);
deleteStatement.setTargetTable(targetTable);
deleteStatement.setTargetPrimaryKeyFields(targetTablePrimaryKeyFields);
return deleteStatement;
}
protected Vector buildStatementsForUpdateAllForTempTables(DatabaseTable table, HashMap databaseFieldsToValues, Collection primaryKeyFields) {
Vector statements = oracle.toplink.essentials.internal.helper.NonSynchronizedVector.newInstance(4);
Vector allFields = oracle.toplink.essentials.internal.helper.NonSynchronizedVector.newInstance();
Iterator it = getDescriptor().getFields().iterator();
while(it.hasNext()) {
DatabaseField field = (DatabaseField)it.next();
if(table.equals(field.getTable())) {
allFields.add(field);
}
}
Collection assignedFields = databaseFieldsToValues.keySet();
HashMap databaseFieldsToValuesForInsert = databaseFieldsToValues;
Collection assignedFieldsForInsert = assignedFields;
// The platform doesn't allow nulls in select clause.
// Remove all the constant expressions with value null:
// can do that because all fields initialized to null when temp. table created.
if(!getSession().getPlatform().isNullAllowedInSelectClause()) {
databaseFieldsToValuesForInsert = new HashMap(databaseFieldsToValues.size());
Iterator itEntries = databaseFieldsToValues.entrySet().iterator();
while(itEntries.hasNext()) {
Map.Entry entry = (Map.Entry)itEntries.next();
if(entry.getValue() instanceof ConstantExpression) {
ConstantExpression constExp = (ConstantExpression)entry.getValue();
if(constExp.getValue() == null) {
continue;
}
}
databaseFieldsToValuesForInsert.put(entry.getKey(), entry.getValue());
}
assignedFieldsForInsert = databaseFieldsToValuesForInsert.keySet();
}
SQLUpdateAllStatementForTempTable createTempTableStatement = new SQLUpdateAllStatementForTempTable();
createTempTableStatement.setMode(SQLModifyAllStatementForTempTable.CREATE_TEMP_TABLE);
createTempTableStatement.setTable(table);
createTempTableStatement.setAllFields(allFields);
createTempTableStatement.setAssignedFields(assignedFields);
createTempTableStatement.setPrimaryKeyFields(primaryKeyFields);
statements.addElement(createTempTableStatement);
SQLSelectStatement selectStatement = createSQLSelectStatementForModifyAllForTempTable(databaseFieldsToValuesForInsert);
SQLCall selectCall = (SQLCall)selectStatement.buildCall(getSession());
SQLUpdateAllStatementForTempTable insertStatement = new SQLUpdateAllStatementForTempTable();
insertStatement.setMode(SQLModifyAllStatementForTempTable.INSERT_INTO_TEMP_TABLE);
insertStatement.setTable(table);
insertStatement.setTranslationRow(getTranslationRow());
insertStatement.setSelectCall(selectCall);
insertStatement.setAssignedFields(assignedFieldsForInsert);
insertStatement.setPrimaryKeyFields(primaryKeyFields);
statements.addElement(insertStatement);
SQLUpdateAllStatementForTempTable updateStatement = new SQLUpdateAllStatementForTempTable();
updateStatement.setMode(SQLModifyAllStatementForTempTable.UPDATE_ORIGINAL_TABLE);
updateStatement.setTable(table);
updateStatement.setTranslationRow(getTranslationRow());
updateStatement.setAssignedFields(assignedFields);
updateStatement.setPrimaryKeyFields(primaryKeyFields);
statements.addElement(updateStatement);
SQLUpdateAllStatementForTempTable cleanupStatement = new SQLUpdateAllStatementForTempTable();
cleanupStatement.setMode(SQLModifyAllStatementForTempTable.CLEANUP_TEMP_TABLE);
cleanupStatement.setTable(table);
statements.addElement(cleanupStatement);
return statements;
}
protected Collection getPrimaryKeyFieldsForTable(DatabaseTable table) {
return getPrimaryKeyFieldsForTable(getDescriptor(), table);
}
protected Collection getPrimaryKeyFieldsForTable(ClassDescriptor descriptor, DatabaseTable table) {
Collection primaryKeyFields;
if(table.equals(descriptor.getTables().firstElement())) {
primaryKeyFields = descriptor.getPrimaryKeyFields();
} else {
primaryKeyFields = ((Map)descriptor.getAdditionalTablePrimaryKeyFields().get(table)).values();
}
return primaryKeyFields;
}
/**
* INTERNAL
* Read all rows from the database. The code to retrieve the full inheritance hierarchy was removed.
*
* @return Vector containing the database rows.
* @exception DatabaseException - an error has occurred on the database.
*/
public Vector selectAllReportQueryRows() throws DatabaseException {
return selectAllRowsFromTable();
}
/**
* Read all rows from the database.
* @return Vector containing the database rows.
* @exception DatabaseException - an error has occurred on the database.
*/
public Vector selectAllRows() throws DatabaseException {
if (getDescriptor().hasInheritance() && getDescriptor().getInheritancePolicy().requiresMultipleTableSubclassRead() && (!getDescriptor().getInheritancePolicy().hasView())) {
return getDescriptor().getInheritancePolicy().selectAllRowUsingMultipleTableSubclassRead((ReadAllQuery)getQuery());
} else {
return selectAllRowsFromTable();
}
}
/**
* Read all rows from the database.
* This is used only from query mechanism on a abstract-multiple table read.
*/
public Vector selectAllRowsFromConcreteTable() throws DatabaseException {
setSQLStatement(buildConcreteSelectStatement());
// Must also build the call as mt reads are not pre-built.
super.prepareSelectAllRows();
return super.selectAllRows();
}
/**
* Read all rows from the database.
* @return Vector containing the database rows.
* @exception DatabaseException - an error has occurred on the database.
*/
public Vector selectAllRowsFromTable() throws DatabaseException {
return super.selectAllRows();
}
/**
* Read a single row from the database. Create an SQL statement object,
* use it to create an SQL command string, and delegate row building
* responsibility to the accessor.
*/
public AbstractRecord selectOneRow() throws DatabaseException {
if (getDescriptor().hasInheritance() && getDescriptor().getInheritancePolicy().requiresMultipleTableSubclassRead() && (!getDescriptor().getInheritancePolicy().hasView())) {
return getDescriptor().getInheritancePolicy().selectOneRowUsingMultipleTableSubclassRead((ReadObjectQuery)getQuery());
} else {
return selectOneRowFromTable();
}
}
/**
* Read a single row from the database.
* This is used from query mechanism during an abstract-multiple table read.
*/
public AbstractRecord selectOneRowFromConcreteTable() throws DatabaseException {
setSQLStatement(buildConcreteSelectStatement());
// Must also build the call as mt reads are not pre-built.
super.prepareSelectOneRow();
return super.selectOneRow();
}
/**
* Read a single row from the database. Create an SQL statement object,
* use it to create an SQL command string, and delegate row building
* responsibility to the accessor.
* @param fields - fields used to build database row
* @return row containing data
* @exception DatabaseException - an error has occurred on the database
*/
public AbstractRecord selectOneRowFromTable() throws DatabaseException {
return super.selectOneRow();
}
/**
* Set the selection criteria of the query.
*/
public void setSelectionCriteria(Expression expression) {
this.selectionCriteria = expression;
}
/**
* Pass to this method a table mapped by query's descriptor.
* Returns the highest descriptor in inheritance hierarchy that mapps this table.
*/
protected ClassDescriptor getHighestDescriptorMappingTable(DatabaseTable table) {
// find the highest descriptor in inheritance hierarchy mapped to the table
ClassDescriptor desc = getDescriptor();
ClassDescriptor parentDescriptor = getDescriptor().getInheritancePolicy().getParentDescriptor();
while(parentDescriptor != null && parentDescriptor.getTables().contains(table)) {
desc = parentDescriptor;
parentDescriptor = parentDescriptor.getInheritancePolicy().getParentDescriptor();
}
return desc;
}
}