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.contact.Contact;
  24 import org.mxchange.addressbook.database.storage.Storeable;
  25 import org.mxchange.addressbook.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          * Shuts down this backend
  43          */
  44         public void doShutdown ();
  45
  46         /**
  47          * Rewinds backend
  48          */
  49         public void rewind ();
  50
  51         /**
  52          * Get length of underlaying file
  53          *
  54          * @return Length of underlaying file
  55          */
  56         public long length ();
  57
  58         /**
  59          * Stores an object in the database.
  60          *
  61          * @param object Object to store in database
  62          * @throws java.io.IOException From inner class
  63          */
  64         public void store (final Storeable object) throws IOException;
  65
  66         /**
  67          * Gets an iterator for contacts
  68          *
  69          * @return Iterator for contacts
  70          * @throws org.mxchange.addressbook.exceptions.BadTokenException If the CSV
  71          * token is badly formulated
  72          */
  73         public Iterator<Contact> contactIterator () throws BadTokenException;
  74 }