src/org/mxchange/jcontacts/contact/UserContact.java

   1 /*
   2  * Copyright (C) 2016 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.jcontacts.contact;
  18
  19 import java.util.Calendar;
  20 import java.util.Date;
  21 import java.util.Objects;
  22 import javax.annotation.PostConstruct;
  23 import javax.persistence.Basic;
  24 import javax.persistence.CascadeType;
  25 import javax.persistence.Column;
  26 import javax.persistence.Entity;
  27 import javax.persistence.EnumType;
  28 import javax.persistence.Enumerated;
  29 import javax.persistence.FetchType;
  30 import javax.persistence.GeneratedValue;
  31 import javax.persistence.GenerationType;
  32 import javax.persistence.Id;
  33 import javax.persistence.Index;
  34 import javax.persistence.JoinColumn;
  35 import javax.persistence.Lob;
  36 import javax.persistence.OneToOne;
  37 import javax.persistence.Table;
  38 import javax.persistence.Temporal;
  39 import javax.persistence.TemporalType;
  40 import org.mxchange.jcontacts.contact.gender.Gender;
  41 import org.mxchange.jcountry.data.Country;
  42 import org.mxchange.jcountry.data.CountryData;
  43 import org.mxchange.jphone.phonenumbers.cellphone.CellphoneNumber;
  44 import org.mxchange.jphone.phonenumbers.cellphone.DialableCellphoneNumber;
  45 import org.mxchange.jphone.phonenumbers.fax.DialableFaxNumber;
  46 import org.mxchange.jphone.phonenumbers.fax.FaxNumber;
  47 import org.mxchange.jphone.phonenumbers.landline.DialableLandLineNumber;
  48 import org.mxchange.jphone.phonenumbers.landline.LandLineNumber;
  49
  50 /**
  51  * A general contact class which should only be extended.
  52  * <p>
  53  * @author Roland Haeder<roland@mxchange.org>
  54  * @version 0.0
  55  */
  56 @Entity (name = "contacts")
  57 @Table (
  58                 name = "contacts",
  59                 indexes = {
  60                         @Index (
  61                                         name = "contact_gender",
  62                                         columnList = "contact_gender"
  63                         ),
  64                         @Index (
  65                                         name = "contact_email_address",
  66                                         unique = true,
  67                                         columnList = "contact_email_address"
  68                         )
  69                 }
  70 )
  71 public class UserContact implements Contact, Comparable<Contact> {
  72
  73         /**
  74          * Serial number
  75          */
  76         private static final long serialVersionUID = 58_744_284_981_863L;
  77
  78         /**
  79          * Birth day
  80          */
  81         @Column (name = "contact_birthday")
  82         @Temporal (TemporalType.DATE)
  83         private Date contactBirthday;
  84
  85         /**
  86          * Cellphone number
  87          */
  88         @JoinColumn (name = "contact_cellphone_number_id")
  89         @OneToOne (targetEntity = CellphoneNumber.class, cascade = CascadeType.ALL)
  90         private DialableCellphoneNumber contactCellphoneNumber;
  91
  92         /**
  93          * City
  94          */
  95         @Column (name = "contact_city", nullable = false, length = 100)
  96         private String contactCity;
  97
  98         /**
  99          * Optional comments
 100          */
 101         @Lob
 102         @Column (name = "contact_comment")
 103         private String contactComment;
 104
 105         /**
 106          * Country code
 107          */
 108         @JoinColumn (name = "contact_country_id", nullable = false)
 109         @OneToOne (targetEntity = CountryData.class, cascade = CascadeType.MERGE, optional = false, fetch = FetchType.EAGER)
 110         private Country contactCountry;
 111
 112         /**
 113          * When the contact has been created
 114          */
 115         @Basic (optional = false)
 116         @Temporal (TemporalType.TIMESTAMP)
 117         @Column (name = "contact_created", nullable = false)
 118         private Calendar contactCreated;
 119
 120         /**
 121          * Email address
 122          */
 123         @Column (name = "contact_email_address", length = 100, nullable = false)
 124         private String contactEmailAddress;
 125
 126         /**
 127          * Family name
 128          */
 129         @Basic (optional = false)
 130         @Column (name = "contact_family_name", length = 100, nullable = false)
 131         private String contactFamilyName;
 132
 133         /**
 134          * Fax number
 135          */
 136         @JoinColumn (name = "contact_fax_number_id")
 137         @OneToOne (targetEntity = FaxNumber.class, cascade = CascadeType.ALL)
 138         private DialableFaxNumber contactFaxNumber;
 139
 140         /**
 141          * First name
 142          */
 143         @Basic (optional = false)
 144         @Column (name = "contact_first_name", length = 100, nullable = false)
 145         private String contactFirstName;
 146
 147         /**
 148          * Gender instance
 149          */
 150         @Basic (optional = false)
 151         @Column (name = "contact_gender", nullable = false)
 152         @Enumerated (EnumType.STRING)
 153         private Gender contactGender;
 154
 155         /**
 156          * House number
 157          */
 158         @Column (name = "contact_house_number", length = 5, nullable = false)
 159         private Short contactHouseNumber;
 160
 161         /**
 162          * Id number
 163          */
 164         @Id
 165         @GeneratedValue (strategy = GenerationType.IDENTITY)
 166         @Column (name = "contact_id", length = 20, nullable = false, updatable = false)
 167         private Long contactId;
 168
 169         /**
 170          * Flag whether this contact is user's own data
 171          */
 172         @Column (name = "contact_own_contact", nullable = false)
 173         private Boolean contactOwnContact;
 174
 175         /**
 176          * Phone number
 177          */
 178         @JoinColumn (name = "contact_phone_number_id")
 179         @OneToOne (targetEntity = LandLineNumber.class, cascade = CascadeType.ALL)
 180         private DialableLandLineNumber contactPhoneNumber;
 181
 182         /**
 183          * Street
 184          */
 185         @Column (name = "contact_street", nullable = false)
 186         private String contactStreet;
 187
 188         /**
 189          * Title (Doctor, etc)
 190          */
 191         @Column (name = "contact_title")
 192         private String contactTitle;
 193
 194         /**
 195          * When the contact has been updated
 196          */
 197         @Temporal (TemporalType.TIMESTAMP)
 198         @Column (name = "contact_updated")
 199         private Calendar contactUpdated;
 200
 201         /**
 202          * ZIP code
 203          */
 204         @Column (name = "contact_zip_code", nullable = false, length = 6)
 205         private Integer contactZipCode;
 206
 207         /**
 208          * Constructor for contactGender and names
 209          * <p>
 210          * @param contactGender Gender instance
 211          * @param contactFirstName First name
 212          * @param contactFamilyName Family name
 213          */
 214         public UserContact (final Gender contactGender, final String contactFirstName, final String contactFamilyName) {
 215                 // Set all
 216                 this.contactGender = contactGender;
 217                 this.contactFirstName = contactFirstName;
 218                 this.contactFamilyName = contactFamilyName;
 219         }
 220
 221         /**
 222          * Default constructor
 223          */
 224         public UserContact () {
 225         }
 226
 227         /**
 228          * Compares two contacts with each other
 229          * <p>
 230          * @param contact Contact comparator
 231          * <p>
 232          * @return Comparison value
 233          */
 234         @Override
 235         public int compareTo (final Contact contact) {
 236                 // contact should not be null
 237                 if (null == contact) {
 238                         throw new NullPointerException("contact is null"); //NOI18N
 239                 }
 240
 241                 // Is the contactId the same?
 242                 if (Objects.equals(this.getContactId(), contact.getContactId())) {
 243                         // Same contactId, means same contact
 244                         return 0;
 245                 } else if (this.getContactId() > contact.getContactId()) {
 246                         // This contactId is larger than compared to
 247                         return -1;
 248                 }
 249
 250                 // The other contactId is larger
 251                 return 1;
 252         }
 253
 254         @Override
 255         public void copyAll (final Contact contact) {
 256                 // Copy all:
 257                 // - base data
 258                 this.setContactFirstName(contact.getContactFirstName());
 259                 this.setContactFamilyName(contact.getContactFamilyName());
 260                 this.setContactStreet(contact.getContactStreet());
 261                 this.setContactZipCode(contact.getContactZipCode());
 262                 this.setContactCity(contact.getContactCity());
 263                 this.setContactCountry(contact.getContactCountry());
 264
 265                 // - phone, fax, email
 266                 this.setContactPhoneNumber(contact.getContactPhoneNumber());
 267                 this.setContactFaxNumber(contact.getContactFaxNumber());
 268                 this.setContactCellphoneNumber(contact.getContactCellphoneNumber());
 269
 270                 // - other data
 271                 this.setContactBirthday(contact.getContactBirthday());
 272                 this.setContactComment(contact.getContactComment());
 273                 this.setContactCreated(contact.getContactCreated());
 274                 this.setContactUpdated(contact.getContactUpdated());
 275         }
 276
 277         @Override
 278         public boolean equals (final Object object) {
 279                 // Is it same type?
 280                 if (!(object instanceof UserContact)) {
 281                         // Not equal types
 282                         return false;
 283                 } else if (!(object instanceof Contact)) {
 284                         // Not correct interface
 285                         return false;
 286                 }
 287
 288                 // Try to cast
 289                 Contact contact = (Contact) object;
 290
 291                 // Now test some data TODO Definedly needs improvement
 292                 return ((this.getContactGender().equals(contact.getContactGender())) &&
 293                                 (this.getContactFirstName().toLowerCase().equals(contact.getContactFirstName().toLowerCase())) &&
 294                                 (this.getContactFamilyName().toLowerCase().equals(contact.getContactFamilyName().toLowerCase())));
 295         }
 296
 297         @Override
 298         public int hashCode () {
 299                 // Validate contactGender instance
 300                 assert (this.getContactGender() instanceof Gender) : "gender is not set."; //NOI18N
 301
 302                 int hash = 7;
 303                 hash = 79 * hash + Objects.hashCode(this.getContactFamilyName());
 304                 hash = 79 * hash + this.getContactGender().hashCode();
 305                 hash = 79 * hash + Objects.hashCode(this.getContactFirstName());
 306                 return hash;
 307         }
 308
 309         @Override
 310         public Date getContactBirthday () {
 311                 return this.contactBirthday;
 312         }
 313
 314         @Override
 315         public void setContactBirthday (final Date contactBirthday) {
 316                 this.contactBirthday = contactBirthday;
 317         }
 318
 319         @Override
 320         public DialableCellphoneNumber getContactCellphoneNumber () {
 321                 return this.contactCellphoneNumber;
 322         }
 323
 324         @Override
 325         public void setContactCellphoneNumber (final DialableCellphoneNumber contactCellphoneNumber) {
 326                 this.contactCellphoneNumber = contactCellphoneNumber;
 327         }
 328
 329         @Override
 330         public String getContactCity () {
 331                 return this.contactCity;
 332         }
 333
 334         @Override
 335         public void setContactCity (final String contactCity) {
 336                 this.contactCity = contactCity;
 337         }
 338
 339         @Override
 340         public String getContactComment () {
 341                 return this.contactComment;
 342         }
 343
 344         @Override
 345         public void setContactComment (final String contactComment) {
 346                 this.contactComment = contactComment;
 347         }
 348
 349         @Override
 350         public Country getContactCountry () {
 351                 return this.contactCountry;
 352         }
 353
 354         @Override
 355         public void setContactCountry (final Country contactCountry) {
 356                 this.contactCountry = contactCountry;
 357         }
 358
 359         @Override
 360         public Calendar getContactCreated () {
 361                 return this.contactCreated;
 362         }
 363
 364         @Override
 365         public void setContactCreated (final Calendar contactCreated) {
 366                 this.contactCreated = contactCreated;
 367         }
 368
 369         @Override
 370         public String getContactEmailAddress () {
 371                 return this.contactEmailAddress;
 372         }
 373
 374         @Override
 375         public void setContactEmailAddress (final String contactEmailAddress) {
 376                 this.contactEmailAddress = contactEmailAddress;
 377         }
 378
 379         @Override
 380         public String getContactFamilyName () {
 381                 //* NOISY-DEBUG: */ this.getLogger().logTrace("CALLED!");
 382                 return this.contactFamilyName;
 383         }
 384
 385         @Override
 386         public void setContactFamilyName (final String contactFamilyName) {
 387                 this.contactFamilyName = contactFamilyName;
 388         }
 389
 390         @Override
 391         public DialableFaxNumber getContactFaxNumber () {
 392                 return this.contactFaxNumber;
 393         }
 394
 395         @Override
 396         public void setContactFaxNumber (final DialableFaxNumber contactFaxNumber) {
 397                 this.contactFaxNumber = contactFaxNumber;
 398         }
 399
 400         @Override
 401         public String getContactFirstName () {
 402                 return this.contactFirstName;
 403         }
 404
 405         @Override
 406         public void setContactFirstName (final String contactFirstName) {
 407                 this.contactFirstName = contactFirstName;
 408         }
 409
 410         @Override
 411         public Gender getContactGender () {
 412                 return this.contactGender;
 413         }
 414
 415         @Override
 416         public void setContactGender (final Gender contactGender) {
 417                 this.contactGender = contactGender;
 418         }
 419
 420         @Override
 421         public Short getContactHouseNumber () {
 422                 return this.contactHouseNumber;
 423         }
 424
 425         @Override
 426         public void setContactHouseNumber (final Short contactHouseNumber) {
 427                 this.contactHouseNumber = contactHouseNumber;
 428         }
 429
 430         @Override
 431         public Long getContactId () {
 432                 return this.contactId;
 433         }
 434
 435         @Override
 436         public void setContactId (final Long contactId) {
 437                 this.contactId = contactId;
 438         }
 439
 440         @Override
 441         public void setContactOwnContact (final Boolean contactOwnContact) {
 442                 this.contactOwnContact = contactOwnContact;
 443         }
 444
 445         @Override
 446         public DialableLandLineNumber getContactPhoneNumber () {
 447                 return this.contactPhoneNumber;
 448         }
 449
 450         @Override
 451         public void setContactPhoneNumber (final DialableLandLineNumber contactPhoneNumber) {
 452                 this.contactPhoneNumber = contactPhoneNumber;
 453         }
 454
 455         @Override
 456         public String getContactStreet () {
 457                 return this.contactStreet;
 458         }
 459
 460         @Override
 461         public void setContactStreet (final String contactStreet) {
 462                 this.contactStreet = contactStreet;
 463         }
 464
 465         @Override
 466         public String getContactTitle () {
 467                 return this.contactTitle;
 468         }
 469
 470         @Override
 471         public void setContactTitle (final String contactTitle) {
 472                 this.contactTitle = contactTitle;
 473         }
 474
 475         @Override
 476         public Calendar getContactUpdated () {
 477                 return this.contactUpdated;
 478         }
 479
 480         @Override
 481         public void setContactUpdated (final Calendar contactUpdated) {
 482                 this.contactUpdated = contactUpdated;
 483         }
 484
 485         @Override
 486         public Integer getContactZipCode () {
 487                 return this.contactZipCode;
 488         }
 489
 490         @Override
 491         public void setContactZipCode (final Integer contactZipCode) {
 492                 this.contactZipCode = contactZipCode;
 493         }
 494
 495         /**
 496          * Initialization with fake contactGender UNKNOWN
 497          */
 498         @PostConstruct
 499         public void init () {
 500                 // Fake contactGender
 501                 this.contactGender = Gender.UNKNOWN;
 502         }
 503
 504         @Override
 505         public Boolean isOwnContact () {
 506                 return this.contactOwnContact;
 507         }
 508 }