oracle.toplink.essentials.queryframework.ModifyQuery 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.queryframework;
import oracle.toplink.essentials.internal.sessions.AbstractRecord;
/**
* Purpose:
* Abstract class for all modify queries.
* Currently contains no behavoir.
*
* @author Yvon Lavoie
* @since TOPLink/Java 1.0
*/
public abstract class ModifyQuery extends DatabaseQuery {
protected AbstractRecord modifyRow;
// needed to allow the user to force SQL to database when batch writing is used. bug:4104613
protected boolean forceBatchStatementExecution = false;
/**
* INTERNAL:
* Return the modify row
*/
public AbstractRecord getModifyRow() {
return modifyRow;
}
/**
* PUBLIC:
* Return if this is a modify query.
*/
public boolean isModifyQuery() {
return true;
}
/**
* INTERNAL:
* Set the modify row
*/
public void setModifyRow(AbstractRecord row) {
modifyRow = row;
}
/**
* PUBLIC:
* Allow setting this query to be the last statement added to a batch statement
* and ensure it is flushed on execution. Setting to true will cause the batch
* statement to be sent to the database. Default setting of false causes the batch
* statement execution to be delayed to allow additional statements to
* be added. Setting to true reduces the efficiency of batch writting.
*
* This has no effect if batch writing is not enabled.
*/
public void setForceBatchStatementExecution(boolean value) {
this.forceBatchStatementExecution = value;
}
/**
* PUBLIC:
* Returns if this query has been set to flush on execution.
* @see #setForceBatchStatementExecution(boolean)
*/
public boolean forceBatchStatementExecution() {
return forceBatchStatementExecution;
}
}