Addressbook/src/org/mxchange/addressbook/manager/contact/ContactManager.java

   1 /*\r
   2  * Copyright (C) 2015 Roland Haeder\r
   3  *\r
   4  * This program is free software: you can redistribute it and/or modify\r
   5  * it under the terms of the GNU General Public License as published by\r
   6  * the Free Software Foundation, either version 3 of the License, or\r
   7  * (at your option) any later version.\r
   8  *\r
   9  * This program is distributed in the hope that it will be useful,\r
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of\r
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
  12  * GNU General Public License for more details.\r
  13  *\r
  14  * You should have received a copy of the GNU General Public License\r
  15  * along with this program.  If not, see <http://www.gnu.org/licenses/>.\r
  16  */\r
  17 package org.mxchange.addressbook.manager.contact;\r
  18 \r
  19 import java.text.MessageFormat;\r
  20 import java.util.ArrayList;\r
  21 import java.util.Collections;\r
  22 import java.util.Iterator;\r
  23 import java.util.List;\r
  24 import org.mxchange.addressbook.UnhandledUserChoiceException;\r
  25 import org.mxchange.addressbook.client.Client;\r
  26 import org.mxchange.addressbook.contact.Contact;\r
  27 import org.mxchange.addressbook.contact.user.UserContact;\r
  28 import org.mxchange.addressbook.database.frontend.contact.ContactDatabaseFrontend;\r
  29 import org.mxchange.addressbook.database.frontend.contact.ContactWrapper;\r
  30 import org.mxchange.addressbook.manager.BaseManager;\r
  31 \r
  32 /**\r
  33  * A manager for contacts, please note that this implementation loads the whole\r
  34  * list into RAM.\r
  35  *\r
  36  * @author Roland Haeder\r
  37  * @version 0.0\r
  38  * @since 0.0\r
  39  */\r
  40 public class ContactManager extends BaseManager implements ManageableContact {\r
  41 \r
  42     /**\r
  43      * A ContactWrapper instance\r
  44      */\r
  45     private final ContactWrapper contactDatabase;\r
  46 \r
  47     /**\r
  48      * A list of all contacts\r
  49      */\r
  50     private final List<Contact> contacts;\r
  51 \r
  52     /**\r
  53      * @param maxContacts Maximum allowed contacts\r
  54      * @param client Client instance to use\r
  55      */\r
  56     public ContactManager (final int maxContacts, final Client client) {\r
  57         // Always call super constructor first\r
  58         super();\r
  59 \r
  60         // Init contacts\r
  61         this.contacts = new ArrayList<>(maxContacts);\r
  62 \r
  63         // Init database connection\r
  64         this.contactDatabase = new ContactDatabaseFrontend();\r
  65 \r
  66         // Read all entries\r
  67         this.contactDatabase.readAllContacts(this);\r
  68 \r
  69         // Debug message\r
  70         //* NOISY-DEBUG: */ this.getLogger().debug("client=" + client);\r
  71 \r
  72         // Init client\r
  73         this.setClient(client);\r
  74     }\r
  75 \r
  76     /**\r
  77      * Adds given Contact instance to list\r
  78      *\r
  79      * @param contact Contact instance to add\r
  80      */\r
  81     @Override\r
  82     public void addContact (final Contact contact) {\r
  83         this.contacts.add(contact);\r
  84     }\r
  85 \r
  86     /**\r
  87      * Let the user add a new other address\r
  88      */\r
  89     @Override\r
  90     public void addOtherAddress () {\r
  91         throw new UnsupportedOperationException("Not supported yet.");\r
  92     }\r
  93 \r
  94     /**\r
  95      * Let the user change other address\r
  96      */\r
  97     @Override\r
  98     public void changeOtherAddress () {\r
  99         throw new UnsupportedOperationException("Not supported yet.");\r
 100     }\r
 101 \r
 102     /**\r
 103      * Allows the user to change his/her own data\r
 104      */\r
 105     @Override\r
 106     public void changeOwnData () {\r
 107         /*\r
 108          * First check if the user has registered own contact, before that\r
 109          * nothing can be changed.\r
 110          */\r
 111         if (!this.isOwnContactAdded()) {\r
 112             // Not added\r
 113             this.getClient().outputMessage("Sie haben noch nicht Ihre Daten eingegeben.");\r
 114             \r
 115             // Skip any below code\r
 116             return;\r
 117         }\r
 118         \r
 119         // Instance\r
 120         Contact contact = this.getOwnContact();\r
 121         \r
 122         // It must be found\r
 123         assert(contact instanceof Contact);\r
 124         \r
 125         // Display contact\r
 126         contact.show(this.getClient());\r
 127         \r
 128         try {\r
 129             // Ask user what to change\r
 130             this.getClient().userChooseChangeContactData(contact);\r
 131         } catch (final UnhandledUserChoiceException ex) {\r
 132             this.getLogger().catching(ex);\r
 133         }\r
 134     }\r
 135 \r
 136     /**\r
 137      * Let the user delete other address\r
 138      */\r
 139     @Override\r
 140     public void deleteOtherAddress () {\r
 141         throw new UnsupportedOperationException("Not supported yet.");\r
 142     }\r
 143 \r
 144     /**\r
 145      * Let the user change address data\r
 146      * \r
 147      * @param contact Instance to change data\r
 148      * @param client Client instance to call back\r
 149      */\r
 150     @Override\r
 151     public void doChangeAddressData (final Contact contact, final Client client) {\r
 152         // First display it again\r
 153         client.displayAddressBox(contact);\r
 154 \r
 155         // Is it own data?\r
 156         if (contact.isOwnContact()) {\r
 157             // Own address data\r
 158             String street = this.enterOwnStreet();\r
 159 \r
 160             // Get zip code\r
 161             int zipCode = this.enterOwnZipCode();\r
 162 \r
 163             // Get city name\r
 164             String city = this.enterOwnCity();\r
 165 \r
 166             // Get country code\r
 167             String countryCode = this.enterOwnCountryCode();\r
 168 \r
 169             // Update address data\r
 170             contact.updateAddressData(street, zipCode, city, countryCode);\r
 171         } else {\r
 172             // Other contact's address data to change\r
 173             throw new UnsupportedOperationException("Changing contact entries not finished.");\r
 174         }\r
 175 \r
 176         // Flush whole list\r
 177         this.flush();\r
 178     }\r
 179 \r
 180     /**\r
 181      * Let the user change "name data"\r
 182      * \r
 183      * @param contact Instance to change data\r
 184      * @param client Client instance to call back\r
 185      */\r
 186     @Override\r
 187     public void doChangeNameData (final Contact contact, final Client client) {\r
 188         // First display them again\r
 189         client.displayNameBox(contact);\r
 190 \r
 191         // Is this own data?\r
 192         if (contact.isOwnContact()) {\r
 193             // Re-ask own data\r
 194             // Gender:\r
 195             char gender = this.enterOwnGender();\r
 196 \r
 197             // Surname\r
 198             String surname = this.enterOwnSurname();\r
 199 \r
 200             // Family name\r
 201             String familyName = this.enterOwnFamilyName();\r
 202 \r
 203             // And company\r
 204             String companyName = this.enterOwnCompanyName();\r
 205 \r
 206             // Update contact instance\r
 207             contact.updateNameData(gender, surname, familyName, companyName);\r
 208         } else {\r
 209             // Then re-ask them ...\r
 210             throw new UnsupportedOperationException("Changing contact entries not finished.");\r
 211         }\r
 212 \r
 213         // Flush whole list\r
 214         this.flush();\r
 215     }\r
 216 \r
 217     /**\r
 218      * Let the user change other data\r
 219      *\r
 220      * @param contact Instance to change data\r
 221      * @param client Client instance to call back\r
 222      * @todo Didn't handle birthday\r
 223      */\r
 224     @Override\r
 225     public void doChangeOtherData (final Contact contact, final Client client) {\r
 226         // First display them again\r
 227         client.displayOtherDataBox(contact);\r
 228 \r
 229         // Is this own data?\r
 230         if (contact.isOwnContact()) {\r
 231             // Re-ask own data\r
 232             // Phone number\r
 233             String phoneNumber = this.enterOwnPhoneNumber();\r
 234 \r
 235             // Phone number\r
 236             String cellNumber = this.enterOwnCellNumber();\r
 237 \r
 238             // Fax number\r
 239             String faxNumber = this.enterOwnFaxNumber();\r
 240 \r
 241             // Email address\r
 242             String email = this.enterOwnEmailAddress();\r
 243 \r
 244             // Comment\r
 245             String comment = this.enterOwnComment();\r
 246 \r
 247             // Update contact instance\r
 248             contact.updateOtherData(phoneNumber, cellNumber, faxNumber, email, null, comment);\r
 249         } else {\r
 250             // Then re-ask them ...\r
 251             throw new UnsupportedOperationException("Changing contact entries not finished.");\r
 252         }\r
 253 \r
 254         // Flush whole list\r
 255         this.flush();\r
 256     }\r
 257 \r
 258     /**\r
 259      * Asks user for own data\r
 260      */\r
 261     @Override\r
 262     public void doEnterOwnData () {\r
 263         // First ask for gender\r
 264         char gender = this.enterOwnGender();\r
 265 \r
 266         // 2nd for surname\r
 267         String surname = this.enterOwnSurname();\r
 268         \r
 269         // And 3rd for family name\r
 270         String familyName = this.enterOwnFamilyName();\r
 271 \r
 272         // Company name ...\r
 273         String companyName = this.enterOwnCompanyName();\r
 274 \r
 275         // Construct UserContact instance\r
 276         Contact contact = new UserContact(gender, surname, familyName, companyName);\r
 277 \r
 278         // Add it to contact "book"\r
 279         this.registerContact(contact);\r
 280     }\r
 281 \r
 282     /**\r
 283      * Shuts down this contact manager\r
 284      */\r
 285     @Override\r
 286     public void doShutdown () {\r
 287         // Shut down the database layer\r
 288         this.contactDatabase.doShutdown();\r
 289     }\r
 290 \r
 291     /**\r
 292      * Getter for whole contact list\r
 293      * \r
 294      * @return List of all contacts\r
 295      */\r
 296     @Override\r
 297     public List<Contact> getList () {\r
 298         return Collections.unmodifiableList(this.contacts);\r
 299     }\r
 300 \r
 301     @Override\r
 302     public void listContacts () {\r
 303         throw new UnsupportedOperationException("Not supported yet.");\r
 304     }\r
 305 \r
 306     /**\r
 307      * Adds given contact to address book and flushes all entries to database\r
 308      *\r
 309      * @param contact Contact being added\r
 310      * @todo Add check for book size\r
 311      */\r
 312     @Override\r
 313     public void registerContact (final Contact contact) {\r
 314         // Check if contact is found\r
 315         if (this.isContactAlreadyAdded(contact)) {\r
 316             // Contact already added\r
 317             // @todo Do something here\r
 318         } else if ((contact.isOwnContact()) && (this.isOwnContactAdded())) {\r
 319             // Own contact already added\r
 320             // @todo Do something\r
 321         }\r
 322         \r
 323         // Debug message\r
 324         /* NOISY-DEBUG: */ this.getLogger().debug(MessageFormat.format("Adding '{0}' '{1}' at pos '{2}' ...", contact.getSurname(), contact.getFamilyName(), this.size()));\r
 325         \r
 326         // Add contact to internal list\r
 327         this.addContact(contact);\r
 328         \r
 329         // Flush whole list\r
 330         this.flush();\r
 331     }\r
 332 \r
 333     @Override\r
 334     public void searchContacts () {\r
 335         throw new UnsupportedOperationException("Not supported yet.");\r
 336     }\r
 337 \r
 338     /**\r
 339      * Getter for size\r
 340      *\r
 341      * @return size of contact "book"\r
 342      */\r
 343     @Override\r
 344     public int size () {\r
 345         return this.contacts.size();\r
 346     }\r
 347 \r
 348     /**\r
 349      * Asks the user for his/her cellphone number\r
 350      * \r
 351      * @return User's cellphone number\r
 352      */\r
 353     private String enterOwnCellNumber () {\r
 354         return this.getClient().enterString(5, 30, "Bitte geben Sie Ihre Handynummer an: ", true);\r
 355     }\r
 356 \r
 357     /**\r
 358      * Asks the user for his/her city's name\r
 359      *\r
 360      * @return City's name of the user\r
 361      */\r
 362     private String enterOwnCity () {\r
 363         return this.getClient().enterString(3, 50, "Bitte geben Sie Ihre Wohnort ein: ", false);\r
 364     }\r
 365 \r
 366     /**\r
 367      * Asks the user for his/her city's name\r
 368      *\r
 369      * @return City's name of the user\r
 370      */\r
 371     private String enterOwnComment () {\r
 372         return this.getClient().enterString(0, 100, "Kommentar zu Ihrem Eintrag: ", true);\r
 373     }\r
 374 \r
 375     /**\r
 376      * Asks the user for his/her company name\r
 377      * \r
 378      * @return User's company name\r
 379      */\r
 380     private String enterOwnCompanyName () {\r
 381         return this.getClient().enterString(5, 50, "Bitte geben Sie Ihre Firmenbezeichnung ein: ", true);\r
 382     }\r
 383 \r
 384     /**\r
 385      * Asks user for his/her own country code\r
 386      * \r
 387      * @return User's own country code\r
 388      */\r
 389     private String enterOwnCountryCode () {\r
 390         return this.getClient().enterString(2, 2, "Bitte geben Sie den zweistelligen Ländercode von Ihrem Land ein: ", false).toUpperCase();\r
 391     }\r
 392 \r
 393     /**\r
 394      * Asks user for his/her own country code\r
 395      * \r
 396      * @return User's own country code\r
 397      */\r
 398     private String enterOwnEmailAddress () {\r
 399         return this.getClient().enterString(10, 50, "Bitte geben Sie Ihre Email-Adresse ein: ", true);\r
 400     }\r
 401 \r
 402     /**\r
 403      * Asks the user for family name\r
 404      * \r
 405      * @return Family name of the user\r
 406      */\r
 407     private String enterOwnFamilyName () {\r
 408         return this.getClient().enterString(2, 50, "Bitte geben Sie Ihren Nachnamen ein: ", false);\r
 409     }\r
 410 \r
 411     /**\r
 412      * Asks the user for family name\r
 413      * \r
 414      * @return Family name of the user\r
 415      */\r
 416     private String enterOwnFaxNumber () {\r
 417         return this.getClient().enterString(5, 30, "Bitte geben Sie Ihre Faxnummer an: ", true);\r
 418     }\r
 419 \r
 420     /**\r
 421      * Asks the user for gender, until a valid has been entered\r
 422      * \r
 423      * @return Gender of the user\r
 424      */\r
 425     private char enterOwnGender () {\r
 426         return this.getClient().enterChar(new char[] {'M', 'F', 'C'}, "Bitte geben Sie die Anrede ein: (M=Herr, F=Frau, C=Firma): ");\r
 427     }\r
 428 \r
 429     /**\r
 430      * Asks the user for phone number\r
 431      * \r
 432      * @return Phone number of the user\r
 433      */\r
 434     private String enterOwnPhoneNumber () {\r
 435         return this.getClient().enterString(5, 30, "Bitte geben Sie Ihre Telefonnummer an: ", true);\r
 436     }\r
 437 \r
 438     /**\r
 439      * Asks the user for own street (including number)\r
 440      */\r
 441     private String enterOwnStreet () {\r
 442         return this.getClient().enterString(5, 50, "Bitte geben Sie Ihre Strasse und Hausnummer ein: ", false);\r
 443     }\r
 444 \r
 445     /**\r
 446      * Asks the user for surname\r
 447      * @return Surname of the user\r
 448      */\r
 449     private String enterOwnSurname () {\r
 450         return this.getClient().enterString(2, 50, "Bitte geben Sie Ihren Vornamen ein: ", false);\r
 451     }\r
 452 \r
 453     /**\r
 454      * Asks the user for own ZIP code\r
 455      * @return ZIP code\r
 456      */\r
 457     private int enterOwnZipCode () {\r
 458         return this.getClient().enterInt(0, 99_999, "Bitte geben Sie Ihre Postleitzahl ein: ");\r
 459     }\r
 460 \r
 461     /**\r
 462      * Flushes all entries by calling database backend\r
 463      */\r
 464     private void flush () {\r
 465         // Flusgh all\r
 466         this.getContactDatabase().flushAllContacts(this);\r
 467     }\r
 468 \r
 469     /**\r
 470      * A ContactWrapper instance\r
 471      *\r
 472      * @return the database\r
 473      */\r
 474     private ContactWrapper getContactDatabase () {\r
 475         return this.contactDatabase;\r
 476     }\r
 477 \r
 478     /**\r
 479      * "Getter" for own contact instance or null if not found\r
 480      *\r
 481      * @return Contact instance or null\r
 482      */\r
 483     private Contact getOwnContact () {\r
 484         // Now get it back from address book, first get an iterator\r
 485         Iterator<Contact> iterator = this.contacts.iterator();\r
 486 \r
 487         // Init instance\r
 488         Contact contact = null;\r
 489 \r
 490         // Search all contact\r
 491         while (iterator.hasNext()) {\r
 492             // Get next instance\r
 493             Contact next = iterator.next();\r
 494 \r
 495             // Is this own contact?\r
 496             if (next.isOwnContact()) {\r
 497                 // Found it\r
 498                 contact = next;\r
 499                 break;\r
 500                 \r
 501             }\r
 502         }\r
 503 \r
 504         // Return instance or null\r
 505         return contact;\r
 506     }\r
 507 \r
 508     /**\r
 509      * Checks whether given contact was found in "address book"\r
 510      *\r
 511      * @param checkContact Contact to be checked\r
 512      * @return TRUE if found, FALSE if not found\r
 513      */\r
 514     private boolean isContactAlreadyAdded (final Contact checkContact) throws NullPointerException {\r
 515         // Default is not found\r
 516         boolean isFound = false;\r
 517 \r
 518         // Debug message\r
 519         //* NOISY-DEBUG: */ this.getLogger().debug("Checking '" +  this.contacts.length + "' entries...");\r
 520 \r
 521         // Now get it back from address book, first get an iterator\r
 522         Iterator<Contact> iterator = this.contacts.iterator();\r
 523 \r
 524         // Check entries\r
 525         while (iterator.hasNext()) {\r
 526             // Get next entry\r
 527             Contact contact = iterator.next();\r
 528 \r
 529             // Debug message\r
 530             //* NOISY-DEBUG: */ this.getLogger().debug("contact=" + contact + ",checkContent=" + checkContact);\r
 531 \r
 532             // Is it valid?\r
 533             if ((contact instanceof Contact) && ((contact.equals(checkContact)))) {\r
 534                 // Found matching entry\r
 535                 isFound = true;\r
 536                 break;\r
 537             }\r
 538         }\r
 539 \r
 540         // Return result\r
 541         return isFound;\r
 542     }\r
 543 \r
 544     /**\r
 545      * Checks whether own contact is already added by checking all entries for\r
 546      * isOwnContact flag\r
 547      * \r
 548      * @return Whether own contact is already added\r
 549      */\r
 550     private boolean isOwnContactAdded () {\r
 551         // Default is not added\r
 552         boolean isAdded = false;\r
 553 \r
 554         // Now get it back from address book, first get an iterator\r
 555         Iterator<Contact> iterator = this.contacts.iterator();\r
 556 \r
 557         // Check entries\r
 558         while (iterator.hasNext()) {\r
 559             // Get next entry\r
 560             Contact contact = iterator.next();\r
 561 \r
 562             // Is it valid?\r
 563             if (contact instanceof Contact) {\r
 564                 // Get flag\r
 565                 isAdded = contact.isOwnContact();\r
 566 \r
 567                 // Is this own contact?\r
 568                 if (isAdded) {\r
 569                     // Then abort loop\r
 570                     break;\r
 571                 }\r
 572             }\r
 573         }\r
 574         // Return result\r
 575         return isAdded;\r
 576     }\r
 577 }\r