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.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;
28 * A generic interface for database frontends
30 * @author Roland Haeder
32 public interface DatabaseBackend extends FrameworkInterface {
35 * Tries a connection to the database
37 * @throws java.sql.SQLException If the connection attempt fails
39 public void connectToDatabase () throws SQLException;
42 * Shuts down this backend
44 public void doShutdown ();
47 * Some "getter" for total table row count
49 * @return Total row count
50 * @throws java.sql.SQLException If an SQL error occurs
52 public int getTotalCount () throws SQLException;
55 * Checks whether at least one row is found with given boolean value.
57 * @param columnName Column to check for boolean value
58 * @param bool Boolean value to check
59 * @return Whether boolean value is found and returns at least one row
60 * @throws java.sql.SQLException If an SQL error occurs
62 public boolean isRowFound (final String columnName, final boolean bool) throws SQLException;
67 public void rewind ();
70 * Get length of underlaying file
72 * @return Length of underlaying file
74 public long length ();
77 * Stores an object in the database.
79 * @param object Object to store in database
80 * @throws java.io.IOException From inner class
82 public void store (final Storeable object) throws IOException;
85 * Gets an iterator for contacts
87 * @return Iterator for contacts
88 * @throws org.mxchange.addressbook.exceptions.BadTokenException If the CSV token is badly formulated
89 * @deprecated The method is to much "contact" specific
92 public Iterator<Contact> contactIterator () throws BadTokenException;