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 track object creator. */
68 @SuppressWarnings("synthetic-access")
69 private final ObjectCreator<TrackDerivative> trackDerivativeCreator = new TrackDerivativeCreator();
71 /** The style object creator. */
72 @SuppressWarnings("synthetic-access")
73 private final ObjectCreator<Style> styleCreator = new StyleCreator();
75 /** The {@link User} object creator. */
76 @SuppressWarnings("synthetic-access")
77 private final ObjectCreator<User> userCreator = new UserCreator();
80 private final Database database;
83 * Creates a new data manager.
86 * The database to operate on
88 public DataManager(Database database) {
89 this.database = database;
93 * Returns all artists.
96 * @throws DatabaseException
97 * if a database error occurs
99 public Collection<Artist> getAllArtists() throws DatabaseException {
100 Query query = new Query(Type.SELECT, "ARTISTS");
101 query.addField(new Field("ARTISTS.*"));
102 return loadProperties(database.getMultiple(query, artistCreator));
106 * Returns the artist with the given ID.
109 * The ID of the artist
110 * @return The artist with the given ID, or {@code null} if there is no
111 * artist with the given ID
112 * @throws DatabaseException
113 * if a database error occurs
115 public Artist getArtistById(String id) throws DatabaseException {
116 Query query = new Query(Type.SELECT, "ARTISTS");
117 query.addField(new Field("ARTISTS.*"));
118 query.addWhereClause(new ValueFieldWhereClause(new ValueField("ARTISTS.ID", new StringParameter(id))));
119 return loadProperties(database.getSingle(query, artistCreator));
123 * Returns all artists that belong to the group with the given ID.
126 * The ID of the group
127 * @return All artists belonging to the given group
128 * @throws DatabaseException
129 * if a database error occurs
131 public Collection<Artist> getArtistsByGroup(String groupId) throws DatabaseException {
132 Query query = new Query(Type.SELECT, "ARTISTS");
133 query.addField(new Field("ARTISTS.*"));
134 query.addJoin(new Join(JoinType.INNER, "GROUP_ARTISTS", new Field("ARTISTS.ID"), new Field("GROUP_ARTISTS.ARTIST")));
135 query.addWhereClause(new ValueFieldWhereClause(new ValueField("GROUP_ARTISTS.GROUP_", new StringParameter(groupId))));
136 return loadProperties(database.getMultiple(query, artistCreator));
140 * Returns all artists involved in the track with the given ID.
143 * The ID of the track
144 * @return All artists involved in the track, in preferred order
145 * @throws DatabaseException
146 * if a database error occurs
148 public List<Artist> getArtistsByTrack(String trackId) throws DatabaseException {
149 Query query = new Query(Type.SELECT, "ARTISTS");
150 query.addField(new Field("ARTISTS.*"));
151 query.addJoin(new Join(JoinType.INNER, "TRACK_ARTISTS", new Field("TRACK_ARTISTS.ARTIST"), new Field("ARTISTS.ID")));
152 query.addWhereClause(new ValueFieldWhereClause(new ValueField("TRACK_ARTISTS.TRACK", new StringParameter(trackId))));
153 query.addOrderField(new OrderField(new Field("TRACK_ARTISTS.DISPLAY_ORDER")));
154 return loadProperties(database.getMultiple(query, artistCreator));
158 * Creates a new artist with the given name.
161 * The name of the artist
162 * @return The created artist
163 * @throws DatabaseException
164 * if a database error occurs
166 public Artist createArtist(String name) throws DatabaseException {
167 Query query = new Query(Type.INSERT, "ARTISTS");
168 String id = UUID.randomUUID().toString();
169 query.addValueField(new ValueField("ID", new StringParameter(id)));
170 query.addValueField(new ValueField("NAME", new StringParameter(name)));
171 database.insert(query);
172 return loadProperties(getArtistById(id));
176 * Saves the given artist.
180 * @throws DatabaseException
181 * if a database error occurs
183 public void saveArtist(Artist artist) throws DatabaseException {
184 Query query = new Query(Type.UPDATE, "ARTISTS");
185 query.addValueField(new ValueField("NAME", new StringParameter(artist.getName())));
186 query.addWhereClause(new ValueFieldWhereClause(new ValueField("ID", new StringParameter(artist.getId()))));
187 database.update(query);
188 saveArtistProperties(artist);
192 * Saves the properties of the given artist.
195 * The artist whose properties to save
196 * @throws DatabaseException
197 * if a database error occurs
199 public void saveArtistProperties(Artist artist) throws DatabaseException {
200 saveProperties(artist.getProperties(), "ARTIST_PROPERTIES", "ARTIST", artist.getId());
204 * Saves the given properties to the given table for the given principal.
207 * The properties to save
209 * The table in which to save the properties
211 * The type of the principal (e. g. “ARTIST” or “TRACK”)
213 * The ID of the principial
214 * @throws DatabaseException
215 * if a database error occurs
217 public void saveProperties(Properties properties, String table, String type, String id) throws DatabaseException {
218 if (!properties.isDirty()) {
221 Query query = new Query(Type.DELETE, table);
222 query.addWhereClause(new ValueFieldWhereClause(new ValueField(type, new StringParameter(id))));
223 database.update(query);
224 for (Entry<String, String> property : properties) {
225 Query insertQuery = new Query(Type.INSERT, table);
226 insertQuery.addValueField(new ValueField(type, new StringParameter(id)));
227 insertQuery.addValueField(new ValueField("PROPERTY", new StringParameter(property.getKey())));
228 insertQuery.addValueField(new ValueField("VALUE", new StringParameter(property.getValue())));
229 database.insert(insertQuery);
231 properties.resetDirty();
235 * Loads the properties for an artist.
238 * The artist to load the properties for
240 * @throws DatabaseException
241 * if a database error occurs
243 public Artist loadProperties(final Artist artist) throws DatabaseException {
244 return loadProperties(artist, "ARTIST_PROPERTIES", "ARTIST");
248 * Loads the properties of all given artists.
251 * The artists to load the properties for
252 * @return The list of artists
253 * @throws DatabaseException
254 * if a database error occurs
256 public List<Artist> loadProperties(List<Artist> artists) throws DatabaseException {
257 for (Artist artist : artists) {
258 loadProperties(artist);
264 * Returns all remix artists involved in the track with the given ID.
267 * The ID of the track
268 * @return All remix artists involved in the track, in preferred order
269 * @throws DatabaseException
270 * if a database error occurs
272 public List<Artist> getRemixArtistsByTrack(String trackId) throws DatabaseException {
273 Query query = new Query(Type.SELECT, "ARTISTS");
274 query.addField(new Field("ARTISTS.*"));
275 query.addJoin(new Join(JoinType.INNER, "TRACK_REMIX_ARTISTS", new Field("TRACK_REMIX_ARTISTS.ARTIST"), new Field("ARTISTS.ID")));
276 query.addWhereClause(new ValueFieldWhereClause(new ValueField("TRACK_REMIX_ARTISTS.TRACK", new StringParameter(trackId))));
277 query.addOrderField(new OrderField(new Field("TRACK_REMIX_ARTISTS.DISPLAY_ORDER")));
278 return database.getMultiple(query, artistCreator);
282 * Returns all related tracks for the track with the given ID.
285 * The ID of the tracks
286 * @return A mapping from relationship to all tracks that match the relation
287 * @throws DatabaseException
288 * if a database error occurs
290 public Map<Relationship, Collection<Track>> getRelatedTracksByTrack(String trackId) throws DatabaseException {
291 Query query = new Query(Type.SELECT, "TRACKS");
292 query.addField(new Field("TRACKS.*"));
293 query.addField(new Field("TRACK_RELATIONS.*"));
294 query.addJoin(new Join(JoinType.INNER, "TRACK_RELATIONS", new Field("TRACK_RELATIONS.TRACK"), new Field("TRACK_RELATIONS.RELATED_TRACK")));
295 query.addWhereClause(new ValueFieldWhereClause(new ValueField("TRACK_RELATIONS.TRACK", new StringParameter(trackId))));
296 final Map<Relationship, Collection<Track>> relatedTracks = new EnumMap<Relationship, Collection<Track>>(Relationship.class);
297 database.process(query, new ResultProcessor() {
300 @SuppressWarnings("synthetic-access")
301 public void processResult(ResultSet resultSet) throws SQLException {
302 Track track = trackCreator.createObject(resultSet);
303 Relationship relationship = Relationship.valueOf(resultSet.getString("TRACK_RELATIONS.RELATIONSHIP"));
304 if (!relatedTracks.containsKey(relationship)) {
305 relatedTracks.put(relationship, new HashSet<Track>());
307 relatedTracks.get(relationship).add(track);
310 return relatedTracks;
314 * Returns the track with the given ID.
317 * The ID of the track
318 * @return The track with the given ID, or {@code null} if there is no such
320 * @throws DatabaseException
321 * if a database error occurs
323 public Track getTrackById(String id) throws DatabaseException {
324 Query query = new Query(Type.SELECT, "TRACKS");
325 query.addField(new Field("TRACKS.*"));
326 query.addWhereClause(new ValueFieldWhereClause(new ValueField("TRACKS.ID", new StringParameter(id))));
327 return database.getSingle(query, trackCreator);
331 * Returns all tracks by the artist with the given ID.
334 * The ID of the artist
335 * @return All tracks by the given artist
336 * @throws DatabaseException
337 * if a database error occurs
339 public Collection<Track> getTracksByArtist(String artistId) throws DatabaseException {
340 Query query = new Query(Type.SELECT, "TRACKS");
341 query.addField(new Field("TRACKS.*"));
342 query.addJoin(new Join(JoinType.INNER, "TRACK_ARTISTS", new Field("TRACKS.ID"), new Field("TRACK_ARTISTS.TRACK")));
343 query.addWhereClause(new ValueFieldWhereClause(new ValueField("TRACK_ARTISTS.ARTIST", new StringParameter(artistId))));
344 return database.getMultiple(query, trackCreator);
348 * Returns all groups the artist with the given ID belongs to.
351 * The ID of the artist
352 * @return All groups the artist belongs to
353 * @throws DatabaseException
354 * if a database error occurs
356 public Collection<Group> getGroupsByArtist(String artistId) throws DatabaseException {
357 Query query = new Query(Type.SELECT, "GROUPS");
358 query.addField(new Field("GROUPS.*"));
359 query.addJoin(new Join(JoinType.INNER, "GROUP_ARTISTS", new Field("GROUPS.ID"), new Field("GROUP_ARTISTS.GROUP_")));
360 query.addWhereClause(new ValueFieldWhereClause(new ValueField("GROUP_ARTISTS.ARTIST", new StringParameter(artistId))));
361 return database.getMultiple(query, groupCreator);
365 * Returns all styles for the track with the given ID.
368 * The ID of the track
369 * @return All styles for the given track
370 * @throws DatabaseException
371 * if a database error occurs
373 public Collection<Style> getStylesByTrack(String trackId) throws DatabaseException {
374 Query query = new Query(Type.SELECT, "STYLES");
375 query.addField(new Field("STYLES.*"));
376 query.addJoin(new Join(JoinType.INNER, "TRACK_STYLES", new Field("STYLES.ID"), new Field("TRACK_STYLES.STYLE")));
377 query.addWhereClause(new ValueFieldWhereClause(new ValueField("TRACK_STYLES.TRACK", new StringParameter(trackId))));
378 return database.getMultiple(query, styleCreator);
382 * Returns the user with the given name.
385 * The name of the user
386 * @return The user, or {@code null} if the user does not exist
387 * @throws DatabaseException
388 * if a database error occurs
390 public User getUserByName(String username) throws DatabaseException {
391 Query query = new Query(Type.SELECT, "USERS");
392 query.addField(new Field("USERS.*"));
393 query.addWhereClause(new ValueFieldWhereClause(new ValueField("USERS.NAME", new StringParameter(username))));
394 return database.getSingle(query, userCreator);
398 * Returns the user connected with the given OpenID.
401 * The OpenID to find the user for
402 * @return The user connected with the given OpenID, or {@code null} if
403 * there is no such user
404 * @throws DatabaseException
405 * if a database error occurs
407 public User getUserByOpenId(String openId) throws DatabaseException {
408 Query query = new Query(Type.SELECT, "USERS");
409 query.addField(new Field("USERS.*"));
410 query.addJoin(new Join(JoinType.INNER, "USER_OPENIDS", new Field("USER_OPENIDS.USER"), new Field("USERS.ID")));
411 query.addWhereClause(new ValueFieldWhereClause(new ValueField("USER_OPENIDS.OPENID", new StringParameter(openId))));
412 return database.getSingle(query, userCreator);
416 * Returns all OpenIDs connected with the user with the given ID.
420 * @return All OpenIDs connected with the given user
421 * @throws DatabaseException
422 * if a database error occurs
424 public Collection<String> getOpenIdsByUser(String userId) throws DatabaseException {
425 Query query = new Query(Type.SELECT, "USER_OPENIDS");
426 query.addField(new Field("USER_OPENIDS.*"));
427 query.addWhereClause(new ValueFieldWhereClause(new ValueField("USER_OPENIDS.USER", new StringParameter(userId))));
428 return database.getMultiple(query, new StringCreator("USER_OPENIDS.OPENID"));
436 * Loads the properties for the given object.
439 * The type of the object
443 * The table to load the properties from
445 * The type of the object (“ARTIST,” “TRACK,” etc.)
446 * @return The object with its properties loaded
447 * @throws DatabaseException
448 * if a database error occurs
450 private <T extends Base> T loadProperties(final T object, final String table, String type) throws DatabaseException {
451 Query query = new Query(Type.SELECT, table);
452 query.addField(new Field(table + ".PROPERTY"));
453 query.addField(new Field(table + ".VALUE"));
454 query.addWhereClause(new ValueFieldWhereClause(new ValueField(type, new StringParameter(object.getId()))));
455 database.process(query, new ResultProcessor() {
458 public void processResult(ResultSet resultSet) throws SQLException {
459 if (resultSet.isFirst()) {
460 object.getProperties().removeAll();
462 object.getProperties().set(resultSet.getString(table + ".PROPERTY"), resultSet.getString(table + ".VALUE"));
470 * {@link Artist} implementation that retrieves some attributes (such as
471 * {@link #getGroups()}, and {@link #getTracks()}) from the
472 * {@link DataManager} on demand.
474 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
476 private class LazyArtist extends DefaultArtist {
478 /** Memoizer for the tracks by this artist. */
479 private final Memoizer<Void> tracksMemoizer = new Memoizer<Void>(new Callable<Void>() {
481 public Void call() throws DatabaseException {
482 if (!hasValue("tracks")) {
483 getValue("tracks", Collection.class).set(getTracksByArtist(getId()));
489 /** Memoizer for the groups of this artist. */
490 private final Memoizer<Void> groupsMemoizer = new Memoizer<Void>(new Callable<Void>() {
493 public Void call() throws Exception {
494 if (!hasValue("groups")) {
495 getValue("groups", Collection.class).set(getGroupsByArtist(getId()));
503 * Creates a new lazy artist.
506 * The ID of the artist
508 public LazyArtist(String id) {
513 // DEFAULTARTIST METHODS
520 public Collection<Group> getGroups() {
521 groupsMemoizer.get();
522 return super.getGroups();
529 public Collection<Track> getTracks() {
530 tracksMemoizer.get();
531 return super.getTracks();
537 * {@link ObjectCreator} implementation that can create {@link Artist}
538 * objects. This specific class actually creates {@link LazyArtist}
541 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
543 private class ArtistCreator implements ObjectCreator<Artist> {
549 public Artist createObject(ResultSet resultSet) throws SQLException {
550 return new LazyArtist(resultSet.getString("ARTISTS.ID")).setName(resultSet.getString("ARTISTS.NAME"));
556 * {@link Group} implementation that retrieves some attributes (such as
557 * {@link #getArtists()}) from the {@link DataManager} on demand.
559 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
561 private class LazyGroup extends DefaultGroup {
563 /** Memoizer for the artist. */
564 private final Memoizer<Void> artistsMemoizer = new Memoizer<Void>(new Callable<Void>() {
567 public Void call() throws Exception {
568 if (!hasValue("artists")) {
569 getValue("artists", Collection.class).set(getArtistsByGroup(getId()));
577 * Creates a new lazy group.
580 * The ID of the group
582 public LazyGroup(String id) {
587 // DEFAULTGROUP METHODS
594 public Collection<Artist> getArtists() {
595 artistsMemoizer.get();
596 return super.getArtists();
602 * {@link ObjectCreator} implementation that can create {@link Group}
603 * objects. This specific implementation creates {@link LazyGroup}
606 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
608 private class GroupCreator implements ObjectCreator<Group> {
614 public Group createObject(ResultSet resultSet) throws SQLException {
615 return new LazyGroup(resultSet.getString("GROUPS.ID")).setName(resultSet.getString("GROUPS.NAME")).setUrl(resultSet.getString("GROUPS.URL"));
621 * {@link Track} implementation that retrieves some attributes (such as
622 * {@link #getArtists()}, and {@link #getStyles()}) from the
623 * {@link DataManager} on demand.
625 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
627 private class LazyTrack extends DefaultTrack {
629 /** Memoizer for the artists. */
630 private final Memoizer<Void> artistsMemoizer = new Memoizer<Void>(new Callable<Void>() {
633 public Void call() throws Exception {
634 if (!hasValue("artists")) {
635 getValue("artists", List.class).set(getArtistsByTrack(getId()));
642 /** Memoizer for the styles. */
643 private final Memoizer<Void> stylesMemoizer = new Memoizer<Void>(new Callable<Void>() {
646 public Void call() throws Exception {
647 if (!hasValue("styles")) {
648 getValue("styles", Collection.class).set(getStylesByTrack(getId()));
655 /** Memoizer for the remix artists. */
656 private final Memoizer<Void> remixArtistsMemoizer = new Memoizer<Void>(new Callable<Void>() {
659 public Void call() throws Exception {
660 if (!hasValue("remixArtists")) {
661 getValue("remixArtists", List.class).set(getRemixArtistsByTrack(getId()));
668 /** Memoizer for the related tracks. */
669 private final Memoizer<Void> relatedTracksMemoizer = new Memoizer<Void>(new Callable<Void>() {
672 public Void call() throws Exception {
673 if (!hasValue("relatedTracks")) {
674 getValue("relatedTracks", Map.class).set(getRelatedTracksByTrack(getId()));
681 * Creates a new track.
684 * The ID of the track
686 public LazyTrack(String id) {
691 // DEFAULTTRACK METHODS
698 public List<Artist> getArtists() {
699 artistsMemoizer.get();
700 return super.getArtists();
707 public Collection<Style> getStyles() {
708 stylesMemoizer.get();
709 return super.getStyles();
716 public List<Artist> getRemixArtists() {
717 remixArtistsMemoizer.get();
718 return super.getRemixArtists();
725 public Map<Relationship, Collection<Track>> getRelatedTracks() {
726 relatedTracksMemoizer.get();
727 return super.getRelatedTracks();
733 * {@link ObjectCreator} implementation that can create {@link Track}
734 * objects. This specific implementation creates {@link LazyTrack}
737 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
739 private class TrackCreator implements ObjectCreator<Track> {
745 public Track createObject(ResultSet resultSet) throws SQLException {
746 return new LazyTrack(resultSet.getString("TRACKS.ID")).setName(resultSet.getString("TRACKS.NAME")).setRemix(resultSet.getString("TRACKS.REMIX"));
752 * {@link ObjectCreator} implementation that can create
753 * {@link TrackDerivative} objects.
755 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
757 private class TrackDerivativeCreator implements ObjectCreator<TrackDerivative> {
763 public TrackDerivative createObject(ResultSet resultSet) throws SQLException {
764 return new DefaultTrackDerivative(resultSet.getString("TRACK_DERIVATIVES.ID"));
770 * {@link ObjectCreator} implementation that can create {@link Style}
773 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
775 private class StyleCreator implements ObjectCreator<Style> {
781 public Style createObject(ResultSet resultSet) throws SQLException {
782 return new DefaultStyle(resultSet.getString("STYLES.ID")).setName(resultSet.getString("STYLES.NAME"));
788 * {@link User} implementation that retrieves some attributes (such as
789 * {@link #getOpenIds()}) from the {@link DataManager} on demand.
791 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
793 private class LazyUser extends DefaultUser {
795 /** Memoizer for a user’s OpenIDs. */
796 private final Memoizer<Void> openIdMemoizer = new Memoizer<Void>(new Callable<Void>() {
799 public Void call() throws Exception {
800 if (!hasValue("openIds")) {
801 getValue("openIds", Collection.class).set(getOpenIdsByUser(getId()));
808 * Creates a new user.
813 public LazyUser(String id) {
821 public Collection<String> getOpenIds() {
822 openIdMemoizer.get();
823 return super.getOpenIds();
829 * {@link ObjectCreator} implementation that can create {@link User}
830 * objects. This specific implementation creates {@link LazyUser} instances.
832 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
834 private class UserCreator implements ObjectCreator<User> {
840 public User createObject(ResultSet resultSet) throws SQLException {
841 return new LazyUser(resultSet.getString("USERS.ID")).setName(resultSet.getString("USERS.NAME")).setPasswordHash(resultSet.getString("USERS.PASSWORD")).setLevel(resultSet.getInt("USERS.LEVEL"));