org.objectstyle.cayenne.access.trans.InsertTranslator Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of cayenne-nodeps
Cayenne Object Persistence Framework
There is a newer version: 1.2.4
/* ====================================================================
 * 
 * The ObjectStyle Group Software License, version 1.1
 * ObjectStyle Group - http://objectstyle.org/
 * 
 * Copyright (c) 2002-2005, Andrei (Andrus) Adamchik and individual authors
 * of the software. All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 * 
 * 3. The end-user documentation included with the redistribution, if any,
 *    must include the following acknowlegement:
 *    "This product includes software developed by independent contributors
 *    and hosted on ObjectStyle Group web site (http://objectstyle.org/)."
 *    Alternately, this acknowlegement may appear in the software itself,
 *    if and wherever such third-party acknowlegements normally appear.
 * 
 * 4. The names "ObjectStyle Group" and "Cayenne" must not be used to endorse
 *    or promote products derived from this software without prior written
 *    permission. For written permission, email
 *    "andrus at objectstyle dot org".
 * 
 * 5. Products derived from this software may not be called "ObjectStyle"
 *    or "Cayenne", nor may "ObjectStyle" or "Cayenne" appear in their
 *    names without prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED.  IN NO EVENT SHALL THE OBJECTSTYLE GROUP OR
 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 * ====================================================================
 * 
 * This software consists of voluntary contributions made by many
 * individuals and hosted on ObjectStyle Group web site.  For more
 * information on the ObjectStyle Group, please see
 * .
 */
package org.objectstyle.cayenne.access.trans;

import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;
import java.util.Map;

import org.objectstyle.cayenne.ObjectId;
import org.objectstyle.cayenne.map.DbAttribute;
import org.objectstyle.cayenne.map.DbEntity;
import org.objectstyle.cayenne.map.DbRelationship;

/**
 * Class implements default translation mechanism of
 * org.objectstyle.cayenne.query.InsertQuery objects to SQL INSERT statements. Note that
 * in order for this query to execute successfully, ObjectId contained within InsertQuery
 * must be fully initialized.
 * 
 * @author Andrei Adamchik
 * @deprecated since 1.2 Object InsertQuery is not needed anymore. It shouldn't be used
 *             directly anyway, but in cases where one might want to have access to it,
 *             InsertBatchQuery is a reasonable substitute.
 */
public class InsertTranslator extends QueryAssembler {

    protected List columnList = new ArrayList();

    public String aliasForTable(DbEntity dbEnt) {
        throw new RuntimeException("aliases not supported");
    }

    public void dbRelationshipAdded(DbRelationship dbRel) {
        throw new RuntimeException("db relationships not supported");
    }

    /** Method that converts an insert query into SQL string */
    public String createSqlString() throws Exception {
        prepareLists();
        StringBuffer queryBuf = new StringBuffer("INSERT INTO ");
        DbEntity dbE = getRootDbEntity();
        queryBuf.append(dbE.getFullyQualifiedName()).append(" (");

        int len = columnList.size();

        // 1. Append column names

        // unroll the loop to avoid condition checking in the loop
        queryBuf.append(columnList.get(0)); // assume we have at least 1 column
        for (int i = 1; i < len; i++) {
            queryBuf.append(", ").append(columnList.get(i));
        }

        // 2. Append values ('?' in place of actual parameters)
        queryBuf.append(") VALUES (");
        if (len > 0) {
            queryBuf.append('?');
            for (int i = 1; i < len; i++) {
                queryBuf.append(", ?");
            }
        }

        queryBuf.append(')');
        return queryBuf.toString();
    }

    public org.objectstyle.cayenne.query.InsertQuery insertQuery() {
        return (org.objectstyle.cayenne.query.InsertQuery) query;
    }

    /** Creates 2 matching lists: columns names and values */
    protected void prepareLists() throws Exception {
        DbEntity dbE = getRootDbEntity();
        ObjectId oid = insertQuery().getObjectId();
        Map id = (oid != null) ? oid.getIdSnapshot() : null;

        if (id != null) {
            Iterator idIt = id.entrySet().iterator();
            while (idIt.hasNext()) {
            	Map.Entry entry = (Map.Entry) idIt.next();
                String attrName = (String) entry.getKey();
                DbAttribute attr = (DbAttribute) dbE.getAttribute(attrName);
                Object attrValue = entry.getValue();
                columnList.add(attrName);

                addToParamList(attr, attrValue);
            }
        }

        Map snapshot = insertQuery().getObjectSnapshot();
        Iterator columnsIt = snapshot.entrySet().iterator();
        while (columnsIt.hasNext()) {
        	Map.Entry entry = (Map.Entry) columnsIt.next();
            String attrName = (String) entry.getKey();

            // values taken from ObjectId take precedence.
            if (id != null && id.get(attrName) != null)
                continue;

            DbAttribute attr = (DbAttribute) dbE.getAttribute(attrName);
            Object attrValue = entry.getValue();
            columnList.add(attrName);
            addToParamList(attr, attrValue);
        }
    }
}