2 * Sone - Sone.java - Copyright © 2010–2013 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.core.SoneUri.create;
23 import static net.pterodactylus.sone.data.Album.FLATTENER;
24 import static net.pterodactylus.sone.data.Album.IMAGES;
26 import java.util.Collection;
27 import java.util.Collections;
28 import java.util.Comparator;
29 import java.util.List;
32 import net.pterodactylus.sone.core.Options;
33 import net.pterodactylus.sone.database.AlbumBuilder;
34 import net.pterodactylus.sone.database.PostBuilder;
35 import net.pterodactylus.sone.database.PostReplyBuilder;
36 import net.pterodactylus.sone.freenet.wot.Identity;
37 import net.pterodactylus.sone.template.SoneAccessor;
39 import freenet.keys.FreenetURI;
41 import com.google.common.base.Function;
42 import com.google.common.base.Predicate;
43 import com.google.common.primitives.Ints;
46 * A Sone defines everything about a user: her profile, her status updates, her
47 * replies, her likes and dislikes, etc.
49 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
51 public interface Sone extends Identified, Fingerprintable, Comparable<Sone> {
54 * Enumeration for the possible states of a {@link Sone}.
56 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
58 public enum SoneStatus {
60 /** The Sone is unknown, i.e. not yet downloaded. */
63 /** The Sone is idle, i.e. not being downloaded or inserted. */
66 /** The Sone is currently being inserted. */
69 /** The Sone is currently being downloaded. */
74 * The possible values for the “show custom avatars” option.
76 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
78 public static enum ShowCustomAvatars {
80 /** Never show custom avatars. */
83 /** Only show custom avatars of followed Sones. */
86 /** Only show custom avatars of Sones you manually trust. */
89 /** Only show custom avatars of automatically trusted Sones. */
92 /** Always show custom avatars. */
97 /** comparator that sorts Sones by their nice name. */
98 public static final Comparator<Sone> NICE_NAME_COMPARATOR = new Comparator<Sone>() {
101 public int compare(Sone leftSone, Sone rightSone) {
102 int diff = SoneAccessor.getNiceName(leftSone).compareToIgnoreCase(SoneAccessor.getNiceName(rightSone));
106 return leftSone.getId().compareToIgnoreCase(rightSone.getId());
111 /** Comparator that sorts Sones by last activity (least recent active first). */
112 public static final Comparator<Sone> LAST_ACTIVITY_COMPARATOR = new Comparator<Sone>() {
115 public int compare(Sone firstSone, Sone secondSone) {
116 return (int) Math.min(Integer.MAX_VALUE, Math.max(Integer.MIN_VALUE, secondSone.getTime() - firstSone.getTime()));
120 /** Comparator that sorts Sones by numbers of posts (descending). */
121 public static final Comparator<Sone> POST_COUNT_COMPARATOR = new Comparator<Sone>() {
127 public int compare(Sone leftSone, Sone rightSone) {
128 return (leftSone.getPosts().size() != rightSone.getPosts().size()) ? (rightSone.getPosts().size() - leftSone.getPosts().size()) : (rightSone.getReplies().size() - leftSone.getReplies().size());
132 /** Comparator that sorts Sones by number of images (descending). */
133 public static final Comparator<Sone> IMAGE_COUNT_COMPARATOR = new Comparator<Sone>() {
139 public int compare(Sone leftSone, Sone rightSone) {
140 int rightSoneImageCount = from(asList(rightSone.getRootAlbum())).transformAndConcat(FLATTENER).transformAndConcat(IMAGES).size();
141 int leftSoneImageCount = from(asList(leftSone.getRootAlbum())).transformAndConcat(FLATTENER).transformAndConcat(IMAGES).size();
142 /* sort descending. */
143 return Ints.compare(rightSoneImageCount, leftSoneImageCount);
147 /** Filter to remove Sones that have not been downloaded. */
148 public static final Predicate<Sone> EMPTY_SONE_FILTER = new Predicate<Sone>() {
151 public boolean apply(Sone sone) {
152 return (sone == null) ? false : sone.getTime() != 0;
156 /** Filter that matches all {@link Sone#isLocal() local Sones}. */
157 public static final Predicate<Sone> LOCAL_SONE_FILTER = new Predicate<Sone>() {
160 public boolean apply(Sone sone) {
161 return (sone == null) ? false : sone.isLocal();
166 /** Filter that matches Sones that have at least one album. */
167 public static final Predicate<Sone> HAS_ALBUM_FILTER = new Predicate<Sone>() {
170 public boolean apply(Sone sone) {
171 return (sone == null) ? false : !sone.getRootAlbum().getAlbums().isEmpty();
175 public static final Function<Sone, FreenetURI> TO_FREENET_URI = new Function<Sone, FreenetURI>() {
177 public FreenetURI apply(Sone sone) {
178 return (sone == null) ? null : create(sone.getIdentity().getRequestUri());
182 public static final Function<Sone, List<Post>> TO_POSTS = new Function<Sone, List<Post>>() {
184 public List<Post> apply(Sone sone) {
185 return (sone == null) ? Collections.<Post>emptyList() : sone.getPosts();
190 * Returns the identity of this Sone.
192 * @return The identity of this Sone
194 Identity getIdentity();
197 * Returns the name of this Sone.
199 * @return The name of this Sone
204 * Returns whether this Sone is a local Sone.
206 * @return {@code true} if this Sone is a local Sone, {@code false} otherwise
211 * Returns the latest edition of this Sone.
213 * @return The latest edition of this Sone
215 long getLatestEdition();
218 * Return the time of the last inserted update of this Sone.
220 * @return The time of the update (in milliseconds since Jan 1, 1970 UTC)
225 * Sets the time of the last inserted update of this Sone.
228 * The time of the update (in milliseconds since Jan 1, 1970 UTC)
229 * @return This Sone (for method chaining)
231 Sone setTime(long time);
234 * Returns the status of this Sone.
236 * @return The status of this Sone
238 SoneStatus getStatus();
241 * Sets the new status of this Sone.
244 * The new status of this Sone
246 * @throws IllegalArgumentException
247 * if {@code status} is {@code null}
249 Sone setStatus(SoneStatus status);
252 * Returns a copy of the profile. If you want to update values in the profile
253 * of this Sone, update the values in the returned {@link Profile} and use
254 * {@link #setProfile(Profile)} to change the profile in this Sone.
256 * @return A copy of the profile
258 Profile getProfile();
261 * Sets the profile of this Sone. A copy of the given profile is stored so that
262 * subsequent modifications of the given profile are not reflected in this
268 void setProfile(Profile profile);
271 * Returns the client used by this Sone.
273 * @return The client used by this Sone, or {@code null}
278 * Returns whether this Sone is known.
280 * @return {@code true} if this Sone is known, {@code false} otherwise
285 * Sets whether this Sone is known.
288 * {@code true} if this Sone is known, {@code false} otherwise
291 Sone setKnown(boolean known);
294 * Returns all friend Sones of this Sone.
296 * @return The friend Sones of this Sone
298 Collection<String> getFriends();
301 * Returns whether this Sone has the given Sone as a friend Sone.
303 * @param friendSoneId
304 * The ID of the Sone to check for
305 * @return {@code true} if this Sone has the given Sone as a friend, {@code
308 boolean hasFriend(String friendSoneId);
311 * Adds the given Sone as a friend Sone.
314 * The friend Sone to add
315 * @return This Sone (for method chaining)
317 Sone addFriend(String friendSone);
320 * Removes the given Sone as a friend Sone.
322 * @param friendSoneId
323 * The ID of the friend Sone to remove
324 * @return This Sone (for method chaining)
326 Sone removeFriend(String friendSoneId);
329 * Returns the list of posts of this Sone, sorted by time, newest first.
331 * @return All posts of this Sone
333 List<Post> getPosts();
336 * Sets all posts of this Sone at once.
339 * The new (and only) posts of this Sone
340 * @return This Sone (for method chaining)
342 Sone setPosts(Collection<Post> posts);
345 * Adds the given post to this Sone. The post will not be added if its {@link
346 * Post#getSone() Sone} is not this Sone.
351 void addPost(Post post);
354 * Removes the given post from this Sone.
359 void removePost(Post post);
362 * Returns all replies this Sone made.
364 * @return All replies this Sone made
366 Set<PostReply> getReplies();
369 * Sets all replies of this Sone at once.
372 * The new (and only) replies of this Sone
373 * @return This Sone (for method chaining)
375 Sone setReplies(Collection<PostReply> replies);
378 * Adds a reply to this Sone. If the given reply was not made by this Sone,
379 * nothing is added to this Sone.
384 void addReply(PostReply reply);
387 * Removes a reply from this Sone.
390 * The reply to remove
392 void removeReply(PostReply reply);
395 * Returns the IDs of all liked posts.
397 * @return All liked posts’ IDs
399 Set<String> getLikedPostIds();
402 * Sets the IDs of all liked posts.
404 * @param likedPostIds
405 * All liked posts’ IDs
406 * @return This Sone (for method chaining)
408 Sone setLikePostIds(Set<String> likedPostIds);
411 * Checks whether the given post ID is liked by this Sone.
415 * @return {@code true} if this Sone likes the given post, {@code false}
418 boolean isLikedPostId(String postId);
421 * Removes the given post ID from the list of posts this Sone likes.
425 * @return This Sone (for method chaining)
427 Sone removeLikedPostId(String postId);
430 * Returns the IDs of all liked replies.
432 * @return All liked replies’ IDs
434 Set<String> getLikedReplyIds();
437 * Sets the IDs of all liked replies.
439 * @param likedReplyIds
440 * All liked replies’ IDs
441 * @return This Sone (for method chaining)
443 Sone setLikeReplyIds(Set<String> likedReplyIds);
446 * Checks whether the given reply ID is liked by this Sone.
449 * The ID of the reply
450 * @return {@code true} if this Sone likes the given reply, {@code false}
453 boolean isLikedReplyId(String replyId);
456 * Adds the given reply ID to the list of replies this Sone likes.
459 * The ID of the reply
460 * @return This Sone (for method chaining)
462 Sone addLikedReplyId(String replyId);
465 * Removes the given post ID from the list of replies this Sone likes.
468 * The ID of the reply
469 * @return This Sone (for method chaining)
471 Sone removeLikedReplyId(String replyId);
474 * Returns the root album that contains all visible albums of this Sone.
476 * @return The root album of this Sone
478 Album getRootAlbum();
481 * Returns Sone-specific options.
483 * @return The options of this Sone
485 Options getOptions();
488 * Sets the options of this Sone.
491 * The options of this Sone
493 /* TODO - remove this method again, maybe add an option provider */
494 void setOptions(Options options);
496 AlbumBuilder newAlbumBuilder() throws IllegalStateException;
498 PostBuilder newPostBuilder();
500 PostReplyBuilder newPostReplyBuilder(String postId) throws IllegalStateException;
506 Modifier setLatestEdition(long latestEdition);