2 * DemosceneMusic - DataManager.java - Copyright © 2012 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.demoscenemusic.data;
20 import java.sql.ResultSet;
21 import java.sql.SQLException;
22 import java.util.Collection;
23 import java.util.EnumMap;
24 import java.util.HashSet;
25 import java.util.List;
27 import java.util.Map.Entry;
28 import java.util.UUID;
29 import java.util.concurrent.Callable;
31 import net.pterodactylus.demoscenemusic.data.Track.Relationship;
32 import net.pterodactylus.util.collection.Memoizer;
33 import net.pterodactylus.util.database.Database;
34 import net.pterodactylus.util.database.DatabaseException;
35 import net.pterodactylus.util.database.Field;
36 import net.pterodactylus.util.database.Join;
37 import net.pterodactylus.util.database.Join.JoinType;
38 import net.pterodactylus.util.database.ObjectCreator;
39 import net.pterodactylus.util.database.ObjectCreator.StringCreator;
40 import net.pterodactylus.util.database.OrderField;
41 import net.pterodactylus.util.database.Parameter.StringParameter;
42 import net.pterodactylus.util.database.Query;
43 import net.pterodactylus.util.database.Query.Type;
44 import net.pterodactylus.util.database.ResultProcessor;
45 import net.pterodactylus.util.database.ValueField;
46 import net.pterodactylus.util.database.ValueFieldWhereClause;
49 * Interface between the database and the application.
51 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
53 public class DataManager {
55 /** The artist object creator. */
56 @SuppressWarnings("synthetic-access")
57 private final ObjectCreator<Artist> artistCreator = new ArtistCreator();
59 /** The group object creator. */
60 @SuppressWarnings("synthetic-access")
61 private final ObjectCreator<Group> groupCreator = new GroupCreator();
63 /** The track object creator. */
64 @SuppressWarnings("synthetic-access")
65 private final ObjectCreator<Track> trackCreator = new TrackCreator();
67 /** The style object creator. */
68 @SuppressWarnings("synthetic-access")
69 private final ObjectCreator<Style> styleCreator = new StyleCreator();
71 /** The {@link User} object creator. */
72 @SuppressWarnings("synthetic-access")
73 private final ObjectCreator<User> userCreator = new UserCreator();
76 private final Database database;
79 * Creates a new data manager.
82 * The database to operate on
84 public DataManager(Database database) {
85 this.database = database;
89 * Returns all artists.
92 * @throws DatabaseException
93 * if a database error occurs
95 public Collection<Artist> getAllArtists() throws DatabaseException {
96 Query query = new Query(Type.SELECT, "ARTISTS");
97 query.addField(new Field("ARTISTS.*"));
98 return loadProperties(database.getMultiple(query, artistCreator));
102 * Returns the artist with the given ID.
105 * The ID of the artist
106 * @return The artist with the given ID, or {@code null} if there is no
107 * artist with the given ID
108 * @throws DatabaseException
109 * if a database error occurs
111 public Artist getArtistById(String id) throws DatabaseException {
112 Query query = new Query(Type.SELECT, "ARTISTS");
113 query.addField(new Field("ARTISTS.*"));
114 query.addWhereClause(new ValueFieldWhereClause(new ValueField("ARTISTS.ID", new StringParameter(id))));
115 return loadProperties(database.getSingle(query, artistCreator));
119 * Returns all artists that belong to the group with the given ID.
122 * The ID of the group
123 * @return All artists belonging to the given group
124 * @throws DatabaseException
125 * if a database error occurs
127 public Collection<Artist> getArtistsByGroup(String groupId) throws DatabaseException {
128 Query query = new Query(Type.SELECT, "ARTISTS");
129 query.addField(new Field("ARTISTS.*"));
130 query.addJoin(new Join(JoinType.INNER, "GROUP_ARTISTS", new Field("ARTISTS.ID"), new Field("GROUP_ARTISTS.ARTIST")));
131 query.addWhereClause(new ValueFieldWhereClause(new ValueField("GROUP_ARTISTS.GROUP_", new StringParameter(groupId))));
132 return loadProperties(database.getMultiple(query, artistCreator));
136 * Returns all artists involved in the track with the given ID.
139 * The ID of the track
140 * @return All artists involved in the track, in preferred order
141 * @throws DatabaseException
142 * if a database error occurs
144 public List<Artist> getArtistsByTrack(String trackId) throws DatabaseException {
145 Query query = new Query(Type.SELECT, "ARTISTS");
146 query.addField(new Field("ARTISTS.*"));
147 query.addJoin(new Join(JoinType.INNER, "TRACK_ARTISTS", new Field("TRACK_ARTISTS.ARTIST"), new Field("ARTISTS.ID")));
148 query.addWhereClause(new ValueFieldWhereClause(new ValueField("TRACK_ARTISTS.TRACK", new StringParameter(trackId))));
149 query.addOrderField(new OrderField(new Field("TRACK_ARTISTS.DISPLAY_ORDER")));
150 return loadProperties(database.getMultiple(query, artistCreator));
154 * Creates a new artist with the given name.
157 * The name of the artist
158 * @return The created artist
159 * @throws DatabaseException
160 * if a database error occurs
162 public Artist createArtist(String name) throws DatabaseException {
163 Query query = new Query(Type.INSERT, "ARTISTS");
164 String id = UUID.randomUUID().toString();
165 query.addValueField(new ValueField("ID", new StringParameter(id)));
166 query.addValueField(new ValueField("NAME", new StringParameter(name)));
167 database.insert(query);
168 return loadProperties(getArtistById(id));
172 * Saves the given artist.
176 * @throws DatabaseException
177 * if a database error occurs
179 public void saveArtist(Artist artist) throws DatabaseException {
180 Query query = new Query(Type.UPDATE, "ARTISTS");
181 query.addValueField(new ValueField("NAME", new StringParameter(artist.getName())));
182 query.addWhereClause(new ValueFieldWhereClause(new ValueField("ID", new StringParameter(artist.getId()))));
183 database.update(query);
184 saveArtistProperties(artist);
188 * Saves the properties of the given artist.
191 * The artist whose properties to save
192 * @throws DatabaseException
193 * if a database error occurs
195 public void saveArtistProperties(Artist artist) throws DatabaseException {
196 saveProperties(artist.getProperties(), "ARTIST_PROPERTIES", "ARTIST", artist.getId());
200 * Saves the given properties to the given table for the given principal.
203 * The properties to save
205 * The table in which to save the properties
207 * The type of the principal (e. g. “ARTIST” or “TRACK”)
209 * The ID of the principial
210 * @throws DatabaseException
211 * if a database error occurs
213 public void saveProperties(Properties properties, String table, String type, String id) throws DatabaseException {
214 if (!properties.isDirty()) {
217 Query query = new Query(Type.DELETE, table);
218 query.addWhereClause(new ValueFieldWhereClause(new ValueField(type, new StringParameter(id))));
219 database.update(query);
220 for (Entry<String, String> property : properties) {
221 Query insertQuery = new Query(Type.INSERT, table);
222 insertQuery.addValueField(new ValueField(type, new StringParameter(id)));
223 insertQuery.addValueField(new ValueField("PROPERTY", new StringParameter(property.getKey())));
224 insertQuery.addValueField(new ValueField("VALUE", new StringParameter(property.getValue())));
225 database.insert(insertQuery);
227 properties.resetDirty();
231 * Loads the properties for an artist.
234 * The artist to load the properties for
236 * @throws DatabaseException
237 * if a database error occurs
239 public Artist loadProperties(final Artist artist) throws DatabaseException {
240 Query query = new Query(Type.SELECT, "ARTIST_PROPERTIES");
241 query.addField(new Field("ARTIST_PROPERTIES.PROPERTY"));
242 query.addField(new Field("ARTIST_PROPERTIES.VALUE"));
243 query.addWhereClause(new ValueFieldWhereClause(new ValueField("ARTIST", new StringParameter(artist.getId()))));
244 database.process(query, new ResultProcessor() {
247 public void processResult(ResultSet resultSet) throws SQLException {
248 if (resultSet.isFirst()) {
249 artist.getProperties().removeAll();
251 artist.getProperties().set(resultSet.getString("ARTIST_PROPERTIES.PROPERTY"), resultSet.getString("ARTIST_PROPERTIES.VALUE"));
259 * Loads the properties of all given artists.
262 * The artists to load the properties for
263 * @return The list of artists
264 * @throws DatabaseException
265 * if a database error occurs
267 public List<Artist> loadProperties(List<Artist> artists) throws DatabaseException {
268 for (Artist artist : artists) {
269 loadProperties(artist);
275 * Returns all remix artists involved in the track with the given ID.
278 * The ID of the track
279 * @return All remix artists involved in the track, in preferred order
280 * @throws DatabaseException
281 * if a database error occurs
283 public List<Artist> getRemixArtistsByTrack(String trackId) throws DatabaseException {
284 Query query = new Query(Type.SELECT, "ARTISTS");
285 query.addField(new Field("ARTISTS.*"));
286 query.addJoin(new Join(JoinType.INNER, "TRACK_REMIX_ARTISTS", new Field("TRACK_REMIX_ARTISTS.ARTIST"), new Field("ARTISTS.ID")));
287 query.addWhereClause(new ValueFieldWhereClause(new ValueField("TRACK_REMIX_ARTISTS.TRACK", new StringParameter(trackId))));
288 query.addOrderField(new OrderField(new Field("TRACK_REMIX_ARTISTS.DISPLAY_ORDER")));
289 return database.getMultiple(query, artistCreator);
293 * Returns all related tracks for the track with the given ID.
296 * The ID of the tracks
297 * @return A mapping from relationship to all tracks that match the relation
298 * @throws DatabaseException
299 * if a database error occurs
301 public Map<Relationship, Collection<Track>> getRelatedTracksByTrack(String trackId) throws DatabaseException {
302 Query query = new Query(Type.SELECT, "TRACKS");
303 query.addField(new Field("TRACKS.*"));
304 query.addField(new Field("TRACK_RELATIONS.*"));
305 query.addJoin(new Join(JoinType.INNER, "TRACK_RELATIONS", new Field("TRACK_RELATIONS.TRACK"), new Field("TRACK_RELATIONS.RELATED_TRACK")));
306 query.addWhereClause(new ValueFieldWhereClause(new ValueField("TRACK_RELATIONS.TRACK", new StringParameter(trackId))));
307 final Map<Relationship, Collection<Track>> relatedTracks = new EnumMap<Relationship, Collection<Track>>(Relationship.class);
308 database.process(query, new ResultProcessor() {
311 @SuppressWarnings("synthetic-access")
312 public void processResult(ResultSet resultSet) throws SQLException {
313 Track track = trackCreator.createObject(resultSet);
314 Relationship relationship = Relationship.valueOf(resultSet.getString("TRACK_RELATIONS.RELATIONSHIP"));
315 if (!relatedTracks.containsKey(relationship)) {
316 relatedTracks.put(relationship, new HashSet<Track>());
318 relatedTracks.get(relationship).add(track);
321 return relatedTracks;
325 * Returns the track with the given ID.
328 * The ID of the track
329 * @return The track with the given ID, or {@code null} if there is no such
331 * @throws DatabaseException
332 * if a database error occurs
334 public Track getTrackById(String id) throws DatabaseException {
335 Query query = new Query(Type.SELECT, "TRACKS");
336 query.addField(new Field("TRACKS.*"));
337 query.addWhereClause(new ValueFieldWhereClause(new ValueField("TRACKS.ID", new StringParameter(id))));
338 return database.getSingle(query, trackCreator);
342 * Returns all tracks by the artist with the given ID.
345 * The ID of the artist
346 * @return All tracks by the given artist
347 * @throws DatabaseException
348 * if a database error occurs
350 public Collection<Track> getTracksByArtist(String artistId) throws DatabaseException {
351 Query query = new Query(Type.SELECT, "TRACKS");
352 query.addField(new Field("TRACKS.*"));
353 query.addJoin(new Join(JoinType.INNER, "TRACK_ARTISTS", new Field("TRACKS.ID"), new Field("TRACK_ARTISTS.TRACK")));
354 query.addWhereClause(new ValueFieldWhereClause(new ValueField("TRACK_ARTISTS.ARTIST", new StringParameter(artistId))));
355 return database.getMultiple(query, trackCreator);
359 * Returns all groups the artist with the given ID belongs to.
362 * The ID of the artist
363 * @return All groups the artist belongs to
364 * @throws DatabaseException
365 * if a database error occurs
367 public Collection<Group> getGroupsByArtist(String artistId) throws DatabaseException {
368 Query query = new Query(Type.SELECT, "GROUPS");
369 query.addField(new Field("GROUPS.*"));
370 query.addJoin(new Join(JoinType.INNER, "GROUP_ARTISTS", new Field("GROUPS.ID"), new Field("GROUP_ARTISTS.GROUP_")));
371 query.addWhereClause(new ValueFieldWhereClause(new ValueField("GROUP_ARTISTS.ARTIST", new StringParameter(artistId))));
372 return database.getMultiple(query, groupCreator);
376 * Returns all styles for the track with the given ID.
379 * The ID of the track
380 * @return All styles for the given track
381 * @throws DatabaseException
382 * if a database error occurs
384 public Collection<Style> getStylesByTrack(String trackId) throws DatabaseException {
385 Query query = new Query(Type.SELECT, "STYLES");
386 query.addField(new Field("STYLES.*"));
387 query.addJoin(new Join(JoinType.INNER, "TRACK_STYLES", new Field("STYLES.ID"), new Field("TRACK_STYLES.STYLE")));
388 query.addWhereClause(new ValueFieldWhereClause(new ValueField("TRACK_STYLES.TRACK", new StringParameter(trackId))));
389 return database.getMultiple(query, styleCreator);
393 * Returns the user with the given name.
396 * The name of the user
397 * @return The user, or {@code null} if the user does not exist
398 * @throws DatabaseException
399 * if a database error occurs
401 public User getUserByName(String username) throws DatabaseException {
402 Query query = new Query(Type.SELECT, "USERS");
403 query.addField(new Field("USERS.*"));
404 query.addWhereClause(new ValueFieldWhereClause(new ValueField("USERS.NAME", new StringParameter(username))));
405 return database.getSingle(query, userCreator);
409 * Returns the user connected with the given OpenID.
412 * The OpenID to find the user for
413 * @return The user connected with the given OpenID, or {@code null} if
414 * there is no such user
415 * @throws DatabaseException
416 * if a database error occurs
418 public User getUserByOpenId(String openId) throws DatabaseException {
419 Query query = new Query(Type.SELECT, "USERS");
420 query.addField(new Field("USERS.*"));
421 query.addJoin(new Join(JoinType.INNER, "USER_OPENIDS", new Field("USER_OPENIDS.USER"), new Field("USERS.ID")));
422 query.addWhereClause(new ValueFieldWhereClause(new ValueField("USER_OPENIDS.OPENID", new StringParameter(openId))));
423 return database.getSingle(query, userCreator);
427 * Returns all OpenIDs connected with the user with the given ID.
431 * @return All OpenIDs connected with the given user
432 * @throws DatabaseException
433 * if a database error occurs
435 public Collection<String> getOpenIdsByUser(String userId) throws DatabaseException {
436 Query query = new Query(Type.SELECT, "USER_OPENIDS");
437 query.addField(new Field("USER_OPENIDS.*"));
438 query.addWhereClause(new ValueFieldWhereClause(new ValueField("USER_OPENIDS.USER", new StringParameter(userId))));
439 return database.getMultiple(query, new StringCreator("USER_OPENIDS.OPENID"));
443 * {@link Artist} implementation that retrieves some attributes (such as
444 * {@link #getGroups()}, and {@link #getTracks()}) from the
445 * {@link DataManager} on demand.
447 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
449 private class LazyArtist extends DefaultArtist {
451 /** Memoizer for the tracks by this artist. */
452 private final Memoizer<Void> tracksMemoizer = new Memoizer<Void>(new Callable<Void>() {
454 public Void call() throws DatabaseException {
455 if (!hasValue("tracks")) {
456 getValue("tracks", Collection.class).set(getTracksByArtist(getId()));
462 /** Memoizer for the groups of this artist. */
463 private final Memoizer<Void> groupsMemoizer = new Memoizer<Void>(new Callable<Void>() {
466 public Void call() throws Exception {
467 if (!hasValue("groups")) {
468 getValue("groups", Collection.class).set(getGroupsByArtist(getId()));
476 * Creates a new lazy artist.
479 * The ID of the artist
481 public LazyArtist(String id) {
486 // DEFAULTARTIST METHODS
493 public Collection<Group> getGroups() {
494 groupsMemoizer.get();
495 return super.getGroups();
502 public Collection<Track> getTracks() {
503 tracksMemoizer.get();
504 return super.getTracks();
510 * {@link ObjectCreator} implementation that can create {@link Artist}
511 * objects. This specific class actually creates {@link LazyArtist}
514 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
516 private class ArtistCreator implements ObjectCreator<Artist> {
522 public Artist createObject(ResultSet resultSet) throws SQLException {
523 return new LazyArtist(resultSet.getString("ARTISTS.ID")).setName(resultSet.getString("ARTISTS.NAME"));
529 * {@link Group} implementation that retrieves some attributes (such as
530 * {@link #getArtists()}) from the {@link DataManager} on demand.
532 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
534 private class LazyGroup extends DefaultGroup {
536 /** Memoizer for the artist. */
537 private final Memoizer<Void> artistsMemoizer = new Memoizer<Void>(new Callable<Void>() {
540 public Void call() throws Exception {
541 if (!hasValue("artists")) {
542 getValue("artists", Collection.class).set(getArtistsByGroup(getId()));
550 * Creates a new lazy group.
553 * The ID of the group
555 public LazyGroup(String id) {
560 // DEFAULTGROUP METHODS
567 public Collection<Artist> getArtists() {
568 artistsMemoizer.get();
569 return super.getArtists();
575 * {@link ObjectCreator} implementation that can create {@link Group}
576 * objects. This specific implementation creates {@link LazyGroup}
579 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
581 private class GroupCreator implements ObjectCreator<Group> {
587 public Group createObject(ResultSet resultSet) throws SQLException {
588 return new LazyGroup(resultSet.getString("GROUPS.ID")).setName(resultSet.getString("GROUPS.NAME")).setUrl(resultSet.getString("GROUPS.URL"));
594 * {@link Track} implementation that retrieves some attributes (such as
595 * {@link #getArtists()}, and {@link #getStyles()}) from the
596 * {@link DataManager} on demand.
598 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
600 private class LazyTrack extends DefaultTrack {
602 /** Memoizer for the artists. */
603 private final Memoizer<Void> artistsMemoizer = new Memoizer<Void>(new Callable<Void>() {
606 public Void call() throws Exception {
607 if (!hasValue("artists")) {
608 getValue("artists", List.class).set(getArtistsByTrack(getId()));
615 /** Memoizer for the styles. */
616 private final Memoizer<Void> stylesMemoizer = new Memoizer<Void>(new Callable<Void>() {
619 public Void call() throws Exception {
620 if (!hasValue("styles")) {
621 getValue("styles", Collection.class).set(getStylesByTrack(getId()));
628 /** Memoizer for the remix artists. */
629 private final Memoizer<Void> remixArtistsMemoizer = new Memoizer<Void>(new Callable<Void>() {
632 public Void call() throws Exception {
633 if (!hasValue("remixArtists")) {
634 getValue("remixArtists", List.class).set(getRemixArtistsByTrack(getId()));
641 /** Memoizer for the related tracks. */
642 private final Memoizer<Void> relatedTracksMemoizer = new Memoizer<Void>(new Callable<Void>() {
645 public Void call() throws Exception {
646 if (!hasValue("relatedTracks")) {
647 getValue("relatedTracks", Map.class).set(getRelatedTracksByTrack(getId()));
654 * Creates a new track.
657 * The ID of the track
659 public LazyTrack(String id) {
664 // DEFAULTTRACK METHODS
671 public List<Artist> getArtists() {
672 artistsMemoizer.get();
673 return super.getArtists();
680 public Collection<Style> getStyles() {
681 stylesMemoizer.get();
682 return super.getStyles();
689 public List<Artist> getRemixArtists() {
690 remixArtistsMemoizer.get();
691 return super.getRemixArtists();
698 public Map<Relationship, Collection<Track>> getRelatedTracks() {
699 relatedTracksMemoizer.get();
700 return super.getRelatedTracks();
706 * {@link ObjectCreator} implementation that can create {@link Track}
707 * objects. This specific implementation creates {@link LazyTrack}
710 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
712 private class TrackCreator implements ObjectCreator<Track> {
718 public Track createObject(ResultSet resultSet) throws SQLException {
719 return new LazyTrack(resultSet.getString("TRACKS.ID")).setName(resultSet.getString("TRACKS.NAME")).setRemix(resultSet.getString("TRACKS.REMIX"));
725 * {@link ObjectCreator} implementation that can create {@link Style}
728 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
730 private class StyleCreator implements ObjectCreator<Style> {
736 public Style createObject(ResultSet resultSet) throws SQLException {
737 return new DefaultStyle(resultSet.getString("STYLES.ID")).setName(resultSet.getString("STYLES.NAME"));
743 * {@link User} implementation that retrieves some attributes (such as
744 * {@link #getOpenIds()}) from the {@link DataManager} on demand.
746 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
748 private class LazyUser extends DefaultUser {
750 /** Memoizer for a user’s OpenIDs. */
751 private final Memoizer<Void> openIdMemoizer = new Memoizer<Void>(new Callable<Void>() {
754 public Void call() throws Exception {
755 if (!hasValue("openIds")) {
756 getValue("openIds", Collection.class).set(getOpenIdsByUser(getId()));
763 * Creates a new user.
768 public LazyUser(String id) {
776 public Collection<String> getOpenIds() {
777 openIdMemoizer.get();
778 return super.getOpenIds();
784 * {@link ObjectCreator} implementation that can create {@link User}
785 * objects. This specific implementation creates {@link LazyUser} instances.
787 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
789 private class UserCreator implements ObjectCreator<User> {
795 public User createObject(ResultSet resultSet) throws SQLException {
796 return new LazyUser(resultSet.getString("USERS.ID")).setName(resultSet.getString("USERS.NAME")).setPasswordHash(resultSet.getString("USERS.PASSWORD")).setLevel(resultSet.getInt("USERS.LEVEL"));