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

   1 /*
   2  * Copyright (C) 2016, 2017 Roland Häder
   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.Calendar;
  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.jusercore.model.user.LoginUser;
  41 import org.mxchange.jusercore.model.user.User;
  42
  43 /**
  44  * A POJO for user addressbooks
  45  * <p>
  46  * @author Roland Häder<roland@mxchange.org>
  47  */
  48 @Entity (name = "addressbooks")
  49 @Table (name = "addressbooks")
  50 @NamedQueries (
  51                 {
  52                         @NamedQuery (name = "AllUsersAddressbooks", query = "SELECT a FROM addressbooks AS a WHERE a.addressbookUser = :param ORDER BY a.addressbookId ASC"),
  53                         @NamedQuery (name = "SearchUserAddressbookName", query = "SELECT a FROM addressbooks AS a WHERE a.addressbookUser = :user AND LOWER(a.addressbookName) LIKE LOWER(:name)"),
  54                         @NamedQuery (name = "SearchAddressbookById", query = "SELECT a FROM addressbooks AS a WHERE a.addressbookId = :id")
  55                 }
  56 )
  57 @SuppressWarnings ("PersistenceUnitPresent")
  58 public class UserAddressbook implements Addressbook {
  59
  60         /**
  61          * Serial number
  62          */
  63         @Transient
  64         private static final long serialVersionUID = 176_573_148_678_169L;
  65
  66         /**
  67          * When this address book has been created
  68          */
  69         @Basic (optional = false)
  70         @Temporal (value = TemporalType.TIMESTAMP)
  71         @Column (name = "addressbook_created", nullable = false, updatable = false)
  72         private Calendar addressbookCreated;
  73
  74         /**
  75          * Id number
  76          */
  77         @Id
  78         @GeneratedValue (strategy = GenerationType.IDENTITY)
  79         @Column (name = "addressbook_id", nullable = false, updatable = false)
  80         private Long addressbookId;
  81
  82         /**
  83          * Last locked timestamp
  84          */
  85         @Temporal (TemporalType.TIMESTAMP)
  86         @Column (name = "addressbook_last_locked")
  87         private Calendar addressbookLastLocked;
  88
  89         /**
  90          * Last locked timestamp
  91          */
  92         @Lob
  93         @Column (name = "addressbook_last_locked_reason")
  94         private String addressbookLastLockedReason;
  95
  96         /**
  97          * Name for this address book
  98          */
  99         @Basic (optional = false)
 100         @Column (name = "addressbook_name", length = 50, nullable = false)
 101         private String addressbookName;
 102
 103         /**
 104          * Adress book status
 105          */
 106         @Basic (optional = false)
 107         @Enumerated (EnumType.STRING)
 108         @Column (name = "addressbook_status", nullable = false, length = 10)
 109         private AddressbokStatus addressbookStatus;
 110
 111         /**
 112          * Connection to "users" table
 113          */
 114         @JoinColumn (name = "addressbook_user_id", nullable = false)
 115         @OneToOne (targetEntity = LoginUser.class, cascade = CascadeType.REFRESH, optional = false)
 116         private User addressbookUser;
 117
 118         /**
 119          * Public constructor with address book name
 120          * <p>
 121          * @param addressbookName Address book name
 122          * @param addressbookUser User instance
 123          */
 124         public UserAddressbook (final String addressbookName, final User addressbookUser) {
 125                 // Call default constructor
 126                 this();
 127
 128                 // Set name and user instance
 129                 this.addressbookName = addressbookName;
 130                 this.addressbookUser = addressbookUser;
 131         }
 132
 133         /**
 134          * Default constructor
 135          */
 136         public UserAddressbook () {
 137                 // Set status to UNLOCKED
 138                 this.addressbookStatus = AddressbokStatus.UNLOCKED;
 139         }
 140
 141         @Override
 142         public boolean equals (final Object object) {
 143                 if (null == object) {
 144                         return false;
 145                 } else if (this.getClass() != object.getClass()) {
 146                         return false;
 147                 }
 148
 149                 final Addressbook other = (Addressbook) object;
 150
 151                 if (!Objects.equals(this.getAddressbookName(), other.getAddressbookName())) {
 152                         return false;
 153                 } else if (!Objects.equals(this.getAddressbookUser(), other.getAddressbookUser())) {
 154                         return false;
 155                 }
 156
 157                 return true;
 158         }
 159
 160         @Override
 161         public int hashCode () {
 162                 int hash = 7;
 163                 hash = 59 * hash + Objects.hashCode(this.getAddressbookName());
 164                 hash = 59 * hash + Objects.hashCode(this.getAddressbookUser());
 165                 return hash;
 166         }
 167
 168         @Override
 169         public Calendar getAddressbookCreated () {
 170                 return this.addressbookCreated;
 171         }
 172
 173         @Override
 174         public void setAddressbookCreated (final Calendar addressbookCreated) {
 175                 this.addressbookCreated = addressbookCreated;
 176         }
 177
 178         @Override
 179         public Long getAddressbookId () {
 180                 return this.addressbookId;
 181         }
 182
 183         @Override
 184         public void setAddressbookId (final Long addressbookId) {
 185                 this.addressbookId = addressbookId;
 186         }
 187
 188         @Override
 189         public Calendar getAddressbookLastLocked () {
 190                 return this.addressbookLastLocked;
 191         }
 192
 193         @Override
 194         public void setAddressbookLastLocked (final Calendar addressbookLastLocked) {
 195                 this.addressbookLastLocked = addressbookLastLocked;
 196         }
 197
 198         @Override
 199         public String getAddressbookLastLockedReason () {
 200                 return this.addressbookLastLockedReason;
 201         }
 202
 203         @Override
 204         public void setAddressbookLastLockedReason (final String addressbookLastLockedReason) {
 205                 this.addressbookLastLockedReason = addressbookLastLockedReason;
 206         }
 207
 208         @Override
 209         public String getAddressbookName () {
 210                 return this.addressbookName;
 211         }
 212
 213         @Override
 214         public void setAddressbookName (final String addressbookName) {
 215                 this.addressbookName = addressbookName;
 216         }
 217
 218         @Override
 219         public AddressbokStatus getAddressbookStatus () {
 220                 return this.addressbookStatus;
 221         }
 222
 223         @Override
 224         public void setAddressbookStatus (final AddressbokStatus addressbookStatus) {
 225                 this.addressbookStatus = addressbookStatus;
 226         }
 227
 228         @Override
 229         public User getAddressbookUser () {
 230                 return this.addressbookUser;
 231         }
 232
 233         @Override
 234         public void setAddressbookUser (final User addressbookUser) {
 235                 this.addressbookUser = addressbookUser;
 236         }
 237
 238 }