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

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