org.drizzle.jdbc.internal.common.query.ParameterizedQuery Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of drizzle-jdbc Show documentation

BSD Licensed JDBC driver for Drizzle and MySQL

There is a newer version: 1.4

/*
 * Drizzle-JDBC
 *
 * Copyright (c) 2009-2011, Marcus Eriksson
 *
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following
 * conditions are met:
 *
 *  Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
 *  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.
 *  Neither the name of the driver nor the names of its contributors may be used to endorse or promote products derived
 *   from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS 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 COPYRIGHT HOLDER OR 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.
 */

package org.drizzle.jdbc.internal.common.query;

import org.drizzle.jdbc.internal.common.query.parameters.ParameterHolder;

/**
 * . User: marcuse Date: Mar 18, 2009 Time: 10:07:57 PM
 */
public interface ParameterizedQuery extends Query {
    /**
     * get the number of parameters in this query.
     *
     * @return number of parameters
     */
    int getParamCount();

    /**
     * clears the parameters.
     */
    void clearParameters();

    /**
     * Sets a parameter at a position. The positions start at 0.
     *
     * @param position  the position to set it at
     * @param parameter the parameter to set
     * @throws IllegalParameterException if, for example, the position is out of bounds
     */
    void setParameter(int position, ParameterHolder parameter)
            throws IllegalParameterException;

    ParameterHolder[] getParameters();

    String getQuery();

    byte[][] getQueryPartsArray();
}