src/org/mxchange/jcore/database/frontend/DatabaseFrontend.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.frontend;
  18
  19 import java.io.IOException;
  20 import java.sql.ResultSet;
  21 import java.sql.SQLException;
  22 import org.mxchange.jcore.FrameworkInterface;
  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 DatabaseFrontend extends FrameworkInterface {
  33         /**
  34          * Gets a Result back from given ResultSet instance
  35          *
  36          * @param resultSet ResultSet instance from SQL driver
  37          * @return A typorized Result instance
  38          * @throws java.sql.SQLException If an SQL error occurs
  39          */
  40         public Result<? extends Storeable> getResultFromSet (final ResultSet resultSet) throws SQLException;
  41
  42         /**
  43          * Parses given line from database backend into a Storeable instance. Please
  44          * note that not all backends need this.
  45          *
  46          * @param line Line from database backend
  47          * @return A Storeable instance
  48          * @throws org.mxchange.jcore.exceptions.BadTokenException If a token was badly formatted
  49          */
  50         public Storeable parseLineToStoreable (final String line) throws BadTokenException;
  51
  52         /**
  53          * Name of used database table, handled over to backend
  54          *
  55          * @return the tableName
  56          */
  57         public String getTableName ();
  58
  59         /**
  60          * Shuts down the database layer
  61          * @throws java.sql.SQLException If any SQL error occurs
  62          * @throws java.io.IOException If any IO error occurs
  63          */
  64         public void doShutdown () throws SQLException, IOException;
  65 }