/**
 * Copyright (c) 2009--2010 Red Hat, Inc.
 *
 * This software is licensed to you under the GNU General Public License,
 * version 2 (GPLv2). There is NO WARRANTY for this software, express or
 * implied, including the implied warranties of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE. You should have received a copy of GPLv2
 * along with this software; if not, see
 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.txt.
 *
 * Red Hat trademarks are not licensed under GPLv2. No permission is
 * granted to use or replicate Red Hat trademarks that are incorporated
 * in this software or its documentation.
 */
package com.redhat.rhn.common.db.datasource;

/**
 * A cached set of query/elaborator strings and the parameterMap hash maps.
 *
 * @version $Rev: 59372 $
 */
public abstract class BaseMode implements Mode {

    private String name;
    private CachedStatement query;

    /**
     * This constructor is only to support DataListTest
     */
    protected BaseMode() { }

    /**
     * Construct a new BaseMode instance.
     * @param parsedMode
     */
    /*package*/ BaseMode(ParsedMode parsedMode) {
        this.name = parsedMode.getName();
        this.query = new CachedStatement(parsedMode.getParsedQuery());
    }

    /** {@inheritDoc} */
    public void setName(String n) {
        name = n;
    }

    /** {@inheritDoc} */
    public String getName() {
        return name;
    }

    /** {@inheritDoc} */
    public void setQuery(CachedStatement q) {
        query = q;
    }

    /** {@inheritDoc} */
    public CachedStatement getQuery() {
        return query;
    }

    /** {@inheritDoc} */
    public String toString() {
        StringBuilder sb = new StringBuilder();
        sb.append("[ Name = ");
        sb.append(getName());
        sb.append("  query = ");
        sb.append(query == null ? "null" : query.toString());
        return sb.toString();
    }

    /**
     * Returns the arity of the mode
     * @return number of parameters the mode accepts
     */
    public int getArity() {
        return query.getArity();
    }
}