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

Go to download
/* ====================================================================
 * 
 * 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;

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

import org.objectstyle.cayenne.dba.TypesMapping;
import org.objectstyle.cayenne.util.Util;
import org.objectstyle.cayenne.util.XMLEncoder;

/**
 * A DerivedDbAttribute is a DbAttribute that resolves to an SQL expression based on a set
 * of other attributes. DerivedDbAttribute's allow to build expressions like "
 * count(id)", "sum(price)", etc.
 * 
 * Internally DerivedDbAttribute is defined as a specification string and a set of
 * substitution DbAttribute parameters. Specification string is an SQL expression that
 * contains placeholders (%@) for attribute parameters, for example:
 * 
 * 
 * sum(%@) + sum(%@)
 * 
 * 
 * @author Andrei Adamchik
 */
public class DerivedDbAttribute extends DbAttribute {

    public static final String ATTRIBUTE_TOKEN = "%@";

    protected String expressionSpec;
    protected List params = new ArrayList();
    protected boolean groupBy;

    /**
     * Constructor for DerivedDbAttribute.
     */
    public DerivedDbAttribute() {
        super();
    }

    /**
     * Constructor for DerivedDbAttribute.
     */
    public DerivedDbAttribute(String name) {
        super(name);
    }

    /**
     * Constructor for DerivedDbAttribute.
     */
    public DerivedDbAttribute(String name, int type, DbEntity entity, String spec) {
        super(name, type, entity);
        setExpressionSpec(spec);
    }

    /**
     * Creates and initializes a derived attribute with an attribute of a parent entity.
     */
    public DerivedDbAttribute(DbEntity entity, DbAttribute parentProto) {
        setName(parentProto.getName());
        setType(parentProto.getType());
        setMandatory(parentProto.isMandatory());
        setMaxLength(parentProto.getMaxLength());
        setPrecision(parentProto.getPrecision());
        setPrimaryKey(parentProto.isPrimaryKey());

        setExpressionSpec(ATTRIBUTE_TOKEN);
        addParam(parentProto);
        setEntity(entity);
    }

    /**
     * Prints itself as XML to the provided XMLEncoder.
     * 
     * @since 1.1
     */
    public void encodeAsXML(XMLEncoder encoder) {
        encoder.print(" 0) {
            encoder.print(" length=\"");
            encoder.print(getMaxLength());
            encoder.print('\"');
        }

        if (getPrecision() > 0) {
            encoder.print(" precision=\"");
            encoder.print(getPrecision());
            encoder.print('\"');
        }

        if (((DerivedDbEntity) getEntity()).getGroupByAttributes().contains(this)) {
            encoder.print(" isGroupBy=\"true\"");
        }

        String spec = getExpressionSpec();
        if (spec != null && spec.trim().length() > 0) {
            encoder.print(" spec=\"");
            encoder.print(spec);
            encoder.print('\"');
        }

        List params = getParams();

        if (params.size() > 0) {
            encoder.println(">");

            encoder.indent(1);

            Iterator refs = params.iterator();
            while (refs.hasNext()) {
                DbAttribute ref = (DbAttribute) refs.next();
                encoder.println("");
            }

            encoder.indent(-1);
            encoder.println("");
        }
        else {
            encoder.println("/>");
        }
    }

    public String getAliasedName(String alias) {
        if (expressionSpec == null) {
            return super.getAliasedName(alias);
        }

        int len = params.size();
        StringBuffer buf = new StringBuffer();
        int ind = 0;
        for (int i = 0; i < len; i++) {
            // no bound checking
            // expression is assumed to be valid
            int match = expressionSpec.indexOf(ATTRIBUTE_TOKEN, ind);
            DbAttribute at = (DbAttribute) params.get(i);
            if (match > i) {
                buf.append(expressionSpec.substring(ind, match));
            }
            buf.append(at.getAliasedName(alias));
            ind = match + 2;
        }

        if (ind < expressionSpec.length()) {
            buf.append(expressionSpec.substring(ind));
        }

        return buf.toString();
    }

    /**
     * Returns true if this attribute is used in GROUP BY clause of the parent entity.
     */
    public boolean isGroupBy() {
        return groupBy;
    }

    public void setGroupBy(boolean flag) {
        groupBy = flag;
    }

    /**
     * Returns the params.
     * 
     * @return List
     */
    public List getParams() {
        return Collections.unmodifiableList(params);
    }

    /**
     * Returns the expressionSpec.
     */
    public String getExpressionSpec() {
        return expressionSpec;
    }

    /**
     * Adds parameter.
     */
    public void addParam(DbAttribute param) {
        params.add(param);
    }

    public void removeParam(DbAttribute param) {
        params.remove(param);
    }

    public void clearParams() {
        params.clear();
    }

    /**
     * Sets the expressionSpec.
     */
    public void setExpressionSpec(String expressionSpec) {
        this.expressionSpec = expressionSpec;
    }
}