org.objectstyle.cayenne.query.UpdateQuery 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.query;

import java.util.HashMap;
import java.util.Map;

import org.objectstyle.cayenne.exp.Expression;
import org.objectstyle.cayenne.map.ObjEntity;

/**
 * Object encapsulating an UPDATE statement. Note that updated attributes are expressed in
 * terms of DbAttribute names.
 */
public class UpdateQuery extends QualifiedQuery {

    protected Map updAttributes = new HashMap();

    /** Creates empty UpdateQuery. */
    public UpdateQuery() {
    }

    private void init(Object root, Expression qualifier) {
        setRoot(root);
        setQualifier(qualifier);
    }

    /**
     * Creates a UpdateQuery with null qualifier, for the specifed ObjEntity
     * 
     * @param root the ObjEntity this UpdateQuery is for.
     */
    public UpdateQuery(ObjEntity root) {
        this(root, null);
    }

    /**
     * Creates a UpdateQuery for the specifed ObjEntity with the given qualifier
     * 
     * @param root the ObjEntity this UpdateQuery is for.
     * @param qualifier an Expression indicating which objects will be updated
     */
    public UpdateQuery(ObjEntity root, Expression qualifier) {
        init(root, qualifier);
    }

    /**
     * Creates a UpdateQuery with null qualifier, for the entity which uses the given
     * class.
     * 
     * @param rootClass the Class of objects this UpdateQuery is for.
     */
    public UpdateQuery(Class rootClass) {
        this(rootClass, null);
    }

    /**
     * Creates a UpdateQuery for the entity which uses the given class, with the given
     * qualifier.
     * 
     * @param rootClass the Class of objects this UpdateQuery is for.
     * @param qualifier an Expression indicating which objects will be updated
     */
    public UpdateQuery(Class rootClass, Expression qualifier) {
        init(rootClass, qualifier);
    }

    /** Creates UpdateQuery with objEntityName parameter. */
    public UpdateQuery(String objEntityName) {
        this(objEntityName, null);
    }

    /**
     * Creates UpdateQuery with objEntityName and qualifier
     * parameters.
     */
    public UpdateQuery(String objEntityName, Expression qualifier) {
        init(objEntityName, qualifier);
    }

    /**
     * Calls "makeUpdate" on the visitor.
     * 
     * @since 1.2
     */
    public SQLAction createSQLAction(SQLActionVisitor visitor) {
        return visitor.updateAction(this);
    }

    public void addUpdAttribute(String attrName, Object updatedValue) {
        updAttributes.put(attrName, updatedValue);
    }

    /** Returns a map of updated attributes */
    public Map getUpdAttributes() {
        return updAttributes;
    }
}