001: /*
002: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003: *
004: * // Copyright (c) 1998, 2007, Oracle. All rights reserved.
005: *
006: *
007: * The contents of this file are subject to the terms of either the GNU
008: * General Public License Version 2 only ("GPL") or the Common Development
009: * and Distribution License("CDDL") (collectively, the "License"). You
010: * may not use this file except in compliance with the License. You can obtain
011: * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
012: * or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
013: * language governing permissions and limitations under the License.
014: *
015: * When distributing the software, include this License Header Notice in each
016: * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
017: * Sun designates this particular file as subject to the "Classpath" exception
018: * as provided by Sun in the GPL Version 2 section of the License file that
019: * accompanied this code. If applicable, add the following below the License
020: * Header, with the fields enclosed by brackets [] replaced by your own
021: * identifying information: "Portions Copyrighted [year]
022: * [name of copyright owner]"
023: *
024: * Contributor(s):
025: *
026: * If you wish your version of this file to be governed by only the CDDL or
027: * only the GPL Version 2, indicate your decision by adding "[Contributor]
028: * elects to include this software in this distribution under the [CDDL or GPL
029: * Version 2] license." If you don't indicate a single choice of license, a
030: * recipient has the option to distribute your version of this file under
031: * either the CDDL, the GPL Version 2 or to extend the choice of license to
032: * its licensees as provided above. However, if you add GPL Version 2 code
033: * and therefore, elected the GPL Version 2 license, then the option applies
034: * only if the new code is made subject to such option by the copyright
035: * holder.
036: */
037: package oracle.toplink.essentials.queryframework;
038:
039: import oracle.toplink.essentials.internal.sessions.AbstractRecord;
040:
041: /**
042: * <p><b>Purpose</b>:
043: * Abstract class for all modify queries.
044: * Currently contains no behavoir.
045: *
046: * @author Yvon Lavoie
047: * @since TOPLink/Java 1.0
048: */
049: public abstract class ModifyQuery extends DatabaseQuery {
050: protected AbstractRecord modifyRow;
051:
052: // needed to allow the user to force SQL to database when batch writing is used. bug:4104613
053: protected boolean forceBatchStatementExecution = false;
054:
055: /**
056: * INTERNAL:
057: * Return the modify row
058: */
059: public AbstractRecord getModifyRow() {
060: return modifyRow;
061: }
062:
063: /**
064: * PUBLIC:
065: * Return if this is a modify query.
066: */
067: public boolean isModifyQuery() {
068: return true;
069: }
070:
071: /**
072: * INTERNAL:
073: * Set the modify row
074: */
075: public void setModifyRow(AbstractRecord row) {
076: modifyRow = row;
077: }
078:
079: /**
080: * PUBLIC:
081: * Allow setting this query to be the last statement added to a batch statement
082: * and ensure it is flushed on execution. Setting to true will cause the batch
083: * statement to be sent to the database. Default setting of false causes the batch
084: * statement execution to be delayed to allow additional statements to
085: * be added. Setting to true reduces the efficiency of batch writting.
086: *
087: * This has no effect if batch writing is not enabled.
088: */
089:
090: public void setForceBatchStatementExecution(boolean value) {
091: this .forceBatchStatementExecution = value;
092: }
093:
094: /**
095: * PUBLIC:
096: * Returns if this query has been set to flush on execution.
097: * @see #setForceBatchStatementExecution(boolean)
098: */
099:
100: public boolean forceBatchStatementExecution() {
101: return forceBatchStatementExecution;
102: }
103: }
|