Addressbook/src/org/mxchange/addressbook/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.addressbook.database.backend;
  18
  19 import java.io.IOException;
  20 import java.sql.SQLException;
  21 import java.util.Iterator;
  22 import org.mxchange.addressbook.FrameworkInterface;
  23 import org.mxchange.addressbook.database.storage.Storeable;
  24 import org.mxchange.addressbook.exceptions.BadTokenException;
  25
  26 /**
  27  * A generic interface for database frontends
  28  *
  29  * @author Roland Haeder
  30  */
  31 public interface DatabaseBackend extends FrameworkInterface {
  32
  33         /**
  34          * Tries a connection to the database
  35          *
  36          * @throws java.sql.SQLException If the connection attempt fails
  37          */
  38         public void connectToDatabase () throws SQLException;
  39
  40         /**
  41          * Shuts down this backend
  42          */
  43         public void doShutdown ();
  44
  45         /**
  46          * Some "getter" for row index from given boolean row value
  47          *
  48          * @param columnName Name of column
  49          * @param bool Boolean value to look for
  50          * @return Row index
  51          */
  52         public int getRowIndexFromColumn (final String columnName, final boolean bool);
  53
  54         /**
  55          * Some "getter" for total table row count
  56          *
  57          * @return Total row count
  58          * @throws java.sql.SQLException If an SQL error occurs
  59          */
  60         public int getTotalCount () throws SQLException;
  61
  62         /**
  63          * Checks whether at least one row is found with given boolean value.
  64          *
  65          * @param columnName Column to check for boolean value
  66          * @param bool Boolean value to check
  67          * @return Whether boolean value is found and returns at least one row
  68          * @throws java.sql.SQLException If an SQL error occurs
  69          */
  70         public boolean isRowFound (final String columnName, final boolean bool) throws SQLException;
  71
  72         /**
  73          * Rewinds backend
  74          */
  75         public void rewind ();
  76
  77         /**
  78          * Get length of underlaying file
  79          *
  80          * @return Length of underlaying file
  81          */
  82         public long length ();
  83
  84         /**
  85          * Stores an object in the database.
  86          *
  87          * @param object Object to store in database
  88          * @throws java.io.IOException From inner class
  89          */
  90         public void store (final Storeable object) throws IOException;
  91
  92         /**
  93          * Gets an iterator for contacts
  94          *
  95          * @return Iterator for contacts
  96          * @throws org.mxchange.addressbook.exceptions.BadTokenException If the CSV token is badly formulated
  97          */
  98         public Iterator<? extends Storeable> iterator () throws BadTokenException;
  99
 100         /**
 101          * Reads a single row from database.
 102          *
 103          * @param rowIndex Row index (or how much to skip)
 104          * @return A Storeable instance
 105          * @throws org.mxchange.addressbook.exceptions.BadTokenException If a token was badly formatted
 106          */
 107         public Storeable readRow (final int rowIndex) throws BadTokenException;
 108 }