2 * Copyright (C) 2016, 2017 Roland Häder
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.Calendar;
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.jusercore.model.user.LoginUser;
40 import org.mxchange.jusercore.model.user.User;
43 * A POJO for sharing address books with other users
45 * @author Roland Häder<roland@mxchange.org>
47 @Entity (name = "addressbook_shares")
48 @Table (name = "addressbook_shares")
52 name = "SearchUserSharedAddressbooks",
53 query = "SELECT s FROM addressbook_shares AS s WHERE s.shareUserOwner = :user ORDER BY s.shareId ASC"
56 name = "SearchShareeAddressbookShare",
57 query = "SELECT s FROM addressbook_shares AS s WHERE s.shareAddressbook = :addressbook AND s.shareUserSharee = :sharee"
61 @SuppressWarnings ("PersistenceUnitPresent")
62 public class AddressbookShare implements ShareableAddressbook {
68 private static final long serialVersionUID = 167_889_678_177_691_690L;
71 * Address book this share is for
73 @JoinColumn (name = "share_addressbook_id", nullable = false, updatable = false)
74 @OneToOne (targetEntity = UserAddressbook.class, cascade = CascadeType.REFRESH, optional = false)
75 private Addressbook shareAddressbook;
78 * When this share has been created
80 @Basic (optional = false)
81 @Temporal (TemporalType.TIMESTAMP)
82 @Column (name = "share_created", nullable = false, updatable = false)
83 private Calendar shareCreated;
89 @GeneratedValue (strategy = GenerationType.IDENTITY)
90 @Column (name = "share_id", nullable = false, updatable = false)
94 * User who is owning the share
96 @JoinColumn (name = "share_owner_id", nullable = false, updatable = false)
97 @OneToOne (targetEntity = LoginUser.class, cascade = CascadeType.REFRESH, optional = false)
98 private User shareUserOwner;
101 * User the address book is shared with
103 @JoinColumn (name = "share_sharee_id", nullable = false, updatable = false)
104 @OneToOne (targetEntity = LoginUser.class, cascade = CascadeType.REFRESH, optional = false)
105 private User shareUserSharee;
108 * Default constructor
110 public AddressbookShare () {
114 * Constructor with address book and sharee instance. Both parameters must
115 * not be null, their id numbers must be set and the adress book's user
116 * instance must be set and have a valid id set.
118 * @param addressbook Address book instance
119 * @param sharee User sharee instance
121 public AddressbookShare (final Addressbook addressbook, final User sharee) {
122 // Call default constructor
125 // Check all conditions
126 if (null == sharee) {
128 throw new NullPointerException("sharee is null"); //NOI18N
129 } else if (sharee.getUserId() == null) {
131 throw new NullPointerException("sharee.userId is null"); //NOI18N
132 } else if (sharee.getUserId() < 1) {
134 throw new IllegalStateException(MessageFormat.format("sharee.userId={0} is invalid", sharee.getUserId())); //NOI18N
135 } else if (null == addressbook) {
137 throw new NullPointerException("addressbook is null"); //NOI18N
138 } else if (addressbook.getAddressbookId() == null) {
140 throw new NullPointerException("addressbook.addressbookId is null"); //NOI18N
141 } else if (addressbook.getAddressbookId() < 1) {
143 throw new IllegalArgumentException(MessageFormat.format("addressbook.addressbookId={0} is invalid.", addressbook.getAddressbookId())); //NOI18N
144 } else if (Objects.equals(addressbook.getAddressbookUser(), sharee)) {
145 // Sharing with yourself!
146 throw new IllegalStateException("User tries to share with himself."); //NOI18N
150 this.shareAddressbook = addressbook;
151 this.shareUserOwner = addressbook.getAddressbookUser();
152 this.shareUserSharee = sharee;
156 public boolean equals (final Object object) {
157 if (null == object) {
159 } else if (this.getClass() != object.getClass()) {
163 final ShareableAddressbook other = (ShareableAddressbook) object;
165 if (!Objects.equals(this.getShareAddressbook(), other.getShareAddressbook())) {
167 } else if (!Objects.equals(this.getShareUserOwner(), other.getShareUserOwner())) {
169 } else if (!Objects.equals(this.getShareUserOwner(), other.getShareUserOwner())) {
173 return Objects.equals(this.getShareUserSharee(), other.getShareUserSharee());
177 public int hashCode () {
179 hash = 19 * hash + Objects.hashCode(this.getShareAddressbook());
180 hash = 19 * hash + Objects.hashCode(this.getShareUserOwner());
181 hash = 19 * hash + Objects.hashCode(this.getShareUserSharee());
186 public Addressbook getShareAddressbook () {
187 return this.shareAddressbook;
191 public void setShareAddressbook (final Addressbook shareAddressbook) {
192 this.shareAddressbook = shareAddressbook;
196 @SuppressWarnings ("ReturnOfDateField")
197 public Calendar getShareCreated () {
198 return this.shareCreated;
202 @SuppressWarnings ("AssignmentToDateFieldFromParameter")
203 public void setShareCreated (final Calendar shareCreated) {
204 this.shareCreated = shareCreated;
208 public Long getShareId () {
213 public void setShareId (final Long shareId) {
214 this.shareId = shareId;
218 public User getShareUserOwner () {
219 return this.shareUserOwner;
223 public void setShareUserOwner (final User shareUserOwner) {
224 this.shareUserOwner = shareUserOwner;
228 public User getShareUserSharee () {
229 return this.shareUserSharee;
233 public void setShareUserSharee (final User shareUserSharee) {
234 this.shareUserSharee = shareUserSharee;