org.objectstyle.cayenne.map.DeleteRule Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of cayenne
Cayenne Object Persistence Framework including all dependencies.
The newest version!
/* ====================================================================
 * 
 * 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.map;

/**
 * Defines constants for the possible values of ObjRelationship delete rules.
 * 
 * @author Craig Miskell
 */
public class DeleteRule {
    public static final int NO_ACTION = 0;
    private static final String NO_ACTION_NAME = "No Action";
    
    /** 
     * Remove the reference that the destination has to this source (if the 
     * inverse relationship is toOne, nullify, if toMany, remove the source 
     * object)
     */
    public static final int NULLIFY = 1;
    private static final String NULLIFY_NAME = "Nullify";

    /** Delete the destination object(s)
     */
    public static final int CASCADE = 2;
    private static final String CASCADE_NAME = "Cascade";

    /** If the relationship has any objects (toOne or toMany), deny the delete.  
     * (Destination objects would therefore have to be deleted manually first)
     */
    public static final int DENY = 3;
    private static final String DENY_NAME = "Deny";

    /** 
     * Returns String label for a delete rule state. Used for save/load (xml),
     * display in modeler etc. Must remain the same, or else great care taken
     * with loading old maps.
     */
    public static String deleteRuleName(int deleteRule) {
        switch (deleteRule) {
            case DeleteRule.NULLIFY :
                return NULLIFY_NAME;
            case DeleteRule.CASCADE :
                return CASCADE_NAME;
            case DeleteRule.DENY :
                return DENY_NAME;
            default :
                return NO_ACTION_NAME;
        }
    }

    /**
     * Translates a possible delete rule name (typically returned from
     * deleteRuleName at some stage), into a deleteRule constant
     */
    public static int deleteRuleForName(String name) {
        if (DENY_NAME.equals(name)) {
            return DENY;
        } else if (CASCADE_NAME.equals(name)) {
            return CASCADE;
        } else if (NULLIFY_NAME.equals(name)) {
            return NULLIFY;
        }
        return NO_ACTION;
    }

}