src/org/mxchange/jcore/database/backend/DatabaseBackend.java

   1 /*
   2  * Copyright (C) 2015 Roland Haeder
   3  *
   4  * This program is free software: you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation, either version 3 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16  */
  17 package org.mxchange.jcore.database.backend;
  18
  19 import java.io.IOException;
  20 import java.sql.SQLException;
  21 import org.mxchange.jcore.FrameworkInterface;
  22 import org.mxchange.jcore.criteria.searchable.SearchableCritera;
  23 import org.mxchange.jcore.database.result.Result;
  24 import org.mxchange.jcore.database.storage.Storeable;
  25 import org.mxchange.jcore.exceptions.BadTokenException;
  26
  27 /**
  28  * A generic interface for database frontends
  29  *
  30  * @author Roland Haeder
  31  */
  32 public interface DatabaseBackend extends FrameworkInterface {
  33
  34         /**
  35          * Tries a connection to the database
  36          *
  37          * @throws java.sql.SQLException If the connection attempt fails
  38          */
  39         public void connectToDatabase () throws SQLException;
  40
  41         /**
  42          * Run a "SELECT" statement with given criteria and always return a Result
  43          * instance. The result instance then provides methods to iterate over all
  44          * found entries.
  45          *
  46          * @param critera Search critera
  47          * @return A result instance
  48          * @throws java.io.IOException If any IO error occurs
  49          * @throws org.mxchange.jcore.exceptions.BadTokenException If a bad token was found
  50          */
  51         public Result<? extends Storeable> doSelectByCriteria (final SearchableCritera critera) throws IOException, BadTokenException;
  52
  53         /**
  54          * Shuts down this backend
  55          *
  56          * @throws java.sql.SQLException If any SQL error occurs
  57          * @throws java.io.IOException If any IO error occurs
  58          */
  59         public void doShutdown () throws SQLException, IOException;
  60 }