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 com.google.common.base.Function;
40 import com.google.common.base.Predicate;
41 import com.google.common.primitives.Ints;
42 import freenet.keys.FreenetURI;
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. */
73 * The possible values for the “show custom avatars” option.
75 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
77 public static enum ShowCustomAvatars {
79 /** Never show custom avatars. */
82 /** Only show custom avatars of followed Sones. */
85 /** Only show custom avatars of Sones you manually trust. */
88 /** Only show custom avatars of automatically trusted Sones. */
91 /** Always show custom avatars. */
96 /** comparator that sorts Sones by their nice name. */
97 public static final Comparator<Sone> NICE_NAME_COMPARATOR = new Comparator<Sone>() {
100 public int compare(Sone leftSone, Sone rightSone) {
101 int diff = SoneAccessor.getNiceName(leftSone).compareToIgnoreCase(SoneAccessor.getNiceName(rightSone));
105 return leftSone.getId().compareToIgnoreCase(rightSone.getId());
110 /** Comparator that sorts Sones by last activity (least recent active first). */
111 public static final Comparator<Sone> LAST_ACTIVITY_COMPARATOR = new Comparator<Sone>() {
114 public int compare(Sone firstSone, Sone secondSone) {
115 return (int) Math.min(Integer.MAX_VALUE, Math.max(Integer.MIN_VALUE, secondSone.getTime() - firstSone.getTime()));
119 /** Comparator that sorts Sones by numbers of posts (descending). */
120 public static final Comparator<Sone> POST_COUNT_COMPARATOR = new Comparator<Sone>() {
126 public int compare(Sone leftSone, Sone rightSone) {
127 return (leftSone.getPosts().size() != rightSone.getPosts().size()) ? (rightSone.getPosts().size() - leftSone.getPosts().size()) : (rightSone.getReplies().size() - leftSone.getReplies().size());
131 /** Comparator that sorts Sones by number of images (descending). */
132 public static final Comparator<Sone> IMAGE_COUNT_COMPARATOR = new Comparator<Sone>() {
138 public int compare(Sone leftSone, Sone rightSone) {
139 int rightSoneImageCount = from(asList(rightSone.getRootAlbum())).transformAndConcat(FLATTENER).transformAndConcat(IMAGES).size();
140 int leftSoneImageCount = from(asList(leftSone.getRootAlbum())).transformAndConcat(FLATTENER).transformAndConcat(IMAGES).size();
141 /* sort descending. */
142 return Ints.compare(rightSoneImageCount, leftSoneImageCount);
146 /** Filter to remove Sones that have not been downloaded. */
147 public static final Predicate<Sone> EMPTY_SONE_FILTER = new Predicate<Sone>() {
150 public boolean apply(Sone sone) {
151 return (sone == null) ? false : sone.getTime() != 0;
155 /** Filter that matches all {@link Sone#isLocal() local Sones}. */
156 public static final Predicate<Sone> LOCAL_SONE_FILTER = new Predicate<Sone>() {
159 public boolean apply(Sone sone) {
160 return (sone == null) ? false : sone.isLocal();
165 /** Filter that matches Sones that have at least one album. */
166 public static final Predicate<Sone> HAS_ALBUM_FILTER = new Predicate<Sone>() {
169 public boolean apply(Sone sone) {
170 return (sone == null) ? false : !sone.getRootAlbum().getAlbums().isEmpty();
174 public static final Function<Sone, FreenetURI> TO_FREENET_URI = new Function<Sone, FreenetURI>() {
176 public FreenetURI apply(Sone sone) {
177 return (sone == null) ? null : create(sone.getIdentity().getRequestUri());
181 public static final Function<Sone, List<Post>> TO_POSTS = new Function<Sone, List<Post>>() {
183 public List<Post> apply(Sone sone) {
184 return (sone == null) ? Collections.<Post>emptyList() : sone.getPosts();
189 * Returns the identity of this Sone.
191 * @return The identity of this Sone
193 Identity getIdentity();
196 * Returns the name of this Sone.
198 * @return The name of this Sone
203 * Returns whether this Sone is a local Sone.
205 * @return {@code true} if this Sone is a local Sone, {@code false} otherwise
210 * Returns the latest edition of this Sone.
212 * @return The latest edition of this Sone
214 long getLatestEdition();
217 * Return the time of the last inserted update of this Sone.
219 * @return The time of the update (in milliseconds since Jan 1, 1970 UTC)
224 * Sets the time of the last inserted update of this Sone.
227 * The time of the update (in milliseconds since Jan 1, 1970 UTC)
228 * @return This Sone (for method chaining)
230 Sone setTime(long time);
233 * Returns the status of this Sone.
235 * @return The status of this Sone
237 SoneStatus getStatus();
240 * Sets the new status of this Sone.
243 * The new status of this Sone
245 * @throws IllegalArgumentException
246 * if {@code status} is {@code null}
248 Sone setStatus(SoneStatus status);
251 * Returns a copy of the profile. If you want to update values in the profile
252 * of this Sone, update the values in the returned {@link Profile} and use
253 * {@link #setProfile(Profile)} to change the profile in this Sone.
255 * @return A copy of the profile
257 Profile getProfile();
260 * Sets the profile of this Sone. A copy of the given profile is stored so that
261 * subsequent modifications of the given profile are not reflected in this
267 void setProfile(Profile profile);
270 * Returns the client used by this Sone.
272 * @return The client used by this Sone, or {@code null}
277 * Returns whether this Sone is known.
279 * @return {@code true} if this Sone is known, {@code false} otherwise
284 * Sets whether this Sone is known.
287 * {@code true} if this Sone is known, {@code false} otherwise
290 Sone setKnown(boolean known);
293 * Returns all friend Sones of this Sone.
295 * @return The friend Sones of this Sone
297 List<String> getFriends();
300 * Returns whether this Sone has the given Sone as a friend Sone.
302 * @param friendSoneId
303 * The ID of the Sone to check for
304 * @return {@code true} if this Sone has the given Sone as a friend, {@code
307 boolean hasFriend(String friendSoneId);
310 * Adds the given Sone as a friend Sone.
313 * The friend Sone to add
314 * @return This Sone (for method chaining)
316 Sone addFriend(String friendSone);
319 * Removes the given Sone as a friend Sone.
321 * @param friendSoneId
322 * The ID of the friend Sone to remove
323 * @return This Sone (for method chaining)
325 Sone removeFriend(String friendSoneId);
328 * Returns the list of posts of this Sone, sorted by time, newest first.
330 * @return All posts of this Sone
332 List<Post> getPosts();
335 * Sets all posts of this Sone at once.
338 * The new (and only) posts of this Sone
339 * @return This Sone (for method chaining)
341 Sone setPosts(Collection<Post> posts);
344 * Adds the given post to this Sone. The post will not be added if its {@link
345 * Post#getSone() Sone} is not this Sone.
350 void addPost(Post post);
353 * Removes the given post from this Sone.
358 void removePost(Post post);
361 * Returns all replies this Sone made.
363 * @return All replies this Sone made
365 Set<PostReply> getReplies();
368 * Sets all replies of this Sone at once.
371 * The new (and only) replies of this Sone
372 * @return This Sone (for method chaining)
374 Sone setReplies(Collection<PostReply> replies);
377 * Adds a reply to this Sone. If the given reply was not made by this Sone,
378 * nothing is added to this Sone.
383 void addReply(PostReply reply);
386 * Removes a reply from this Sone.
389 * The reply to remove
391 void removeReply(PostReply reply);
394 * Returns the IDs of all liked posts.
396 * @return All liked posts’ IDs
398 Set<String> getLikedPostIds();
401 * Sets the IDs of all liked posts.
403 * @param likedPostIds
404 * All liked posts’ IDs
405 * @return This Sone (for method chaining)
407 Sone setLikePostIds(Set<String> likedPostIds);
410 * Checks whether the given post ID is liked by this Sone.
414 * @return {@code true} if this Sone likes the given post, {@code false}
417 boolean isLikedPostId(String postId);
420 * Adds the given post ID to the list of posts this Sone likes.
424 * @return This Sone (for method chaining)
426 Sone addLikedPostId(String postId);
429 * Removes the given post ID from the list of posts this Sone likes.
433 * @return This Sone (for method chaining)
435 Sone removeLikedPostId(String postId);
438 * Returns the IDs of all liked replies.
440 * @return All liked replies’ IDs
442 Set<String> getLikedReplyIds();
445 * Sets the IDs of all liked replies.
447 * @param likedReplyIds
448 * All liked replies’ IDs
449 * @return This Sone (for method chaining)
451 Sone setLikeReplyIds(Set<String> likedReplyIds);
454 * Checks whether the given reply ID is liked by this Sone.
457 * The ID of the reply
458 * @return {@code true} if this Sone likes the given reply, {@code false}
461 boolean isLikedReplyId(String replyId);
464 * Adds the given reply ID to the list of replies this Sone likes.
467 * The ID of the reply
468 * @return This Sone (for method chaining)
470 Sone addLikedReplyId(String replyId);
473 * Removes the given post ID from the list of replies this Sone likes.
476 * The ID of the reply
477 * @return This Sone (for method chaining)
479 Sone removeLikedReplyId(String replyId);
482 * Returns the root album that contains all visible albums of this Sone.
484 * @return The root album of this Sone
486 Album getRootAlbum();
489 * Returns Sone-specific options.
491 * @return The options of this Sone
493 Options getOptions();
496 * Sets the options of this Sone.
499 * The options of this Sone
501 /* TODO - remove this method again, maybe add an option provider */
502 void setOptions(Options options);
504 AlbumBuilder newAlbumBuilder() throws IllegalStateException;
506 PostBuilder newPostBuilder();
508 PostReplyBuilder newPostReplyBuilder(String postId) throws IllegalStateException;
514 Modifier setLatestEdition(long latestEdition);