2 * Copyright (C) 2015 Roland Haeder
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.
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.
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/>.
17 package org.mxchange.addressbook.database.backend;
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;
27 * A generic interface for database frontends
29 * @author Roland Haeder
31 public interface DatabaseBackend extends FrameworkInterface {
34 * Tries a connection to the database
36 public void connectToDatabase ();
39 * Shuts down this backend
41 public void doShutdown ();
46 public void rewind ();
49 * Get length of underlaying file
51 * @return Length of underlaying file
53 public long length ();
56 * Stores an object in the database.
58 * @param object Object to store in database
59 * @throws java.io.IOException From inner class
61 public void store (final Storeable object) throws IOException;
64 * Gets an iterator for contacts
66 * @return Iterator for contacts
67 * @throws org.mxchange.addressbook.exceptions.BadTokenException If the CSV
68 * token is badly formulated
70 public Iterator<Contact> contactIterator () throws BadTokenException;