src/org/mxchange/addressbook/database/frontend/contact/AddressbookContactDatabaseFrontend.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.frontend.contact;
  18
  19 import java.io.IOException;
  20 import java.lang.reflect.Field;
  21 import java.lang.reflect.InvocationTargetException;
  22 import java.sql.SQLException;
  23 import java.text.MessageFormat;
  24 import java.util.Iterator;
  25 import java.util.Map;
  26 import org.mxchange.addressbook.database.contact.AddressbookContactDatabaseConstants;
  27 import org.mxchange.addressbook.exceptions.ContactAlreadyAddedException;
  28 import org.mxchange.addressbook.manager.contact.AddressbookContactManager;
  29 import org.mxchange.jcore.contact.Contact;
  30 import org.mxchange.jcore.criteria.searchable.SearchCriteria;
  31 import org.mxchange.jcore.criteria.searchable.SearchableCriteria;
  32 import org.mxchange.jcore.database.frontend.BaseDatabaseFrontend;
  33 import org.mxchange.jcore.database.result.Result;
  34 import org.mxchange.jcore.database.storage.Storeable;
  35 import org.mxchange.jcore.exceptions.BadTokenException;
  36 import org.mxchange.jcore.exceptions.CorruptedDatabaseFileException;
  37 import org.mxchange.jcore.exceptions.UnsupportedDatabaseBackendException;
  38
  39 /**
  40  * Stores and retrieves Contact instances
  41  *
  42  * @author Roland Haeder
  43  */
  44 public class AddressbookContactDatabaseFrontend extends BaseDatabaseFrontend implements AddressbookContactFrontend {
  45
  46         /**
  47          * Constructor which accepts a contact manager
  48          *
  49          * @param manager Manager instance
  50          * @throws org.mxchange.jcore.exceptions.UnsupportedDatabaseBackendException If the database backend is not supported
  51          * @throws java.sql.SQLException If an SQL error occurs
  52          */
  53         public AddressbookContactDatabaseFrontend (final AddressbookContactManager manager) throws UnsupportedDatabaseBackendException, SQLException {
  54                 // Call own constructor
  55                 this();
  56
  57                 // Trace message
  58                 this.getLogger().trace(MessageFormat.format("manager={0} - CALLED!", manager)); //NOI18N
  59
  60                 // Manager instance must not be null
  61                 if (manager == null) {
  62                         // Abort here
  63                         throw new NullPointerException("manager is null"); //NOI18N
  64                 }
  65
  66                 // Set contact manager
  67                 this.setContactManager(manager);
  68         }
  69
  70         /**
  71          * Default but protected constructor
  72          * @throws org.mxchange.jcore.exceptions.UnsupportedDatabaseBackendException If the database backend is not supported
  73          * @throws java.sql.SQLException Any SQL exception from e.g. MySQL connector
  74          */
  75         protected AddressbookContactDatabaseFrontend () throws UnsupportedDatabaseBackendException, SQLException {
  76                 // Trace message
  77                 this.getLogger().trace("CALLED!"); //NOI18N
  78
  79                 // Set "table" name
  80                 this.setTableName("contacts"); //NOI18N
  81
  82                 // Initalize backend
  83                 this.initBackend();
  84         }
  85
  86         /**
  87          * Adds given contact instance to database
  88          *
  89          * @param contact Contact instance
  90          * @throws org.mxchange.addressbook.exceptions.ContactAlreadyAddedException If the contact instance is already found
  91          */
  92         @Override
  93         public void addContact (final Contact contact) throws ContactAlreadyAddedException {
  94                 // Trace message
  95                 this.getLogger().trace("CALLED!"); //NOI18N
  96
  97                 // Make sure the contact is set
  98                 if (contact == null) {
  99                         // Abort here
 100                         throw new NullPointerException("contact is null"); //NOI18N
 101                 }
 102
 103                 try {
 104                         // First check if the contact is there
 105                         if (this.isContactFound(contact)) {
 106                                 // Already there
 107                                 throw new ContactAlreadyAddedException(contact);
 108                         }
 109
 110                         // Clear dataset from previous usage
 111                         this.clearDataSet();
 112
 113                         // Get field iterator
 114                         Iterator<Map.Entry<Field, Object>> iterator = contact.iterator();
 115
 116                         // Iterate over all
 117                         while (iterator.hasNext()) {
 118                                 // Get next field
 119                                 Map.Entry<Field, Object> field = iterator.next();
 120
 121                                 // Add it to data set
 122                                 this.addToDataSet(field.getKey().getName(), field.getValue());
 123                         }
 124
 125                         // Then add it
 126                         Result<? extends Storeable> result = this.doInsertDataSet();
 127
 128                         // Debug message
 129                         this.getLogger().debug(MessageFormat.format("result={0}", result)); //NOI18N
 130                 } catch (final IOException | BadTokenException | SQLException | NoSuchMethodException | IllegalAccessException | InvocationTargetException ex) {
 131                         // Abort here
 132                         this.abortProgramWithException(ex);
 133                 }
 134
 135                 // Trace message
 136                 this.getLogger().trace("CALLED!"); //NOI18N
 137         }
 138
 139         /**
 140          * Shuts down the database layer
 141          * @throws java.sql.SQLException If an SQL error occurs
 142          * @throws java.io.IOException If an IO error occurs
 143          */
 144         @Override
 145         public void doShutdown () throws SQLException, IOException {
 146                 // Trace message
 147                 this.getLogger().trace("CALLED!"); //NOI18N
 148
 149                 // Shutdown backend
 150                 this.getBackend().doShutdown();
 151
 152                 // Trace message
 153                 this.getLogger().trace("EXIT!"); //NOI18N
 154         }
 155
 156         @Override
 157         public Object emptyStringToNull (final String key, final Object value) {
 158                 throw new UnsupportedOperationException(MessageFormat.format("Not supported yet: key={0},value={1}", key, value));
 159         }
 160
 161         /**
 162          * Some "getter" for total contact count
 163          *
 164          * @return Total contact count
 165          */
 166         @Override
 167         public int getContactsCount () throws SQLException, IOException {
 168                 // And deligate to backend
 169                 return this.getBackend().getTotalRows(); //NOI18N
 170         }
 171
 172         @Override
 173         public String getIdName () {
 174                 // Return id column
 175                 return AddressbookContactDatabaseConstants.COLUMN_ID;
 176         }
 177
 178         @Override
 179         public Contact getOwnContact () throws IOException, BadTokenException, CorruptedDatabaseFileException, SQLException, NoSuchMethodException, IllegalAccessException, InvocationTargetException {
 180                 // Trace message
 181                 this.getLogger().trace("CALLED!"); //NOI18N
 182
 183                 // Prepare search instance
 184                 SearchableCriteria criteria = new SearchCriteria();
 185
 186                 // Add criteria and limit
 187                 criteria.addCriteria(AddressbookContactDatabaseConstants.COLUMN_OWN_CONTACT, true);
 188                 criteria.setLimit(1);
 189
 190                 // Then search for it
 191                 Result<? extends Storeable> result = this.getBackend().doSelectByCriteria(criteria);
 192
 193                 // Debug message
 194                 this.getLogger().debug(MessageFormat.format("result={0}", result));
 195
 196                 // Init instance
 197                 Contact contact = null;
 198
 199                 // Is there one row at least?
 200                 if (result.hasNext()) {
 201                         // Then get it
 202                         Storeable storeable = result.next();
 203
 204                         // Debug message
 205                         this.getLogger().debug(MessageFormat.format("storeable={0}", storeable));
 206
 207                         // Is it same instance?
 208                         if (!(storeable instanceof Contact)) {
 209                                 // Not same instance
 210                                 throw new IllegalArgumentException(MessageFormat.format("storeable={0} is not implementing Contact", storeable));
 211                         }
 212
 213                         // Cast it securely
 214                         contact = (Contact) storeable;
 215                 }
 216
 217                 // Trace message
 218                 this.getLogger().trace(MessageFormat.format("contact={0} - EXIT!", contact));
 219
 220                 // Return it
 221                 return contact;
 222         }
 223
 224         @Override
 225         public Storeable getStoreableAtRow (final int rowIndex) {
 226                 throw new UnsupportedOperationException("Not supported yet: rowIndex=" + rowIndex);
 227         }
 228
 229         /**
 230          * Checks if given Contact is found
 231          *
 232          * @param contact Contact instance to check
 233          * @return Whether the given Contact instance is found
 234          */
 235         @Override
 236         public boolean isContactFound (final Contact contact) throws BadTokenException {
 237                 // Trace message
 238                 this.getLogger().trace(MessageFormat.format("contact={0} - CALLED!", contact)); //NOI18N
 239
 240                 // contact should not be null
 241                 if (contact == null) {
 242                         // Abort here
 243                         throw new NullPointerException("contact is null"); //NOI18N
 244                 }
 245
 246                 // Default is not found
 247                 boolean isFound = false;
 248
 249                 // Start iteration
 250                 Iterator<? extends Storeable> iterator = this.getBackend().iterator();
 251
 252                 // Check all entries
 253                 while (iterator.hasNext()) {
 254                         // Get next element
 255                         Contact c = (Contact) iterator.next();
 256
 257                         // Debug message
 258                         this.getLogger().debug(MessageFormat.format("c={0},contact={1}", c, contact)); //NOI18N
 259
 260                         // Is it added?
 261                         if (c.equals(contact)) {
 262                                 // Is found
 263                                 isFound = true;
 264                                 break;
 265                         }
 266                 }
 267
 268                 // Trace message
 269                 this.getLogger().trace(MessageFormat.format("isFound={0} - EXIT!", isFound)); //NOI18N
 270
 271                 // Return it
 272                 return isFound;
 273         }
 274
 275         /**
 276          * Checks whether own contact is found in database
 277          *
 278          * @return Whether own contact is found
 279          * @throws org.mxchange.jcore.exceptions.BadTokenException Continued throw
 280          * @throws org.mxchange.jcore.exceptions.CorruptedDatabaseFileException If the database file is damaged
 281          * @throws java.lang.NoSuchMethodException If a method cannot be found
 282          * @throws java.lang.IllegalAccessException If a method is not accessible
 283          * @throws java.lang.reflect.InvocationTargetException Any other problems?
 284          */
 285         @Override
 286         public boolean isOwnContactFound () throws SQLException, IOException, BadTokenException, CorruptedDatabaseFileException, NoSuchMethodException, IllegalAccessException, InvocationTargetException {
 287                 // Get search criteria instance
 288                 SearchableCriteria critera = new SearchCriteria();
 289
 290                 // Add condition
 291                 critera.addCriteria(AddressbookContactDatabaseConstants.COLUMN_OWN_CONTACT, true);
 292
 293                 // Get result
 294                 Result<? extends Storeable> result = this.getBackend().doSelectByCriteria(critera);
 295
 296                 // Deligate this call to backend
 297                 return result.hasNext();
 298         }
 299
 300         @Override
 301         public Storeable toStoreable (final Map<String, String> map) throws NoSuchMethodException, IllegalAccessException, IllegalArgumentException, InvocationTargetException {
 302                 throw new UnsupportedOperationException("Not supported yet: map=" + map);
 303         }
 304 }