2 * Sone - Sone.java - Copyright © 2010–2016 David Roden
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/>.
18 package net.pterodactylus.sone.data;
20 import static com.google.common.collect.FluentIterable.from;
21 import static java.util.Arrays.asList;
22 import static net.pterodactylus.sone.data.Album.FLATTENER;
23 import static net.pterodactylus.sone.data.Album.IMAGES;
25 import java.util.Collection;
26 import java.util.Collections;
27 import java.util.Comparator;
28 import java.util.List;
31 import javax.annotation.Nonnull;
32 import javax.annotation.Nullable;
34 import net.pterodactylus.sone.freenet.wot.Identity;
35 import net.pterodactylus.sone.freenet.wot.OwnIdentity;
36 import net.pterodactylus.sone.template.SoneAccessor;
38 import freenet.keys.FreenetURI;
40 import com.google.common.base.Function;
41 import com.google.common.base.Predicate;
42 import com.google.common.primitives.Ints;
45 * A Sone defines everything about a user: her profile, her status updates, her
46 * replies, her likes and dislikes, etc.
48 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
50 public interface Sone extends Identified, Fingerprintable, Comparable<Sone> {
53 * Enumeration for the possible states of a {@link Sone}.
55 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
57 public enum SoneStatus {
59 /** The Sone is unknown, i.e. not yet downloaded. */
62 /** The Sone is idle, i.e. not being downloaded or inserted. */
65 /** The Sone is currently being inserted. */
68 /** The Sone is currently being downloaded. */
72 /** comparator that sorts Sones by their nice name. */
73 public static final Comparator<Sone> NICE_NAME_COMPARATOR = new Comparator<Sone>() {
76 public int compare(Sone leftSone, Sone rightSone) {
77 int diff = SoneAccessor.getNiceName(leftSone).compareToIgnoreCase(SoneAccessor.getNiceName(rightSone));
81 return leftSone.getId().compareToIgnoreCase(rightSone.getId());
86 /** Comparator that sorts Sones by last activity (least recent active first). */
87 public static final Comparator<Sone> LAST_ACTIVITY_COMPARATOR = new Comparator<Sone>() {
90 public int compare(Sone firstSone, Sone secondSone) {
91 return (int) Math.min(Integer.MAX_VALUE, Math.max(Integer.MIN_VALUE, secondSone.getTime() - firstSone.getTime()));
95 /** Comparator that sorts Sones by numbers of posts (descending). */
96 public static final Comparator<Sone> POST_COUNT_COMPARATOR = new Comparator<Sone>() {
102 public int compare(Sone leftSone, Sone rightSone) {
103 return (leftSone.getPosts().size() != rightSone.getPosts().size()) ? (rightSone.getPosts().size() - leftSone.getPosts().size()) : (rightSone.getReplies().size() - leftSone.getReplies().size());
107 /** Comparator that sorts Sones by number of images (descending). */
108 public static final Comparator<Sone> IMAGE_COUNT_COMPARATOR = new Comparator<Sone>() {
114 public int compare(Sone leftSone, Sone rightSone) {
115 int rightSoneImageCount = from(asList(rightSone.getRootAlbum())).transformAndConcat(FLATTENER).transformAndConcat(IMAGES).size();
116 int leftSoneImageCount = from(asList(leftSone.getRootAlbum())).transformAndConcat(FLATTENER).transformAndConcat(IMAGES).size();
117 /* sort descending. */
118 return Ints.compare(rightSoneImageCount, leftSoneImageCount);
122 /** Filter to remove Sones that have not been downloaded. */
123 public static final Predicate<Sone> EMPTY_SONE_FILTER = new Predicate<Sone>() {
126 public boolean apply(Sone sone) {
127 return (sone != null) && (sone.getTime() != 0);
131 /** Filter that matches all {@link Sone#isLocal() local Sones}. */
132 public static final Predicate<Sone> LOCAL_SONE_FILTER = new Predicate<Sone>() {
135 public boolean apply(Sone sone) {
136 return (sone != null) && (sone.getIdentity() instanceof OwnIdentity);
141 /** Filter that matches Sones that have at least one album. */
142 public static final Predicate<Sone> HAS_ALBUM_FILTER = new Predicate<Sone>() {
145 public boolean apply(Sone sone) {
146 return (sone != null) && !sone.getRootAlbum().getAlbums().isEmpty();
150 public static final Function<Sone, List<Album>> toAllAlbums = new Function<Sone, List<Album>>() {
152 public List<Album> apply(@Nullable Sone sone) {
153 return (sone == null) ? Collections.<Album>emptyList() : FLATTENER.apply(
154 sone.getRootAlbum());
158 public static final Function<Sone, List<Image>> toAllImages = new Function<Sone, List<Image>>() {
160 public List<Image> apply(@Nullable Sone sone) {
161 return (sone == null) ? Collections.<Image>emptyList() :
162 from(FLATTENER.apply(sone.getRootAlbum()))
163 .transformAndConcat(IMAGES).toList();
168 * Returns the identity of this Sone.
170 * @return The identity of this Sone
172 Identity getIdentity();
175 * Returns the name of this Sone.
177 * @return The name of this Sone
182 * Returns whether this Sone is a local Sone.
184 * @return {@code true} if this Sone is a local Sone, {@code false} otherwise
189 * Returns the request URI of this Sone.
191 * @return The request URI of this Sone
193 FreenetURI getRequestUri();
196 * Returns the insert URI of this Sone.
198 * @return The insert URI of this Sone
200 FreenetURI getInsertUri();
203 * Returns the latest edition of this Sone.
205 * @return The latest edition of this Sone
207 long getLatestEdition();
210 * Sets the latest edition of this Sone. If the given latest edition is not
211 * greater than the current latest edition, the latest edition of this Sone is
214 * @param latestEdition
215 * The latest edition of this Sone
217 void setLatestEdition(long latestEdition);
220 * Return the time of the last inserted update of this Sone.
222 * @return The time of the update (in milliseconds since Jan 1, 1970 UTC)
227 * Sets the time of the last inserted update of this Sone.
230 * The time of the update (in milliseconds since Jan 1, 1970 UTC)
231 * @return This Sone (for method chaining)
233 Sone setTime(long time);
236 * Returns the status of this Sone.
238 * @return The status of this Sone
240 SoneStatus getStatus();
243 * Sets the new status of this Sone.
246 * The new status of this Sone
248 * @throws IllegalArgumentException
249 * if {@code status} is {@code null}
251 Sone setStatus(SoneStatus status);
254 * Returns a copy of the profile. If you want to update values in the profile
255 * of this Sone, update the values in the returned {@link Profile} and use
256 * {@link #setProfile(Profile)} to change the profile in this Sone.
258 * @return A copy of the profile
260 Profile getProfile();
263 * Sets the profile of this Sone. A copy of the given profile is stored so that
264 * subsequent modifications of the given profile are not reflected in this
270 void setProfile(Profile profile);
273 * Returns the client used by this Sone.
275 * @return The client used by this Sone, or {@code null}
280 * Sets the client used by this Sone.
283 * The client used by this Sone, or {@code null}
284 * @return This Sone (for method chaining)
286 Sone setClient(Client client);
289 * Returns whether this Sone is known.
291 * @return {@code true} if this Sone is known, {@code false} otherwise
296 * Sets whether this Sone is known.
299 * {@code true} if this Sone is known, {@code false} otherwise
302 Sone setKnown(boolean known);
305 * Returns all friend Sones of this Sone.
307 * @return The friend Sones of this Sone
309 Collection<String> getFriends();
312 * Returns whether this Sone has the given Sone as a friend Sone.
314 * @param friendSoneId
315 * The ID of the Sone to check for
316 * @return {@code true} if this Sone has the given Sone as a friend, {@code
319 boolean hasFriend(String friendSoneId);
322 * Returns the list of posts of this Sone, sorted by time, newest first.
324 * @return All posts of this Sone
326 List<Post> getPosts();
329 * Sets all posts of this Sone at once.
332 * The new (and only) posts of this Sone
333 * @return This Sone (for method chaining)
335 Sone setPosts(Collection<Post> posts);
338 * Adds the given post to this Sone. The post will not be added if its {@link
339 * Post#getSone() Sone} is not this Sone.
344 void addPost(Post post);
347 * Removes the given post from this Sone.
352 void removePost(Post post);
355 * Returns all replies this Sone made.
357 * @return All replies this Sone made
359 Set<PostReply> getReplies();
362 * Sets all replies of this Sone at once.
365 * The new (and only) replies of this Sone
366 * @return This Sone (for method chaining)
368 Sone setReplies(Collection<PostReply> replies);
371 * Adds a reply to this Sone. If the given reply was not made by this Sone,
372 * nothing is added to this Sone.
377 void addReply(PostReply reply);
380 * Removes a reply from this Sone.
383 * The reply to remove
385 void removeReply(PostReply reply);
388 * Returns the IDs of all liked posts.
390 * @return All liked posts’ IDs
392 Set<String> getLikedPostIds();
395 * Sets the IDs of all liked posts.
397 * @param likedPostIds
398 * All liked posts’ IDs
399 * @return This Sone (for method chaining)
401 Sone setLikePostIds(Set<String> likedPostIds);
404 * Checks whether the given post ID is liked by this Sone.
408 * @return {@code true} if this Sone likes the given post, {@code false}
411 boolean isLikedPostId(String postId);
414 * Adds the given post ID to the list of posts this Sone likes.
418 * @return This Sone (for method chaining)
420 Sone addLikedPostId(String postId);
423 * Removes the given post ID from the list of posts this Sone likes.
427 * @return This Sone (for method chaining)
429 Sone removeLikedPostId(String postId);
432 * Returns the IDs of all liked replies.
434 * @return All liked replies’ IDs
436 Set<String> getLikedReplyIds();
439 * Sets the IDs of all liked replies.
441 * @param likedReplyIds
442 * All liked replies’ IDs
443 * @return This Sone (for method chaining)
445 Sone setLikeReplyIds(Set<String> likedReplyIds);
448 * Checks whether the given reply ID is liked by this Sone.
451 * The ID of the reply
452 * @return {@code true} if this Sone likes the given reply, {@code false}
455 boolean isLikedReplyId(String replyId);
458 * Adds the given reply ID to the list of replies this Sone likes.
461 * The ID of the reply
462 * @return This Sone (for method chaining)
464 Sone addLikedReplyId(String replyId);
467 * Removes the given post ID from the list of replies this Sone likes.
470 * The ID of the reply
471 * @return This Sone (for method chaining)
473 Sone removeLikedReplyId(String replyId);
476 * Returns the root album that contains all visible albums of this Sone.
478 * @return The root album of this Sone
480 Album getRootAlbum();
483 * Returns Sone-specific options.
485 * @return The options of this Sone
487 SoneOptions getOptions();
490 * Sets the options of this Sone.
493 * The options of this Sone
495 /* TODO - remove this method again, maybe add an option provider */
496 void setOptions(SoneOptions options);