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