X-Git-Url: https://git.pterodactylus.net/?a=blobdiff_plain;f=src%2Fmain%2Fjava%2Fnet%2Fpterodactylus%2Fsone%2Fdata%2FAlbum.java;h=3aba77942154107ef0d672aa5ba549ac4d4504d6;hb=df0abbdc635a8b927474515bb100882e6d850336;hp=20557557025c34647f69a294344f568413039f1d;hpb=815be1d11bf72e05f3324ee98171e9be989dba21;p=Sone.git
diff --git a/src/main/java/net/pterodactylus/sone/data/Album.java b/src/main/java/net/pterodactylus/sone/data/Album.java
index 2055755..3aba779 100644
--- a/src/main/java/net/pterodactylus/sone/data/Album.java
+++ b/src/main/java/net/pterodactylus/sone/data/Album.java
@@ -1,5 +1,5 @@
/*
- * 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
@@ -17,90 +17,284 @@
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 javax.annotation.Nonnull;
+
+import com.google.common.base.Function;
+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 David âBombeâ Roden
*/
-public class Album {
+public interface Album extends Fingerprintable {
+
+ /** Compares two {@link Album}s by {@link #getTitle()}. */
+ Comparator TITLE_COMPARATOR = new Comparator() {
+
+ @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> FLATTENER = new Function>() {
+
+ @Override
+ @Nonnull
+ public List apply(Album album) {
+ if (album == null) {
+ return emptyList();
+ }
+ List albums = new ArrayList();
+ albums.add(album);
+ for (Album subAlbum : album.getAlbums()) {
+ albums.addAll(FluentIterable.from(ImmutableList.of(subAlbum)).transformAndConcat(FLATTENER).toList());
+ }
+ return albums;
+ }
+ };
+
+ /** Function that transforms an album into the images it contains. */
+ Function> IMAGES = new Function>() {
+
+ @Override
+ @Nonnull
+ public List apply(Album album) {
+ return (album != null) ? album.getImages() : Collections.emptyList();
+ }
+ };
+
+ /**
+ * Filter that removes all albums that do not have any images in any album
+ * below it.
+ */
+ Predicate NOT_EMPTY = new Predicate() {
- /** Nested albums. */
- private final List albums = new ArrayList();
+ @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() {
- /** The images in this album. */
- private final List images = new ArrayList();
+ @Override
+ public boolean apply(Album album) {
+ /* â¦contains any inserted images. */
+ return !album.getImages().isEmpty() && FluentIterable.from(album.getImages()).allMatch(new Predicate() {
- /** The name of this album. */
- private String name;
+ @Override
+ public boolean apply(Image input) {
+ return input.isInserted();
+ }
+ });
+ }
+ });
+ }
+ };
- /** The description of this album. */
- private String description;
+ /**
+ * Returns the ID of this album.
+ *
+ * @return The ID of this album
+ */
+ String getId();
+ String getInternalId();
- //
- // ACCESSORS
- //
+ /**
+ * Returns the Sone this album belongs to.
+ *
+ * @return The Sone this album belongs to
+ */
+ Sone getSone();
/**
* Returns the nested albums.
*
* @return The nested albums
*/
- public List getNestedAlbums() {
- return new ArrayList(albums);
- }
+ List getAlbums();
+
+ /**
+ * Adds an album to this album.
+ *
+ * @param album
+ * The album to add
+ */
+ void addAlbum(Album album);
+
+ /**
+ * Removes an album from this album.
+ *
+ * @param album
+ * The album to remove
+ */
+ void removeAlbum(Album album);
+
+ /**
+ * Moves the given album up in this albumâs albums. If the album is already the
+ * first album, nothing happens.
+ *
+ * @param album
+ * The album to move up
+ * @return The album that the given album swapped the place with, or
+ * null
if the album did not change its place
+ */
+ Album moveAlbumUp(Album album);
+
+ /**
+ * Moves the given album down in this albumâs albums. If the album is already
+ * the last album, nothing happens.
+ *
+ * @param album
+ * The album to move down
+ * @return The album that the given album swapped the place with, or
+ * null
if the album did not change its place
+ */
+ Album moveAlbumDown(Album album);
/**
* Returns the images in this album.
*
* @return The images in this album
*/
- public List getImages() {
- return new ArrayList(images);
- }
+ List getImages();
/**
- * Returns the name of this album.
+ * Adds the given image to this album.
*
- * @return The name of this album
+ * @param image
+ * The image to add
*/
- public String getName() {
- return name;
- }
+ void addImage(Image image);
+
+ /**
+ * Removes the given image from this album.
+ *
+ * @param image
+ * The image to remove
+ */
+ void removeImage(Image image);
+
+ /**
+ * Moves the given image up in this albumâs images. If the image is already the
+ * first image, nothing happens.
+ *
+ * @param image
+ * The image to move up
+ * @return The image that the given image swapped the place with, or
+ * null
if the image did not change its place
+ */
+ Image moveImageUp(Image image);
+
+ /**
+ * Moves the given image down in this albumâs images. If the image is already
+ * the last image, nothing happens.
+ *
+ * @param image
+ * The image to move down
+ * @return The image that the given image swapped the place with, or
+ * null
if the image did not change its place
+ */
+ Image moveImageDown(Image image);
+
+ /**
+ * Returns the album image of this album, or {@code null} if no album image has
+ * been set.
+ *
+ * @return The image to show when this album is listed
+ */
+ Image getAlbumImage();
+
+ /**
+ * Returns whether this album contains any other albums or images.
+ *
+ * @return {@code true} if this album is empty, {@code false} otherwise
+ */
+ boolean isEmpty();
+
+ /**
+ * Returns whether this album is an identitiyâs root album.
+ *
+ * @return {@code true} if this album is an identityâs root album, {@code
+ * false} otherwise
+ */
+ boolean isRoot();
/**
- * Sets the name of this album.
+ * Returns the parent album of this album.
*
- * @param name
- * The name of this album
+ * @return The parent album of this album, or {@code null} if this album does
+ * not have a parent
+ */
+ Album getParent();
+
+ /**
+ * Sets the parent album of this album.
+ *
+ * @param parent
+ * The new parent album of this album
* @return This album
*/
- public Album setName(String name) {
- this.name = name;
- return this;
- }
+ Album setParent(Album parent);
+
+ /**
+ * Removes the parent album of this album.
+ *
+ * @return This album
+ */
+ Album removeParent();
+
+ /**
+ * Returns the title of this album.
+ *
+ * @return The title of this album
+ */
+ String getTitle();
/**
* Returns the description of this album.
*
* @return The description of this album
*/
- public String getDescription() {
- return description;
- }
+ String getDescription();
/**
- * 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;
+
+ /**
+ * Allows modifying an album. Modifications are only performed once {@link
+ * #update()} has succesfully returned a new album with the modifications
+ * made.
+ *
+ * @author David âBombeâ Roden
+ */
+ interface Modifier {
+
+ Modifier setTitle(String title);
+
+ Modifier setDescription(String description);
+
+ Modifier setAlbumImage(String imageId);
+
+ Album update() throws IllegalStateException;
+
+ class AlbumTitleMustNotBeEmpty extends IllegalStateException { }
+
}
}