org.nuiton.topia.persistence.support.TopiaSqlSupport Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of api Show documentation
ToPIA API module
The newest version!
package org.nuiton.topia.persistence.support;

/*
 * #%L
 * ToPIA Extension :: API
 * %%
 * Copyright (C) 2018 - 2022 Ultreia.io
 * %%
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public
 * License along with this program.  If not, see
 * .
 * #L%
 */

import io.ultreia.java4all.util.sql.SqlWork;
import org.nuiton.topia.persistence.TopiaException;

import java.sql.Connection;
import java.sql.PreparedStatement;
import java.sql.ResultSet;
import java.util.List;

/**
 * This API provides methods to run SQL queries
 *
 * @author Arnaud Thimel (Code Lutin)
 * @since 3.0
 */
public interface TopiaSqlSupport {

    /**
     * Execute a given SQL code inside this transaction.
     *
     * @param sqlScript the sql script to execute
     */
    void executeSql(String sqlScript);

    /**
     * Runs the given SQL work on the current context
     *
     * @param sqlWork the SQL work instance to execute
     */
    void doSqlWork(SqlWork sqlWork);

    /**
     * Runs the given SQL query and return its first result if there is some.
     *
     * @param    type of result
     * @param query query to play
     * @return the single result or {@code null} if none found.
     * @throws TopiaException for any pb
     */
     O findSingleResult(TopiaSqlQuery query) throws TopiaException;

    /**
     * Runs the given SQL query and return its first result if there is some.
     *
     * @param          type of result
     * @param preparer    function to prepare the query
     * @param transformer function to transform the ResultSet into the expected element
     * @return the single result or {@code null} if none found.
     * @throws TopiaException for any pb
     */
     O findSingleResult(SqlFunction preparer, SqlFunction transformer) throws TopiaException;

    /**
     * Runs the given SQL query and return its first result if there is some.
     *
     * @param          type of result
     * @param sql         the sql query
     * @param transformer function to transform the ResultSet into the expected element
     * @return the single result or {@code null} if none found.
     * @throws TopiaException for any pb
     */
     O findSingleResult(String sql, SqlFunction transformer) throws TopiaException;

    /**
     * Runs the given SQL query and return all his result if there is some.
     *
     * @param    type of result
     * @param query query to play
     * @return the list of results (the list is empty if query returns no result).
     * @throws TopiaException for any pb
     */
     List findMultipleResult(TopiaSqlQuery query) throws TopiaException;

    /**
     * Runs the given SQL query and return all his result if there is some.
     *
     * @param          type of result
     * @param preparer    function to prepare the query
     * @param transformer function to transform the ResultSet into the expected element
     * @return the list of results (the list is empty if query returns no result).
     * @throws TopiaException for any pb
     */
     List findMultipleResult(SqlFunction preparer, SqlFunction transformer) throws TopiaException;

    /**
     * Runs the given SQL query and return all his result if there is some.
     *
     * @param          type of result
     * @param sql         the sql query
     * @param transformer function to transform the ResultSet into the expected element
     * @return the list of results (the list is empty if query returns no result).
     * @throws TopiaException for any pb
     */
     List findMultipleResult(String sql, SqlFunction transformer) throws TopiaException;

}