2 * Copyright (C) 2016 - 2022 Free Software Foundation
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.
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.
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/>.
17 package org.mxchange.jaddressbook.model.addressbook;
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;
49 * A POJO for user address books
51 * @author Roland Häder<roland@mxchange.org>
53 @Entity (name = "addressbooks")
54 @Table (name = "addressbooks")
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)")
62 @SuppressWarnings ("PersistenceUnitPresent")
63 public class UserAddressbook implements Addressbook {
69 private static final long serialVersionUID = 176_573_148_678_169L;
72 * When this address book has been created
74 @Basic (optional = false)
75 @Temporal (value = TemporalType.TIMESTAMP)
76 @Column (name = "addressbook_entry_created", updatable = false, nullable = false)
77 private Date addressbookEntryCreated;
80 * When this address book has been created
82 @Temporal (value = TemporalType.TIMESTAMP)
83 @Column (name = "addressbook_entry_updated", insertable = false, nullable = false)
84 private Date addressbookEntryUpdated;
90 @GeneratedValue (strategy = GenerationType.IDENTITY)
91 @Column (name = "addressbook_id", nullable = false, updatable = false)
92 private Long addressbookId;
95 * Last locked timestamp
97 @Temporal (TemporalType.TIMESTAMP)
98 @Column (name = "addressbook_last_locked")
99 private Date addressbookLastLocked;
102 * Last locked timestamp
105 @Column (name = "addressbook_last_locked_reason")
106 private String addressbookLastLockedReason;
109 * Name for this address book
111 @Basic (optional = false)
112 @Column (name = "addressbook_name", length = 50, nullable = false)
113 private String addressbookName;
116 * Address book status
118 @Basic (optional = false)
119 @Enumerated (EnumType.STRING)
120 @Column (name = "addressbook_status", nullable = false, length = 10)
121 private AddressbokStatus addressbookStatus;
124 * Connection to "users" table
126 @JoinColumn (name = "addressbook_user_id", nullable = false)
127 @OneToOne (targetEntity = LoginUser.class, cascade = CascadeType.REFRESH, optional = false)
128 private User addressbookUser;
131 * Public constructor with address book name
133 * @param addressbookName Address book name
134 * @param addressbookUser User instance
136 public UserAddressbook (final String addressbookName, final User addressbookUser) {
137 // Invoke default constructor
140 // Check all parameters
141 if (null == addressbookName) {
143 throw new NullPointerException("Parameter 'addressbookName' is null"); //NOI18N
144 } else if (addressbookName.isEmpty()) {
146 throw new IllegalArgumentException("Parameter 'addressbookName' is empty"); //NOI18N
147 } else if (null == addressbookUser) {
149 throw new NullPointerException("Parameter 'addressbookUser' is null"); //NOI18N
150 } else if (addressbookUser.getUserId() == null) {
152 throw new NullPointerException("addressbookUser.userId is null"); //NOI18N
153 } else if (addressbookUser.getUserId() < 1) {
155 throw new IllegalArgumentException(MessageFormat.format("addressbookUser.userId={0} is invalid", addressbookUser.getUserId())); //NOI18N
158 // Set name and user instance
159 this.addressbookName = addressbookName;
160 this.addressbookUser = addressbookUser;
164 * Default constructor
166 public UserAddressbook () {
170 public int compareTo (final Addressbook addressbook) {
171 // Check parameter and return 0 if equal
172 if (null == addressbook) {
174 throw new NullPointerException("addressbook is null"); //NOI18N
175 } else if (addressbook.equals(this)) {
176 // Same object, below "expensive" code can be safely skipped
181 final int comparators[] = {
183 StringUtils.compare(this.getAddressbookName(), addressbook.getAddressbookName()),
185 EnumUtils.compare(this.getAddressbookStatus(), addressbook.getAddressbookStatus()),
187 UserUtils.compare(this.getAddressbookUser(), addressbook.getAddressbookUser())
191 final int comparison = ComparableUtils.checkAll(comparators);
198 public boolean equals (final Object object) {
199 if (null == object) {
201 } else if (this.getClass() != object.getClass()) {
205 final Addressbook addressbook = (Addressbook) object;
207 if (!Objects.equals(this.getAddressbookId(), addressbook.getAddressbookId())) {
209 } else if (!Objects.equals(this.getAddressbookLastLocked(), addressbook.getAddressbookLastLocked())) {
211 } else if (!Objects.equals(this.getAddressbookLastLockedReason(), addressbook.getAddressbookLastLockedReason())) {
213 } else if (!Objects.equals(this.getAddressbookName(), addressbook.getAddressbookName())) {
215 } else if (!Objects.equals(this.getAddressbookStatus(), addressbook.getAddressbookStatus())) {
217 } else if (!Objects.equals(this.getAddressbookUser(), addressbook.getAddressbookUser())) {
225 @SuppressWarnings ("ReturnOfDateField")
226 public Date getAddressbookEntryCreated () {
227 return this.addressbookEntryCreated;
231 @SuppressWarnings ("AssignmentToDateFieldFromParameter")
232 public void setAddressbookEntryCreated (final Date addressbookEntryCreated) {
233 this.addressbookEntryCreated = addressbookEntryCreated;
237 @SuppressWarnings ("ReturnOfDateField")
238 public Date getAddressbookEntryUpdated () {
239 return this.addressbookEntryUpdated;
243 @SuppressWarnings ("AssignmentToDateFieldFromParameter")
244 public void setAddressbookEntryUpdated (final Date addressbookEntryUpdated) {
245 this.addressbookEntryUpdated = addressbookEntryUpdated;
249 public Long getAddressbookId () {
250 return this.addressbookId;
254 public void setAddressbookId (final Long addressbookId) {
255 this.addressbookId = addressbookId;
259 @SuppressWarnings ("ReturnOfDateField")
260 public Date getAddressbookLastLocked () {
261 return this.addressbookLastLocked;
265 @SuppressWarnings ("AssignmentToDateFieldFromParameter")
266 public void setAddressbookLastLocked (final Date addressbookLastLocked) {
267 this.addressbookLastLocked = addressbookLastLocked;
271 public String getAddressbookLastLockedReason () {
272 return this.addressbookLastLockedReason;
276 public void setAddressbookLastLockedReason (final String addressbookLastLockedReason) {
277 this.addressbookLastLockedReason = addressbookLastLockedReason;
281 public String getAddressbookName () {
282 return this.addressbookName;
286 public void setAddressbookName (final String addressbookName) {
287 this.addressbookName = addressbookName;
291 public AddressbokStatus getAddressbookStatus () {
292 return this.addressbookStatus;
296 public void setAddressbookStatus (final AddressbokStatus addressbookStatus) {
297 this.addressbookStatus = addressbookStatus;
301 public User getAddressbookUser () {
302 return this.addressbookUser;
306 public void setAddressbookUser (final User addressbookUser) {
307 this.addressbookUser = addressbookUser;
311 public int hashCode () {
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());