org.simpleflatmapper.jdbc.Crud Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sfm-jdbc Show documentation
Java library to map flat record - ResultSet, csv - to java object with minimum configuration and low footprint.
There is a newer version: 9.0.2
package org.simpleflatmapper.jdbc;

import org.simpleflatmapper.util.CheckedConsumer;

import java.lang.reflect.Type;
import java.sql.Connection;
import java.sql.SQLException;
import java.util.Collection;

/**
 *
 * @param  the target type
 * @param  the key type
 */
public interface Crud {
    /**
     * insert value into the db through the specified connection.
     *
     * @param connection the connection
     * @param value      the value
     * @throws SQLException if an error occurs
     */
    void create(Connection connection, T value) throws SQLException;

    /**
     * insert values into the db through the specified connection.
     *
     * @param connection the connection
     * @param values      the values
     * @throws SQLException if an error occurs
     */
    void create(Connection connection, Collection values) throws SQLException;

    /**
     * insert value into the db through the specified connection.
     * Callback keyConsumer with the generated key if one was.
     *
     * @param connection  the connection
     * @param value       the value
     * @param keyConsumer the key consumer
     * @param         the type of keyConsumer
     * @return the keyConsumer
     * @throws SQLException
     */
    > RH create(Connection connection, T value, RH keyConsumer) throws SQLException;

    /**
     * insert values into the db through the specified connection.
     * Callback keyConsumer for the generated keys.
     *
     * @param connection  the connection
     * @param values       the values
     * @param keyConsumer the key consumer
     * @param         the type of keyConsumer
     * @return the keyConsumer
     * @throws SQLException
     */
    > RH create(Connection connection, Collection values, RH keyConsumer) throws SQLException;

    /**
     * retrieve the object with the specified key.
     *
     * @param connection the connection
     * @param key        the key
     * @return the object or null if not found
     * @throws SQLException if an error occurs
     */
    T read(Connection connection, K key) throws SQLException;

    /**
     * retrieve the objects with the specified keys and pass them to the consumer.
     *
     * @param connection the connection
     * @param keys       the keys
     * @param consumer the handler that is callback for each row
     * @throws SQLException if an error occurs
     */
    > RH read(Connection connection, Collection keys, RH consumer) throws SQLException;

    /**
     * update the object.
     *
     * @param connection the connection
     * @param value      the object
     * @throws SQLException if an error occurs
     */
    void update(Connection connection, T value) throws SQLException;

    /**
     * update the objects.
     *
     * @param connection the connection
     * @param values      the objects
     * @throws SQLException if an error occurs
     */
    void update(Connection connection, Collection values) throws SQLException;

    /**
     * delete the object with the specified key.
     *
     * @param connection the connection
     * @param key        the key
     * @throws SQLException if an error occurs
     */
    void delete(Connection connection, K key) throws SQLException;

    /**
     * delete the objects with the specified keys.
     *
     * @param connection the connection
     * @param keys       the keys
     * @throws SQLException if an error occurs
     */
    void delete(Connection connection, Collection keys) throws SQLException;

    /**
     * UPSERT only supported on Mysql
     * @param connection the connection
     * @param value the value
     * @throws SQLException
     * @throws UnsupportedOperationException
     */
    void createOrUpdate(Connection connection, T value) throws SQLException;

    /**
     * UPSERT only supported on Mysql
     * @param connection the connection
     * @param values the values to upsert
     * @throws SQLException
     * @throws UnsupportedOperationException
     */
    void createOrUpdate(Connection connection, Collection values) throws SQLException;

    /**
     * UPSERT only supported on Mysql and Postgres 9.5.
     * Used the callback with caution has Mysql will return an incremented id event for when no insert actually occurred.
     * @param connection the connection
     * @param value the value to upsert
     * @param keyConsumer generated key consumer
     * @param  the keyConsumer type
     * @return the keyConsumer
     * @throws SQLException
     */
    > RH createOrUpdate(Connection connection, T value, RH keyConsumer) throws SQLException;


    /**
     * UPSERT only supported on Mysql and Postgres 9.5.
     * Used the callback with caution has Mysql will return an incremented id event for when no insert actually occurred.
     * @param connection the connection
     * @param values the values to insert
     * @param keyConsumer generated key consumer
     * @param  the keyConsumer type
     * @return the keyConsumer
     * @throws SQLException
     */
    > RH createOrUpdate(Connection connection, Collection values, RH keyConsumer) throws SQLException;


     SelectQuery where(String whereClause, Type paramClass);
}