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