/*
- * Sone - Album.java - Copyright © 2011 David Roden
+ * Sone - Album.java - Copyright © 2011–2013 David Roden
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
package net.pterodactylus.sone.data;
+import static java.util.Arrays.asList;
+import static java.util.Collections.emptyList;
+
import java.util.ArrayList;
+import java.util.Collections;
+import java.util.Comparator;
import java.util.List;
-import java.util.UUID;
+import javax.annotation.Nonnull;
+
+import net.pterodactylus.sone.database.AlbumBuilder;
+import net.pterodactylus.sone.database.ImageBuilder;
+
+import com.google.common.base.Function;
+import com.google.common.base.Optional;
+import com.google.common.base.Predicate;
+import com.google.common.collect.FluentIterable;
+import com.google.common.collect.ImmutableList;
/**
* Container for images that can also contain nested {@link Album}s.
*
* @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
*/
-public class Album {
+public interface Album extends Identified, Fingerprintable {
- /** The ID of this album. */
- private final String id;
+ /** Compares two {@link Album}s by {@link #getTitle()}. */
+ Comparator<Album> TITLE_COMPARATOR = new Comparator<Album>() {
- /** Nested albums. */
- private final List<Album> albums = new ArrayList<Album>();
+ @Override
+ public int compare(Album leftAlbum, Album rightAlbum) {
+ return leftAlbum.getTitle().compareToIgnoreCase(rightAlbum.getTitle());
+ }
+ };
+
+ /** Function that flattens the given album and all albums beneath it. */
+ Function<Album, List<Album>> FLATTENER = new Function<Album, List<Album>>() {
+
+ @Override
+ @Nonnull
+ public List<Album> apply(Album album) {
+ if (album == null) {
+ return emptyList();
+ }
+ List<Album> albums = new ArrayList<Album>();
+ albums.add(album);
+ for (Album subAlbum : album.getAlbums()) {
+ albums.addAll(FluentIterable.from(ImmutableList.of(subAlbum)).transformAndConcat(FLATTENER).toList());
+ }
+ return albums;
+ }
+ };
- /** The images in this album. */
- private final List<Image> images = new ArrayList<Image>();
+ /** Function that transforms an album into the images it contains. */
+ Function<Album, List<Image>> IMAGES = new Function<Album, List<Image>>() {
- /** The name of this album. */
- private String name;
+ @Override
+ @Nonnull
+ public List<Image> apply(Album album) {
+ return (album != null) ? album.getImages() : Collections.<Image>emptyList();
+ }
+ };
- /** The description of this album. */
- private String description;
+ /**
+ * Filter that removes all albums that do not have any images in any album
+ * below it.
+ */
+ Predicate<Album> NOT_EMPTY = new Predicate<Album>() {
+
+ @Override
+ public boolean apply(Album album) {
+ /* so, we flatten all albums below the given one and check whether at least one album… */
+ return FluentIterable.from(asList(album)).transformAndConcat(FLATTENER).anyMatch(new Predicate<Album>() {
+
+ @Override
+ public boolean apply(Album album) {
+ /* …contains any inserted images. */
+ return !album.getImages().isEmpty() && FluentIterable.from(album.getImages()).allMatch(new Predicate<Image>() {
+
+ @Override
+ public boolean apply(Image input) {
+ return input.isInserted();
+ }
+ });
+ }
+ });
+ }
+ };
/**
- * Creates a new album with a random ID.
+ * Returns the ID of this album.
+ *
+ * @return The ID of this album
*/
- public Album() {
- this(UUID.randomUUID().toString());
- }
+ String getId();
/**
- * Creates a new album with the given ID.
+ * Returns the Sone this album belongs to.
*
- * @param id
- * The ID of the album
+ * @return The Sone this album belongs to
*/
- public Album(String id) {
- this.id = id;
- }
+ Sone getSone();
- //
- // ACCESSORS
- //
+ List<Album> getAlbums();
/**
- * Returns the ID of this album.
+ * Returns the images in this album.
*
- * @return The ID of this album
+ * @return The images in this album
*/
- public String getId() {
- return id;
- }
+ List<Image> getImages();
+
+ Optional<Image> getAlbumImage();
/**
- * Returns the nested albums.
+ * Returns whether this album contains any other albums or images.
*
- * @return The nested albums
+ * @return {@code true} if this album is empty, {@code false} otherwise
*/
- public List<Album> getNestedAlbums() {
- return new ArrayList<Album>(albums);
- }
+ boolean isEmpty();
/**
- * Returns the images in this album.
+ * Returns whether this album is an identitiy’s root album.
*
- * @return The images in this album
+ * @return {@code true} if this album is an identity’s root album, {@code
+ * false} otherwise
*/
- public List<Image> getImages() {
- return new ArrayList<Image>(images);
- }
+ boolean isRoot();
/**
- * Returns the name of this album.
+ * Returns the parent album of this album.
*
- * @return The name of this album
+ * @return The parent album of this album, or {@code null} if this album does
+ * not have a parent
*/
- public String getName() {
- return name;
- }
+ Album getParent();
/**
- * Sets the name of this album.
+ * Returns the title of this album.
*
- * @param name
- * The name of this album
- * @return This album
+ * @return The title of this album
*/
- public Album setName(String name) {
- this.name = name;
- return this;
- }
+ String getTitle();
/**
* Returns the description of this album.
*
* @return The description of this album
*/
- public String getDescription() {
- return description;
- }
+ String getDescription();
+
+ AlbumBuilder newAlbumBuilder() throws IllegalStateException;
+
+ ImageBuilder newImageBuilder() throws IllegalStateException;
/**
- * Sets the description of this album.
+ * Returns a modifier for this album.
*
- * @param description
- * The description of this album
- * @return This album
+ * @return A modifier for this album
+ * @throws IllegalStateException
+ * if this album can not be modified
*/
- public Album setDescription(String description) {
- this.description = description;
- return this;
- }
+ Modifier modify() throws IllegalStateException;
- //
- // OBJECT METHODS
- //
+ void moveUp();
+
+ void moveDown();
+
+ void remove() throws IllegalStateException;
/**
- * {@inheritDoc}
+ * Allows modifying an album. Modifications are only performed once {@link
+ * #update()} has succesfully returned a new album with the modifications
+ * made.
+ *
+ * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
*/
- @Override
- public boolean equals(Object object) {
- if (!(object instanceof Album)) {
- return false;
- }
- Album album = (Album) object;
- return id.equals(album.id);
+ interface Modifier {
+
+ Modifier setTitle(String title);
+
+ Modifier setDescription(String description);
+
+ Modifier setAlbumImage(String imageId);
+
+ Album update() throws IllegalStateException;
+
}
}