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