com.nesscomputing.jdbi.JdbiStatement Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ness-jdbi Show documentation
Ness JDBI support
There is a newer version: 1.6.0
/**
 * Copyright (C) 2012 Ness Computing, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.nesscomputing.jdbi;

import java.util.Map;

import org.apache.commons.lang3.builder.ToStringBuilder;
import org.skife.jdbi.v2.Call;
import org.skife.jdbi.v2.Handle;
import org.skife.jdbi.v2.PreparedBatch;
import org.skife.jdbi.v2.Query;
import org.skife.jdbi.v2.Script;
import org.skife.jdbi.v2.Update;

/**
 * Allows simple declarations of SQL statements in a template as constants:
 *
 *  *   public class FooDAO {
 *     public static final Package pkg = FooDAO.class.getPackage();
 *     public static final JdbiStatement UPDATE = new JdbiStatement(pkg, "update"); // loads from sql.st, template 'update()'
 *   ...
 *     return db.withHandle(new HandleCallback<Integer>() {
 *       public Integer withHandle(final Handle handle) throws Exception {
 *         return UPDATE.createStatement(handle).bind("foo", ...).execute();
 *       }
 *     }
 *   }
 * 
 */
public final class JdbiStatement
{
    private final String queryName;

    public JdbiStatement(final String queryName)
    {
        this.queryName = queryName;
    }

    public JdbiStatement(final Class clazz, final String queryName)
    {
        this(clazz.getName() + ":" + queryName);
    }

    public JdbiStatement(final Package pkg, final String queryName)
    {
        this(pkg.getName() + ":" + queryName);
    }

    /**
     * @see Handle#createQuery(String)
     */
    public Query> createQuery(final Handle handle)
    {
        return handle.createQuery(queryName);
    }

    /**
     * @see Handle#createStatement(String)
     */
    public Update createStatement(final Handle handle)
    {
        return handle.createStatement(queryName);
    }

    /**
     * @see Handle#createScript(String)
     */
    public Script createScript(final Handle handle)
    {
        return handle.createScript(queryName);
    }

    /**
     * @see Handle#createCall
     */
    public Call createCall(final Handle handle)
    {
        return handle.createCall(queryName);
    }

    /**
     * @see Handle#prepareBatch(String)
     */
    public PreparedBatch createPreparedBatch(final Handle handle)
    {
        return handle.prepareBatch(queryName);
    }

    @Override
    public String toString()
    {
        return new ToStringBuilder(this)
            .append("queryName", queryName)
            .toString();
    }
}