2 * Sone - Album.java - Copyright © 2011–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 java.util.Arrays.asList;
21 import static java.util.Collections.emptyList;
23 import java.util.ArrayList;
24 import java.util.Collections;
25 import java.util.Comparator;
26 import java.util.List;
27 import javax.annotation.Nonnull;
29 import net.pterodactylus.sone.database.ImageBuilder;
31 import com.google.common.base.Function;
32 import com.google.common.base.Predicate;
33 import com.google.common.collect.FluentIterable;
34 import com.google.common.collect.ImmutableList;
37 * Container for images that can also contain nested {@link Album}s.
39 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
41 public interface Album extends Identified, Fingerprintable {
43 /** Compares two {@link Album}s by {@link #getTitle()}. */
44 Comparator<Album> TITLE_COMPARATOR = new Comparator<Album>() {
47 public int compare(Album leftAlbum, Album rightAlbum) {
48 return leftAlbum.getTitle().compareToIgnoreCase(rightAlbum.getTitle());
52 /** Function that flattens the given album and all albums beneath it. */
53 Function<Album, List<Album>> FLATTENER = new Function<Album, List<Album>>() {
57 public List<Album> apply(Album album) {
61 List<Album> albums = new ArrayList<Album>();
63 for (Album subAlbum : album.getAlbums()) {
64 albums.addAll(FluentIterable.from(ImmutableList.of(subAlbum)).transformAndConcat(FLATTENER).toList());
70 /** Function that transforms an album into the images it contains. */
71 Function<Album, List<Image>> IMAGES = new Function<Album, List<Image>>() {
75 public List<Image> apply(Album album) {
76 return (album != null) ? album.getImages() : Collections.<Image>emptyList();
81 * Filter that removes all albums that do not have any images in any album
84 Predicate<Album> NOT_EMPTY = new Predicate<Album>() {
87 public boolean apply(Album album) {
88 /* so, we flatten all albums below the given one and check whether at least one album… */
89 return FluentIterable.from(asList(album)).transformAndConcat(FLATTENER).anyMatch(new Predicate<Album>() {
92 public boolean apply(Album album) {
93 /* …contains any inserted images. */
94 return !album.getImages().isEmpty() && FluentIterable.from(album.getImages()).allMatch(new Predicate<Image>() {
97 public boolean apply(Image input) {
98 return input.isInserted();
107 * Returns the ID of this album.
109 * @return The ID of this album
114 * Returns the Sone this album belongs to.
116 * @return The Sone this album belongs to
121 * Sets the owner of the album. The owner can only be set as long as the
122 * current owner is {@code null}.
128 Album setSone(Sone sone);
131 * Returns the nested albums.
133 * @return The nested albums
135 List<Album> getAlbums();
138 * Adds an album to this album.
143 void addAlbum(Album album);
146 * Removes an album from this album.
149 * The album to remove
151 void removeAlbum(Album album);
154 * Moves the given album up in this album’s albums. If the album is already the
155 * first album, nothing happens.
158 * The album to move up
159 * @return The album that the given album swapped the place with, or
160 * <code>null</code> if the album did not change its place
162 Album moveAlbumUp(Album album);
165 * Moves the given album down in this album’s albums. If the album is already
166 * the last album, nothing happens.
169 * The album to move down
170 * @return The album that the given album swapped the place with, or
171 * <code>null</code> if the album did not change its place
173 Album moveAlbumDown(Album album);
176 * Returns the images in this album.
178 * @return The images in this album
180 List<Image> getImages();
183 * Removes the given image from this album.
186 * The image to remove
188 void removeImage(Image image);
191 * Moves the given image up in this album’s images. If the image is already the
192 * first image, nothing happens.
195 * The image to move up
196 * @return The image that the given image swapped the place with, or
197 * <code>null</code> if the image did not change its place
199 Image moveImageUp(Image image);
202 * Moves the given image down in this album’s images. If the image is already
203 * the last image, nothing happens.
206 * The image to move down
207 * @return The image that the given image swapped the place with, or
208 * <code>null</code> if the image did not change its place
210 Image moveImageDown(Image image);
213 * Returns the album image of this album, or {@code null} if no album image has
216 * @return The image to show when this album is listed
218 Image getAlbumImage();
221 * Returns whether this album contains any other albums or images.
223 * @return {@code true} if this album is empty, {@code false} otherwise
228 * Returns whether this album is an identitiy’s root album.
230 * @return {@code true} if this album is an identity’s root album, {@code
236 * Returns the parent album of this album.
238 * @return The parent album of this album, or {@code null} if this album does
244 * Sets the parent album of this album.
247 * The new parent album of this album
250 Album setParent(Album parent);
253 * Removes the parent album of this album.
257 Album removeParent();
260 * Returns the title of this album.
262 * @return The title of this album
267 * Returns the description of this album.
269 * @return The description of this album
271 String getDescription();
273 ImageBuilder newImageBuilder() throws IllegalStateException;
276 * Returns a modifier for this album.
278 * @return A modifier for this album
279 * @throws IllegalStateException
280 * if this album can not be modified
282 Modifier modify() throws IllegalStateException;
285 * Allows modifying an album. Modifications are only performed once {@link
286 * #update()} has succesfully returned a new album with the modifications
289 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
293 Modifier setTitle(String title);
295 Modifier setDescription(String description);
297 Modifier setAlbumImage(String imageId);
299 Album update() throws IllegalStateException;