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 (null == manager) {
  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         @Override
  87         public void addContact (final Contact contact) throws ContactAlreadyAddedException {
  88                 // Trace message
  89                 this.getLogger().trace("CALLED!"); //NOI18N
  90
  91                 // Make sure the contact is set
  92                 if (null == contact) {
  93                         // Abort here
  94                         throw new NullPointerException("contact is null"); //NOI18N
  95                 }
  96
  97                 try {
  98                         // First check if the contact is there
  99                         if (this.isContactFound(contact)) {
 100                                 // Already there
 101                                 throw new ContactAlreadyAddedException(contact);
 102                         }
 103
 104                         // Clear dataset from previous usage
 105                         this.clearDataSet();
 106
 107                         // Get field iterator
 108                         Iterator<Map.Entry<Field, Object>> iterator = contact.iterator();
 109
 110                         // Iterate over all
 111                         while (iterator.hasNext()) {
 112                                 // Get next field
 113                                 Map.Entry<Field, Object> field = iterator.next();
 114
 115                                 // Add it to data set
 116                                 this.addToDataSet(field.getKey().getName(), field.getValue());
 117                         }
 118
 119                         // Then add it
 120                         // @todo Nothing is done yet!
 121                         Result<? extends Storeable> result = this.doInsertDataSet();
 122
 123                         // Debug message
 124                         this.getLogger().debug(MessageFormat.format("result={0}", result)); //NOI18N
 125                 } catch (final IOException | BadTokenException | SQLException | NoSuchMethodException | IllegalAccessException | InvocationTargetException | CorruptedDatabaseFileException ex) {
 126                         // Abort here
 127                         this.abortProgramWithException(ex);
 128                 }
 129
 130                 // Trace message
 131                 this.getLogger().trace("CALLED!"); //NOI18N
 132         }
 133
 134         @Override
 135         public void doShutdown () throws SQLException, IOException {
 136                 // Trace message
 137                 this.getLogger().trace("CALLED!"); //NOI18N
 138
 139                 // Shutdown backend
 140                 this.getBackend().doShutdown();
 141
 142                 // Trace message
 143                 this.getLogger().trace("EXIT!"); //NOI18N
 144         }
 145
 146         @Override
 147         public Object emptyStringToNull (final String key, final Object value) {
 148                 throw new UnsupportedOperationException(MessageFormat.format("Not supported yet: key={0},value={1}", key, value));
 149         }
 150
 151         /**
 152          * Some "getter" for total contact count
 153          *
 154          * @return Total contact count
 155          */
 156         @Override
 157         public int getContactsCount () throws SQLException, IOException {
 158                 // And deligate to backend
 159                 return this.getBackend().getTotalRows(); //NOI18N
 160         }
 161
 162         @Override
 163         public String getIdName () {
 164                 // Return id column
 165                 return AddressbookContactDatabaseConstants.COLUMN_ID;
 166         }
 167
 168         @Override
 169         public Contact getOwnContact () throws IOException, BadTokenException, CorruptedDatabaseFileException, SQLException, NoSuchMethodException, IllegalAccessException, InvocationTargetException {
 170                 // Trace message
 171                 this.getLogger().trace("CALLED!"); //NOI18N
 172
 173                 // Prepare search instance
 174                 SearchableCriteria criteria = new SearchCriteria();
 175
 176                 // Add criteria and limit
 177                 criteria.addCriteria(AddressbookContactDatabaseConstants.COLUMN_OWN_CONTACT, true);
 178                 criteria.setLimit(1);
 179
 180                 // Then search for it
 181                 Result<? extends Storeable> result = this.getBackend().doSelectByCriteria(criteria);
 182
 183                 // Debug message
 184                 this.getLogger().debug(MessageFormat.format("result={0}", result));
 185
 186                 // Init instance
 187                 Contact contact = null;
 188
 189                 // Is there one row at least?
 190                 if (result.hasNext()) {
 191                         // Then get it
 192                         Storeable storeable = result.next();
 193
 194                         // Debug message
 195                         this.getLogger().debug(MessageFormat.format("storeable={0}", storeable));
 196
 197                         // Is it same instance?
 198                         if (!(storeable instanceof Contact)) {
 199                                 // Not same instance
 200                                 throw new IllegalArgumentException(MessageFormat.format("storeable={0} is not implementing Contact", storeable));
 201                         }
 202
 203                         // Cast it securely
 204                         contact = (Contact) storeable;
 205                 }
 206
 207                 // Trace message
 208                 this.getLogger().trace(MessageFormat.format("contact={0} - EXIT!", contact));
 209
 210                 // Return it
 211                 return contact;
 212         }
 213
 214         @Override
 215         public Storeable getStoreableAtRow (final int rowIndex) {
 216                 throw new UnsupportedOperationException("Not supported yet: rowIndex=" + rowIndex);
 217         }
 218
 219         @Override
 220         public boolean isContactFound (final Contact contact) throws BadTokenException, IOException, CorruptedDatabaseFileException, SQLException, NoSuchMethodException, IllegalAccessException, InvocationTargetException {
 221                 // Trace message
 222                 this.getLogger().trace(MessageFormat.format("contact={0} - CALLED!", contact)); //NOI18N
 223
 224                 // contact should not be null
 225                 if (null == contact) {
 226                         // Abort here
 227                         throw new NullPointerException("contact is null"); //NOI18N
 228                 }
 229
 230                 // Default is not found
 231                 boolean isFound = false;
 232
 233                 // Init search instance (but empty)
 234                 SearchableCriteria criteria = new SearchCriteria();
 235
 236                 // Look for all entries and compare here. Else all entries needs to be compared with many AND statements
 237                 Result<? extends Storeable> result = this.getBackend().doSelectByCriteria(criteria);
 238
 239                 // Debug message
 240                 this.getLogger().debug(MessageFormat.format("result({0})={1}", result.size(), result));
 241                 // Start iteration
 242                 Iterator<? extends Storeable> iterator = result.iterator();
 243
 244                 // Check all entries
 245                 while (iterator.hasNext()) {
 246                         // Get next element
 247                         Contact c = (Contact) iterator.next();
 248
 249                         // Debug message
 250                         this.getLogger().debug(MessageFormat.format("c={0},contact={1}", c, contact)); //NOI18N
 251
 252                         // Is it added?
 253                         if (c.equals(contact)) {
 254                                 // Is found
 255                                 isFound = true;
 256                                 break;
 257                         }
 258                 }
 259
 260                 // Trace message
 261                 this.getLogger().trace(MessageFormat.format("isFound={0} - EXIT!", isFound)); //NOI18N
 262
 263                 // Return it
 264                 return isFound;
 265         }
 266
 267         @Override
 268         public boolean isOwnContactFound () throws SQLException, IOException, BadTokenException, CorruptedDatabaseFileException, NoSuchMethodException, IllegalAccessException, InvocationTargetException {
 269                 // Get search criteria instance
 270                 SearchableCriteria criteria = new SearchCriteria();
 271
 272                 // Add condition
 273                 criteria.addCriteria(AddressbookContactDatabaseConstants.COLUMN_OWN_CONTACT, true);
 274
 275                 // Get result
 276                 Result<? extends Storeable> result = this.getBackend().doSelectByCriteria(criteria);
 277
 278                 // Deligate this call to backend
 279                 return result.hasNext();
 280         }
 281
 282         @Override
 283         public Storeable toStoreable (final Map<String, String> map) throws NoSuchMethodException, IllegalAccessException, IllegalArgumentException, InvocationTargetException {
 284                 throw new UnsupportedOperationException("Not supported yet: map=" + map);
 285         }
 286 }