oracle.toplink.essentials.queryframework.InsertObjectQuery 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.exceptions.*;
/**
* Purpose:
* Used for inserting new objects into the database.
*
*
Description:
* This class does not have much behavior.
* It inherits most of it's behavior from WriteObjectQuery
*
* @author Yvon Lavoie
* @since TOPLink/Java 1.0
*/
public class InsertObjectQuery extends WriteObjectQuery {
/**
* PUBLIC:
* Default constructor.
*/
public InsertObjectQuery() {
super();
}
/**
* PUBLIC:
* Create an insert query with the object being inserted.
*/
public InsertObjectQuery(Object objectToInsert) {
this();
setObject(objectToInsert);
}
/**
* PUBLIC:
* Create an insert query with the custom call.
*/
public InsertObjectQuery(Call call) {
this();
setCall(call);
}
/**
* INTERNAL:
* Perform an insert.
*/
public void executeCommit() throws DatabaseException {
// object will only be null if the transaction is being commited directly from a changeset
if (getObject() != null) {
// if the object is not null then it is more effecient to build the row from the
// object then the changeSet.
getQueryMechanism().insertObjectForWrite();
} else {
// has a changeSet so we must use it in the case that there is no object
getQueryMechanism().insertObjectForWriteWithChangeSet();
}
}
/**
* INTERNAL:
* Perform a shallow insert.
*/
public void executeShallowWrite() {
getQueryMechanism().shallowInsertObjectForWrite(getObject(), this, getSession().getCommitManager());
}
/**
* INTERNAL:
* Prepare the receiver for execution in a session.
*/
protected void prepare() {
super.prepare();
getQueryMechanism().prepareInsertObject();
}
/**
* PUBLIC:
* Return if this is an insert object query.
*/
public boolean isInsertObjectQuery() {
return true;
}
}