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.jaddressbookshare.model.addressbook.shared;
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.GeneratedValue;
27 import javax.persistence.GenerationType;
28 import javax.persistence.Id;
29 import javax.persistence.JoinColumn;
30 import javax.persistence.NamedQueries;
31 import javax.persistence.NamedQuery;
32 import javax.persistence.OneToOne;
33 import javax.persistence.Table;
34 import javax.persistence.Temporal;
35 import javax.persistence.TemporalType;
36 import javax.persistence.Transient;
37 import org.mxchange.jaddressbook.model.addressbook.Addressbook;
38 import org.mxchange.jaddressbook.model.addressbook.UserAddressbook;
39 import org.mxchange.jcoreutils.comparable.ComparableUtils;
40 import org.mxchange.jusercore.model.user.LoginUser;
41 import org.mxchange.jusercore.model.user.User;
44 * A POJO for sharing address books with other users
46 * @author Roland Häder<roland@mxchange.org>
48 @Entity (name = "addressbook_shares")
49 @Table (name = "addressbook_shares")
53 name = "SearchUserSharedAddressbooks",
54 query = "SELECT s FROM addressbook_shares AS s WHERE s.shareUserOwner = :user ORDER BY s.shareId ASC"
57 name = "SearchShareeAddressbookShare",
58 query = "SELECT s FROM addressbook_shares AS s WHERE s.shareAddressbook = :addressbook AND s.shareUserSharee = :sharee"
62 @SuppressWarnings ("PersistenceUnitPresent")
63 public class AddressbookShare implements ShareableAddressbook {
69 private static final long serialVersionUID = 167_889_678_177_691_690L;
72 * Address book this share is for
74 @JoinColumn (name = "share_addressbook_id", nullable = false, updatable = false)
75 @OneToOne (targetEntity = UserAddressbook.class, cascade = CascadeType.REFRESH, optional = false)
76 private Addressbook shareAddressbook;
79 * When this share has been created
81 @Basic (optional = false)
82 @Temporal (TemporalType.TIMESTAMP)
83 @Column (name = "share_entry_created", updatable = false, nullable = false)
84 private Date shareEntryCreated;
87 * When this share has been updated
89 @Temporal (TemporalType.TIMESTAMP)
90 @Column (name = "share_entry_updated", insertable = false, nullable = false)
91 private Date shareEntryUpdated;
97 @GeneratedValue (strategy = GenerationType.IDENTITY)
98 @Column (name = "share_id", nullable = false, updatable = false)
102 * User who is owning the share
104 @JoinColumn (name = "share_owner_id", nullable = false, updatable = false)
105 @OneToOne (targetEntity = LoginUser.class, cascade = CascadeType.REFRESH, optional = false)
106 private User shareUserOwner;
109 * User the address book is shared with
111 @JoinColumn (name = "share_sharee_id", nullable = false, updatable = false)
112 @OneToOne (targetEntity = LoginUser.class, cascade = CascadeType.REFRESH, optional = false)
113 private User shareUserSharee;
116 * Default constructor
118 public AddressbookShare () {
122 * Constructor with address book and sharee instance. Both parameters must
123 * not be null, their id numbers must be set and the address book's user
124 * instance must be set and have a valid id set.
126 * @param addressbook Address book instance
127 * @param sharee User sharee instance
129 public AddressbookShare (final Addressbook addressbook, final User sharee) {
130 // Invoke default constructor
133 // Check all conditions
134 if (null == sharee) {
136 throw new NullPointerException("sharee is null"); //NOI18N
137 } else if (sharee.getUserId() == null) {
139 throw new NullPointerException("sharee.userId is null"); //NOI18N
140 } else if (sharee.getUserId() < 1) {
142 throw new IllegalStateException(MessageFormat.format("sharee.userId={0} is invalid", sharee.getUserId())); //NOI18N
143 } else if (null == addressbook) {
145 throw new NullPointerException("addressbook is null"); //NOI18N
146 } else if (addressbook.getAddressbookId() == null) {
148 throw new NullPointerException("addressbook.addressbookId is null"); //NOI18N
149 } else if (addressbook.getAddressbookId() < 1) {
151 throw new IllegalArgumentException(MessageFormat.format("addressbook.addressbookId={0} is invalid.", addressbook.getAddressbookId())); //NOI18N
152 } else if (Objects.equals(addressbook.getAddressbookUser(), sharee)) {
153 // Sharing with yourself!
154 throw new IllegalStateException("User tries to share with himself."); //NOI18N
158 this.shareAddressbook = addressbook;
159 this.shareUserOwner = addressbook.getAddressbookUser();
160 this.shareUserSharee = sharee;
164 public int compareTo (final ShareableAddressbook shareableAddressbook) {
165 // Checkparameter and return 0 if equal
166 if (null == shareableAddressbook) {
168 throw new NullPointerException("shareableAddressbook is null"); //NOI18N
169 } else if (shareableAddressbook.equals(this)) {
175 final int comparators[] = {
176 // First address book
177 this.getShareAddressbook().compareTo(shareableAddressbook.getShareAddressbook()),
179 this.getShareUserOwner().compareTo(shareableAddressbook.getShareUserOwner()),
181 this.getShareUserSharee().compareTo(shareableAddressbook.getShareUserSharee()),};
184 final int comparison = ComparableUtils.checkAll(comparators);
191 public boolean equals (final Object object) {
192 if (null == object) {
194 } else if (this.getClass() != object.getClass()) {
198 final ShareableAddressbook shared = (ShareableAddressbook) object;
200 if (!Objects.equals(this.getShareAddressbook(), shared.getShareAddressbook())) {
202 } else if (!Objects.equals(this.getShareId(), shared.getShareId())) {
204 } else if (!Objects.equals(this.getShareUserOwner(), shared.getShareUserOwner())) {
206 } else if (!Objects.equals(this.getShareUserSharee(), shared.getShareUserSharee())) {
210 return Objects.equals(this.getShareUserSharee(), shared.getShareUserSharee());
214 public Addressbook getShareAddressbook () {
215 return this.shareAddressbook;
219 public void setShareAddressbook (final Addressbook shareAddressbook) {
220 this.shareAddressbook = shareAddressbook;
224 @SuppressWarnings ("ReturnOfDateField")
225 public Date getShareEntryCreated () {
226 return this.shareEntryCreated;
230 @SuppressWarnings ("AssignmentToDateFieldFromParameter")
231 public void setShareEntryCreated (final Date shareEntryCreated) {
232 this.shareEntryCreated = shareEntryCreated;
236 @SuppressWarnings ("ReturnOfDateField")
237 public Date getShareEntryUpdated () {
238 return this.shareEntryUpdated;
242 @SuppressWarnings ("AssignmentToDateFieldFromParameter")
243 public void setShareEntryUpdated (final Date shareEntryUpdated) {
244 this.shareEntryUpdated = shareEntryUpdated;
248 public Long getShareId () {
253 public void setShareId (final Long shareId) {
254 this.shareId = shareId;
258 public User getShareUserOwner () {
259 return this.shareUserOwner;
263 public void setShareUserOwner (final User shareUserOwner) {
264 this.shareUserOwner = shareUserOwner;
268 public User getShareUserSharee () {
269 return this.shareUserSharee;
273 public void setShareUserSharee (final User shareUserSharee) {
274 this.shareUserSharee = shareUserSharee;
278 public int hashCode () {
281 hash = 19 * hash + Objects.hashCode(this.getShareAddressbook());
282 hash = 19 * hash + Objects.hashCode(this.getShareId());
283 hash = 19 * hash + Objects.hashCode(this.getShareUserOwner());
284 hash = 19 * hash + Objects.hashCode(this.getShareUserSharee());