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.util.ArrayList;\r
  20 import java.util.Iterator;\r
  21 import java.util.List;\r
  22 import org.mxchange.addressbook.client.Client;\r
  23 import org.mxchange.addressbook.contact.Contact;\r
  24 import org.mxchange.addressbook.contact.user.UserContact;\r
  25 import org.mxchange.addressbook.manager.BaseManager;\r
  26 \r
  27 /**\r
  28  * A manager for contacts\r
  29  *\r
  30  * @author Roland Haeder\r
  31  * @version 0.0\r
  32  * @since 0.0\r
  33  */\r
  34 public class ContactManager extends BaseManager implements ManageableContact {\r
  35 \r
  36     /**\r
  37      * All contacts\r
  38      */\r
  39     private final List<Contact> contacts;\r
  40 \r
  41     /**\r
  42      * @param maxContacts Maximum allowed contacts\r
  43      * @param client Client instance to use\r
  44      */\r
  45     public ContactManager (final int maxContacts, final Client client) {\r
  46         // Always call super constructor first\r
  47         super();\r
  48 \r
  49         // Init contacts\r
  50         this.contacts = new ArrayList<>(maxContacts);\r
  51 \r
  52         // Debug message\r
  53         //* NOISY-DEBUG: */ this.getLogger().debug("client=" + client);\r
  54 \r
  55         // Init client\r
  56         this.setClient(client);\r
  57     }\r
  58 \r
  59     /**\r
  60      * Adds given contact to address book\r
  61      *\r
  62      * @param contact Contact being added\r
  63      * @todo Add check for book size\r
  64      */\r
  65     @Override\r
  66     public void addContact (final Contact contact) {\r
  67         // Check if contact is found\r
  68         if (this.isContactAlreadyAdded(contact)) {\r
  69             // Contact already added\r
  70             // @todo Do something here\r
  71         } else if ((contact.isOwnContact()) && (this.isOwnContactAdded())) {\r
  72             // Own contact already added\r
  73             // @todo Do something\r
  74         }\r
  75 \r
  76         // Debug message\r
  77         /* NOISY-DEBUG: */ this.getLogger().debug("Adding '" + contact.getSurname() + "' '" + contact.getFamilyName() + "' at pos '" + this.size () + "' ...");\r
  78 \r
  79         // Add contact\r
  80         this.contacts.add(contact);\r
  81     }\r
  82 \r
  83     /**\r
  84      * Let the user add a new other address\r
  85      */\r
  86     @Override\r
  87     public void addOtherAddress () {\r
  88         throw new UnsupportedOperationException("Not supported yet.");\r
  89     }\r
  90 \r
  91     /**\r
  92      * Let the user change other address\r
  93      */\r
  94     @Override\r
  95     public void changeOtherAddress () {\r
  96         throw new UnsupportedOperationException("Not supported yet.");\r
  97     }\r
  98 \r
  99     /**\r
 100      * Allows the user to change his/her own data\r
 101      */\r
 102     @Override\r
 103     public void changeOwnData () {\r
 104         /*\r
 105          * First check if the user has registered own contact, before that \r
 106          * nothing can be changed.\r
 107          */\r
 108         if (!this.isOwnContactAdded()) {\r
 109             // Not added\r
 110             this.getClient().displayMessage("Sie haben noch nicht Ihre Daten eingegeben.");\r
 111 \r
 112             // Skip any below code\r
 113             return;\r
 114         }\r
 115 \r
 116         // Instance\r
 117         Contact contact = this.getOwnContact();\r
 118 \r
 119         // It must be found\r
 120         assert(contact instanceof Contact);\r
 121 \r
 122         // @TODO Unfinished\r
 123         throw new UnsupportedOperationException("Method is not finished.");\r
 124     }\r
 125 \r
 126     /**\r
 127      * Let the user delete other address\r
 128      */\r
 129     @Override\r
 130     public void deleteOtherAddress () {\r
 131         throw new UnsupportedOperationException("Not supported yet.");\r
 132     }\r
 133 \r
 134     /**\r
 135      * Asks user for own data\r
 136      */\r
 137     @Override\r
 138     public void enterOwnData () {\r
 139         // First ask for gender\r
 140         char gender = this.enterOwnGender();\r
 141 \r
 142         // 2nd for surname\r
 143         String surname = this.enterOwnSurname();\r
 144         \r
 145         // And 3rd for family name\r
 146         String familyName = this.enterOwnFamilyName();\r
 147 \r
 148         // Construct UserContact instance\r
 149         Contact contact = new UserContact(gender, surname, familyName);\r
 150 \r
 151         // Mark contact as own\r
 152         contact.enableFlagOwnContact();\r
 153 \r
 154         // Add it to contact "book"\r
 155         this.addContact(contact);\r
 156     }\r
 157 \r
 158     /**\r
 159      * Getter for size\r
 160      *\r
 161      * @return size of contact "book"\r
 162      */\r
 163     @Override\r
 164     public int size () {\r
 165         return this.contacts.size();\r
 166     }\r
 167 \r
 168     /**\r
 169      * Asks the user for family name\r
 170      * @return Family name of the user\r
 171      */\r
 172     private String enterOwnFamilyName () {\r
 173         return this.getClient().enterString(2, 50, "Bitte geben Sie Ihren Nachnamen ein: ");\r
 174     }\r
 175 \r
 176     /**\r
 177      * Asks the user for gender, until a valid has been entered\r
 178      * @return Gender of the user\r
 179      */\r
 180     private char enterOwnGender () {\r
 181         return this.getClient().enterChar(new char[] {'M', 'F', 'C'}, "Bitte geben Sie die Anrede ein: (M=Herr, F=Frau, C=Firma): ");\r
 182     }\r
 183 \r
 184     /**\r
 185      * Asks the user for surname\r
 186      * @return Surname of the user\r
 187      */\r
 188     private String enterOwnSurname () {\r
 189         return this.getClient().enterString(2, 50, "Bitte geben Sie Ihren Vornamen ein: ");\r
 190     }\r
 191 \r
 192     /**\r
 193      * "Getter" for own contact instance or null if not found\r
 194      *\r
 195      * @return Contact instance or null\r
 196      */\r
 197     private Contact getOwnContact () {\r
 198         // Now get it back from address book, first get an iterator\r
 199         Iterator<Contact> iterator = this.contacts.iterator();\r
 200 \r
 201         // Init instance\r
 202         Contact contact = null;\r
 203 \r
 204         // Search all contact\r
 205         while (iterator.hasNext()) {\r
 206             // Get next instance\r
 207             Contact next = iterator.next();\r
 208 \r
 209             // Is this own contact?\r
 210             if (next.isOwnContact()) {\r
 211                 // Found it\r
 212                 contact = next;\r
 213                 break;\r
 214                 \r
 215             }\r
 216         }\r
 217 \r
 218         // Return instance or null\r
 219         return contact;\r
 220     }\r
 221 \r
 222     /**\r
 223      * Checks whether given contact was found in "address book"\r
 224      *\r
 225      * @param checkContact Contact to be checked\r
 226      * @return TRUE if found, FALSE if not found\r
 227      */\r
 228     private boolean isContactAlreadyAdded (final Contact checkContact) throws NullPointerException {\r
 229         // Default is not found\r
 230         boolean isFound = false;\r
 231 \r
 232         // Debug message\r
 233         //* NOISY-DEBUG: */ this.getLogger().debug("Checking '" +  this.contacts.length + "' entries...");\r
 234 \r
 235         // Now get it back from address book, first get an iterator\r
 236         Iterator<Contact> iterator = this.contacts.iterator();\r
 237 \r
 238         // Check entries\r
 239         while (iterator.hasNext()) {\r
 240             // Get next entry\r
 241             Contact contact = iterator.next();\r
 242 \r
 243             // Debug message\r
 244             //* NOISY-DEBUG: */ this.getLogger().debug("contact=" + contact + ",checkContent=" + checkContact);\r
 245 \r
 246             // Is it valid?\r
 247             if ((contact instanceof Contact) && ((contact.equals(checkContact)))) {\r
 248                 // Found matching entry\r
 249                 isFound = true;\r
 250                 break;\r
 251             }\r
 252         }\r
 253 \r
 254         // Return result\r
 255         return isFound;\r
 256     }\r
 257 \r
 258     /**\r
 259      * Checks whether own contact is already added by checking all entries for isOwnContact flag\r
 260      * @return Whether own contact is already added\r
 261      */\r
 262     private boolean isOwnContactAdded () {\r
 263         // Default is not added\r
 264         boolean isAdded = false;\r
 265 \r
 266         // Now get it back from address book, first get an iterator\r
 267         Iterator<Contact> iterator = this.contacts.iterator();\r
 268 \r
 269         // Check entries\r
 270         while (iterator.hasNext()) {\r
 271             // Get next entry\r
 272             Contact contact = iterator.next();\r
 273 \r
 274             // Is it valid?\r
 275             if (contact instanceof Contact) {\r
 276                 // Get flag\r
 277                 isAdded = contact.isOwnContact();\r
 278 \r
 279                 // Is this own contact?\r
 280                 if (isAdded) {\r
 281                     // Then abort loop\r
 282                     break;\r
 283                 }\r
 284             }\r
 285         }\r
 286         // Return result\r
 287         return isAdded;\r
 288     }\r
 289 }\r