src/org/mxchange/jaddressbook/model/addressbook/UserAddressbook.java

   1 /*
   2  * Copyright (C) 2016 - 2024 Free Software Foundation
   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.jaddressbook.model.addressbook;
  18
  19 import java.text.MessageFormat;
  20 import java.util.Date;
  21 import java.util.Objects;
  22 import javax.persistence.Basic;
  23 import javax.persistence.CascadeType;
  24 import javax.persistence.Column;
  25 import javax.persistence.Entity;
  26 import javax.persistence.EnumType;
  27 import javax.persistence.Enumerated;
  28 import javax.persistence.GeneratedValue;
  29 import javax.persistence.GenerationType;
  30 import javax.persistence.Id;
  31 import javax.persistence.JoinColumn;
  32 import javax.persistence.Lob;
  33 import javax.persistence.NamedQueries;
  34 import javax.persistence.NamedQuery;
  35 import javax.persistence.OneToOne;
  36 import javax.persistence.Table;
  37 import javax.persistence.Temporal;
  38 import javax.persistence.TemporalType;
  39 import javax.persistence.Transient;
  40 import org.apache.commons.lang3.StringUtils;
  41 import org.mxchange.jaddressbook.model.addressbook.status.AddressbokStatus;
  42 import org.mxchange.jcoreutils.comparable.ComparableUtils;
  43 import org.mxchange.jcoreutils.enums.EnumUtils;
  44 import org.mxchange.jusercore.model.user.LoginUser;
  45 import org.mxchange.jusercore.model.user.User;
  46 import org.mxchange.jusercore.model.utils.UserUtils;
  47
  48 /**
  49  * A POJO for user address books
  50  * <p>
  51  * @author Roland Häder<roland@mxchange.org>
  52  */
  53 @Entity (name = "addressbooks")
  54 @Table (name = "addressbooks")
  55 @NamedQueries (
  56                 {
  57                         @NamedQuery (name = "AllAddressbooks", query = "SELECT a FROM addressbooks AS a ORDER BY a.addressbookId ASC"),
  58                         @NamedQuery (name = "AllUsersAddressbooks", query = "SELECT a FROM addressbooks AS a WHERE a.addressbookUser = :param ORDER BY a.addressbookId ASC"),
  59                         @NamedQuery (name = "SearchUserAddressbookName", query = "SELECT a FROM addressbooks AS a WHERE a.addressbookUser = :user AND LOWER(a.addressbookName) LIKE LOWER(:name)")
  60                 }
  61 )
  62 @SuppressWarnings ("PersistenceUnitPresent")
  63 public class UserAddressbook implements Addressbook {
  64
  65         /**
  66          * Serial number
  67          */
  68         @Transient
  69         private static final long serialVersionUID = 176_573_148_678_169L;
  70
  71         /**
  72          * When this address book has been created
  73          */
  74         @Basic (optional = false)
  75         @Temporal (value = TemporalType.TIMESTAMP)
  76         @Column (name = "addressbook_entry_created", updatable = false, nullable = false)
  77         private Date addressbookEntryCreated;
  78
  79         /**
  80          * When this address book has been created
  81          */
  82         @Temporal (value = TemporalType.TIMESTAMP)
  83         @Column (name = "addressbook_entry_updated", insertable = false, nullable = false)
  84         private Date addressbookEntryUpdated;
  85
  86         /**
  87          * Id number
  88          */
  89         @Id
  90         @GeneratedValue (strategy = GenerationType.IDENTITY)
  91         @Column (name = "addressbook_id", nullable = false, updatable = false)
  92         private Long addressbookId;
  93
  94         /**
  95          * Last locked timestamp
  96          */
  97         @Temporal (TemporalType.TIMESTAMP)
  98         @Column (name = "addressbook_last_locked")
  99         private Date addressbookLastLocked;
 100
 101         /**
 102          * Last locked timestamp
 103          */
 104         @Lob
 105         @Column (name = "addressbook_last_locked_reason")
 106         private String addressbookLastLockedReason;
 107
 108         /**
 109          * Name for this address book
 110          */
 111         @Basic (optional = false)
 112         @Column (name = "addressbook_name", length = 50, nullable = false)
 113         private String addressbookName;
 114
 115         /**
 116          * Address book status
 117          */
 118         @Basic (optional = false)
 119         @Enumerated (EnumType.STRING)
 120         @Column (name = "addressbook_status", nullable = false, length = 10)
 121         private AddressbokStatus addressbookStatus;
 122
 123         /**
 124          * Connection to "users" table
 125          */
 126         @JoinColumn (name = "addressbook_user_id", nullable = false)
 127         @OneToOne (targetEntity = LoginUser.class, cascade = CascadeType.REFRESH, optional = false)
 128         private User addressbookUser;
 129
 130         /**
 131          * Public constructor with address book name
 132          * <p>
 133          * @param addressbookName Address book name
 134          * @param addressbookUser User instance
 135          */
 136         public UserAddressbook (final String addressbookName, final User addressbookUser) {
 137                 // Invoke default constructor
 138                 this();
 139
 140                 // Check all parameters
 141                 if (null == addressbookName) {
 142                         // Throw NPE
 143                         throw new NullPointerException("Parameter 'addressbookName' is null"); //NOI18N
 144                 } else if (addressbookName.isEmpty()) {
 145                         // Throw IAE
 146                         throw new IllegalArgumentException("Parameter 'addressbookName' is empty"); //NOI18N
 147                 } else if (null == addressbookUser) {
 148                         // Throw NPE again
 149                         throw new NullPointerException("Parameter 'addressbookUser' is null"); //NOI18N
 150                 } else if (addressbookUser.getUserId() == null) {
 151                         // Throw it again
 152                         throw new NullPointerException("addressbookUser.userId is null"); //NOI18N
 153                 } else if (addressbookUser.getUserId() < 1) {
 154                         // Throw IAE again
 155                         throw new IllegalArgumentException(MessageFormat.format("addressbookUser.userId={0} is invalid", addressbookUser.getUserId())); //NOI18N
 156                 }
 157
 158                 // Set name and user instance
 159                 this.addressbookName = addressbookName;
 160                 this.addressbookUser = addressbookUser;
 161         }
 162
 163         /**
 164          * Default constructor
 165          */
 166         public UserAddressbook () {
 167         }
 168
 169         @Override
 170         public int compareTo (final Addressbook addressbook) {
 171                 // Check parameter and return 0 if equal
 172                 if (null == addressbook) {
 173                         // Should not happen
 174                         throw new NullPointerException("addressbook is null"); //NOI18N
 175                 } else if (addressbook.equals(this)) {
 176                         // Same object, below "expensive" code can be safely skipped
 177                         return 0;
 178                 }
 179
 180                 // All comparators
 181                 final int comparators[] = {
 182                         // First name ...
 183                         StringUtils.compare(this.getAddressbookName(), addressbook.getAddressbookName()),
 184                         // ... status
 185                         EnumUtils.compare(this.getAddressbookStatus(), addressbook.getAddressbookStatus()),
 186                         // .. then user
 187                         UserUtils.compare(this.getAddressbookUser(), addressbook.getAddressbookUser())
 188                 };
 189
 190                 // Check all values
 191                 final int comparison = ComparableUtils.checkAll(comparators);
 192
 193                 // Return value
 194                 return comparison;
 195         }
 196
 197         @Override
 198         public boolean equals (final Object object) {
 199                 if (null == object) {
 200                         return false;
 201                 } else if (this.getClass() != object.getClass()) {
 202                         return false;
 203                 }
 204
 205                 final Addressbook addressbook = (Addressbook) object;
 206
 207                 if (!Objects.equals(this.getAddressbookId(), addressbook.getAddressbookId())) {
 208                         return false;
 209                 } else if (!Objects.equals(this.getAddressbookLastLocked(), addressbook.getAddressbookLastLocked())) {
 210                         return false;
 211                 } else if (!Objects.equals(this.getAddressbookLastLockedReason(), addressbook.getAddressbookLastLockedReason())) {
 212                         return false;
 213                 } else if (!Objects.equals(this.getAddressbookName(), addressbook.getAddressbookName())) {
 214                         return false;
 215                 } else if (!Objects.equals(this.getAddressbookStatus(), addressbook.getAddressbookStatus())) {
 216                         return false;
 217                 } else if (!Objects.equals(this.getAddressbookUser(), addressbook.getAddressbookUser())) {
 218                         return false;
 219                 }
 220
 221                 return true;
 222         }
 223
 224         @Override
 225         @SuppressWarnings ("ReturnOfDateField")
 226         public Date getAddressbookEntryCreated () {
 227                 return this.addressbookEntryCreated;
 228         }
 229
 230         @Override
 231         @SuppressWarnings ("AssignmentToDateFieldFromParameter")
 232         public void setAddressbookEntryCreated (final Date addressbookEntryCreated) {
 233                 this.addressbookEntryCreated = addressbookEntryCreated;
 234         }
 235
 236         @Override
 237         @SuppressWarnings ("ReturnOfDateField")
 238         public Date getAddressbookEntryUpdated () {
 239                 return this.addressbookEntryUpdated;
 240         }
 241
 242         @Override
 243         @SuppressWarnings ("AssignmentToDateFieldFromParameter")
 244         public void setAddressbookEntryUpdated (final Date addressbookEntryUpdated) {
 245                 this.addressbookEntryUpdated = addressbookEntryUpdated;
 246         }
 247
 248         @Override
 249         public Long getAddressbookId () {
 250                 return this.addressbookId;
 251         }
 252
 253         @Override
 254         public void setAddressbookId (final Long addressbookId) {
 255                 this.addressbookId = addressbookId;
 256         }
 257
 258         @Override
 259         @SuppressWarnings ("ReturnOfDateField")
 260         public Date getAddressbookLastLocked () {
 261                 return this.addressbookLastLocked;
 262         }
 263
 264         @Override
 265         @SuppressWarnings ("AssignmentToDateFieldFromParameter")
 266         public void setAddressbookLastLocked (final Date addressbookLastLocked) {
 267                 this.addressbookLastLocked = addressbookLastLocked;
 268         }
 269
 270         @Override
 271         public String getAddressbookLastLockedReason () {
 272                 return this.addressbookLastLockedReason;
 273         }
 274
 275         @Override
 276         public void setAddressbookLastLockedReason (final String addressbookLastLockedReason) {
 277                 this.addressbookLastLockedReason = addressbookLastLockedReason;
 278         }
 279
 280         @Override
 281         public String getAddressbookName () {
 282                 return this.addressbookName;
 283         }
 284
 285         @Override
 286         public void setAddressbookName (final String addressbookName) {
 287                 this.addressbookName = addressbookName;
 288         }
 289
 290         @Override
 291         public AddressbokStatus getAddressbookStatus () {
 292                 return this.addressbookStatus;
 293         }
 294
 295         @Override
 296         public void setAddressbookStatus (final AddressbokStatus addressbookStatus) {
 297                 this.addressbookStatus = addressbookStatus;
 298         }
 299
 300         @Override
 301         public User getAddressbookUser () {
 302                 return this.addressbookUser;
 303         }
 304
 305         @Override
 306         public void setAddressbookUser (final User addressbookUser) {
 307                 this.addressbookUser = addressbookUser;
 308         }
 309
 310         @Override
 311         public int hashCode () {
 312                 int hash = 7;
 313
 314                 hash = 59 * hash + Objects.hashCode(this.getAddressbookId());
 315                 hash = 59 * hash + Objects.hashCode(this.getAddressbookLastLocked());
 316                 hash = 59 * hash + Objects.hashCode(this.getAddressbookLastLockedReason());
 317                 hash = 59 * hash + Objects.hashCode(this.getAddressbookName());
 318                 hash = 59 * hash + Objects.hashCode(this.getAddressbookStatus());
 319                 hash = 59 * hash + Objects.hashCode(this.getAddressbookUser());
 320
 321                 return hash;
 322         }
 323
 324 }