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.HashMap;
25 import java.util.HashSet;
26 import java.util.List;
28 import java.util.Map.Entry;
30 import java.util.UUID;
31 import java.util.concurrent.Callable;
33 import net.pterodactylus.demoscenemusic.data.Track.Relationship;
34 import net.pterodactylus.util.collection.Memoizer;
35 import net.pterodactylus.util.database.Database;
36 import net.pterodactylus.util.database.DatabaseException;
37 import net.pterodactylus.util.database.Field;
38 import net.pterodactylus.util.database.Join;
39 import net.pterodactylus.util.database.Join.JoinType;
40 import net.pterodactylus.util.database.ObjectCreator;
41 import net.pterodactylus.util.database.ObjectCreator.StringCreator;
42 import net.pterodactylus.util.database.OrWhereClause;
43 import net.pterodactylus.util.database.OrderField;
44 import net.pterodactylus.util.database.Parameter.IntegerParameter;
45 import net.pterodactylus.util.database.Parameter.StringParameter;
46 import net.pterodactylus.util.database.Query;
47 import net.pterodactylus.util.database.Query.Type;
48 import net.pterodactylus.util.database.ResultProcessor;
49 import net.pterodactylus.util.database.ValueField;
50 import net.pterodactylus.util.database.ValueFieldWhereClause;
53 * Interface between the database and the application.
55 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
57 public class DataManager {
59 /** The artist object creator. */
60 @SuppressWarnings("synthetic-access")
61 private final ObjectCreator<Artist> artistCreator = new ArtistCreator();
63 /** The group object creator. */
64 @SuppressWarnings("synthetic-access")
65 private final ObjectCreator<Group> groupCreator = new GroupCreator();
67 /** The track object creator. */
68 @SuppressWarnings("synthetic-access")
69 private final ObjectCreator<Track> trackCreator = new TrackCreator();
71 /** The track object creator. */
72 @SuppressWarnings("synthetic-access")
73 private final ObjectCreator<TrackDerivative> trackDerivativeCreator = new TrackDerivativeCreator();
75 /** The style object creator. */
76 @SuppressWarnings("synthetic-access")
77 private final ObjectCreator<Style> styleCreator = new StyleCreator();
79 /** The party object creator. */
80 @SuppressWarnings("synthetic-access")
81 private final ObjectCreator<Party> partyCreator = new PartyCreator();
83 /** The {@link User} object creator. */
84 @SuppressWarnings("synthetic-access")
85 private final ObjectCreator<User> userCreator = new UserCreator();
88 private final Database database;
91 * Creates a new data manager.
94 * The database to operate on
96 public DataManager(Database database) {
97 this.database = database;
101 * Returns all artists.
103 * @return All artists
104 * @throws DatabaseException
105 * if a database error occurs
107 public Collection<Artist> getAllArtists() throws DatabaseException {
108 Query query = new Query(Type.SELECT, "ARTISTS");
109 query.addField(new Field("ARTISTS.*"));
110 return loadArtistProperties(database.getMultiple(query, artistCreator));
114 * Returns the artist with the given ID.
117 * The ID of the artist
118 * @return The artist with the given ID, or {@code null} if there is no
119 * artist with the given ID
120 * @throws DatabaseException
121 * if a database error occurs
123 public Artist getArtistById(String id) throws DatabaseException {
124 Query query = new Query(Type.SELECT, "ARTISTS");
125 query.addField(new Field("ARTISTS.*"));
126 query.addWhereClause(new ValueFieldWhereClause(new ValueField("ARTISTS.ID", new StringParameter(id))));
127 return loadArtistProperties(database.getSingle(query, artistCreator));
131 * Returns all artists that belong to the group with the given ID.
134 * The ID of the group
135 * @return All artists belonging to the given group
136 * @throws DatabaseException
137 * if a database error occurs
139 public Collection<Artist> getArtistsByGroup(String groupId) throws DatabaseException {
140 Query query = new Query(Type.SELECT, "ARTISTS");
141 query.addField(new Field("ARTISTS.*"));
142 query.addJoin(new Join(JoinType.INNER, "GROUP_ARTISTS", new Field("ARTISTS.ID"), new Field("GROUP_ARTISTS.ARTIST")));
143 query.addWhereClause(new ValueFieldWhereClause(new ValueField("GROUP_ARTISTS.GROUP_", new StringParameter(groupId))));
144 return loadArtistProperties(database.getMultiple(query, artistCreator));
148 * Returns all artists involved in the track with the given ID.
151 * The ID of the track
152 * @return All artists involved in the track, in preferred order
153 * @throws DatabaseException
154 * if a database error occurs
156 public List<Artist> getArtistsByTrack(String trackId) throws DatabaseException {
157 Query query = new Query(Type.SELECT, "ARTISTS");
158 query.addField(new Field("ARTISTS.*"));
159 query.addJoin(new Join(JoinType.INNER, "TRACK_ARTISTS", new Field("TRACK_ARTISTS.ARTIST"), new Field("ARTISTS.ID")));
160 query.addWhereClause(new ValueFieldWhereClause(new ValueField("TRACK_ARTISTS.TRACK", new StringParameter(trackId))));
161 query.addOrderField(new OrderField(new Field("TRACK_ARTISTS.DISPLAY_ORDER")));
162 return loadArtistProperties(database.getMultiple(query, artistCreator));
166 * Creates a new artist with the given name.
169 * The name of the artist
170 * @return The created artist
171 * @throws DatabaseException
172 * if a database error occurs
174 public Artist createArtist(String name) throws DatabaseException {
175 Query query = new Query(Type.INSERT, "ARTISTS");
176 String id = UUID.randomUUID().toString();
177 query.addValueField(new ValueField("ID", new StringParameter(id)));
178 query.addValueField(new ValueField("NAME", new StringParameter(name)));
179 database.insert(query);
180 return loadArtistProperties(getArtistById(id));
184 * Saves the given artist.
188 * @throws DatabaseException
189 * if a database error occurs
191 public void saveArtist(Artist artist) throws DatabaseException {
192 Query query = new Query(Type.UPDATE, "ARTISTS");
193 query.addValueField(new ValueField("NAME", new StringParameter(artist.getName())));
194 query.addWhereClause(new ValueFieldWhereClause(new ValueField("ID", new StringParameter(artist.getId()))));
195 database.update(query);
198 Collection<Group> groups = artist.getGroups();
199 query = new Query(Type.DELETE, "GROUP_ARTISTS");
200 query.addWhereClause(new ValueFieldWhereClause(new ValueField("GROUP_ARTISTS.ARTIST", new StringParameter(artist.getId()))));
201 database.update(query);
202 for (Group group : groups) {
203 query = new Query(Type.INSERT, "GROUP_ARTISTS");
204 query.addValueField(new ValueField("GROUP_", new StringParameter(group.getId())));
205 query.addValueField(new ValueField("ARTIST", new StringParameter(artist.getId())));
206 database.insert(query);
209 /* save properties. */
210 saveArtistProperties(artist);
214 * Saves the properties of the given artist.
217 * The artist whose properties to save
218 * @throws DatabaseException
219 * if a database error occurs
221 public void saveArtistProperties(Artist artist) throws DatabaseException {
222 saveProperties(artist.getProperties(), "ARTIST_PROPERTIES", "ARTIST", artist.getId());
226 * Saves the given properties to the given table for the given principal.
229 * The properties to save
231 * The table in which to save the properties
233 * The type of the principal (e. g. “ARTIST” or “TRACK”)
235 * The ID of the principial
236 * @throws DatabaseException
237 * if a database error occurs
239 public void saveProperties(Properties properties, String table, String type, String id) throws DatabaseException {
240 if (!properties.isDirty()) {
243 Query query = new Query(Type.DELETE, table);
244 query.addWhereClause(new ValueFieldWhereClause(new ValueField(type, new StringParameter(id))));
245 database.update(query);
246 for (Entry<String, String> property : properties) {
247 Query insertQuery = new Query(Type.INSERT, table);
248 insertQuery.addValueField(new ValueField(type, new StringParameter(id)));
249 insertQuery.addValueField(new ValueField("PROPERTY", new StringParameter(property.getKey())));
250 insertQuery.addValueField(new ValueField("VALUE", new StringParameter(property.getValue())));
251 database.insert(insertQuery);
253 properties.resetDirty();
257 * Loads the properties for an artist.
260 * The artist to load the properties for
262 * @throws DatabaseException
263 * if a database error occurs
265 public Artist loadArtistProperties(final Artist artist) throws DatabaseException {
266 return loadProperties(artist, "ARTIST_PROPERTIES", "ARTIST");
270 * Loads the properties of all given artists.
273 * The artists to load the properties for
274 * @return The list of artists
275 * @throws DatabaseException
276 * if a database error occurs
278 public List<Artist> loadArtistProperties(List<Artist> artists) throws DatabaseException {
279 for (Artist artist : artists) {
280 loadArtistProperties(artist);
286 * Returns all remix artists involved in the track with the given ID.
289 * The ID of the track
290 * @return All remix artists involved in the track, in preferred order
291 * @throws DatabaseException
292 * if a database error occurs
294 public List<Artist> getRemixArtistsByTrack(String trackId) throws DatabaseException {
295 Query query = new Query(Type.SELECT, "ARTISTS");
296 query.addField(new Field("ARTISTS.*"));
297 query.addJoin(new Join(JoinType.INNER, "TRACK_REMIX_ARTISTS", new Field("TRACK_REMIX_ARTISTS.ARTIST"), new Field("ARTISTS.ID")));
298 query.addWhereClause(new ValueFieldWhereClause(new ValueField("TRACK_REMIX_ARTISTS.TRACK", new StringParameter(trackId))));
299 query.addOrderField(new OrderField(new Field("TRACK_REMIX_ARTISTS.DISPLAY_ORDER")));
300 return database.getMultiple(query, artistCreator);
304 * Returns all related tracks for the track with the given ID.
307 * The ID of the tracks
308 * @return A mapping from relationship to all tracks that match the relation
309 * @throws DatabaseException
310 * if a database error occurs
312 public Map<Relationship, Collection<Track>> getRelatedTracksByTrack(String trackId) throws DatabaseException {
313 Query query = new Query(Type.SELECT, "TRACKS");
314 query.addField(new Field("TRACKS.*"));
315 query.addField(new Field("TRACK_RELATIONS.*"));
316 query.addJoin(new Join(JoinType.INNER, "TRACK_RELATIONS", new Field("TRACK_RELATIONS.TRACK"), new Field("TRACK_RELATIONS.RELATED_TRACK")));
317 query.addWhereClause(new ValueFieldWhereClause(new ValueField("TRACK_RELATIONS.TRACK", new StringParameter(trackId))));
318 final Map<Relationship, Collection<Track>> relatedTracks = new EnumMap<Relationship, Collection<Track>>(Relationship.class);
319 database.process(query, new ResultProcessor() {
322 @SuppressWarnings("synthetic-access")
323 public void processResult(ResultSet resultSet) throws SQLException {
324 Track track = trackCreator.createObject(resultSet);
325 Relationship relationship = Relationship.valueOf(resultSet.getString("TRACK_RELATIONS.RELATIONSHIP"));
326 if (!relatedTracks.containsKey(relationship)) {
327 relatedTracks.put(relationship, new HashSet<Track>());
329 relatedTracks.get(relationship).add(track);
332 return relatedTracks;
336 * Returns the track with the given ID.
339 * The ID of the track
340 * @return The track with the given ID, or {@code null} if there is no such
342 * @throws DatabaseException
343 * if a database error occurs
345 public Track getTrackById(String id) throws DatabaseException {
346 Query query = new Query(Type.SELECT, "TRACKS");
347 query.addField(new Field("TRACKS.*"));
348 query.addWhereClause(new ValueFieldWhereClause(new ValueField("TRACKS.ID", new StringParameter(id))));
349 return loadTrackProperties(database.getSingle(query, trackCreator));
353 * Returns the track that contains the derivative with the given ID.
356 * The ID of the track derivative
357 * @return The track the derivative belongs to, or {@code null} if there is
359 * @throws DatabaseException
360 * if a database error occurs
362 public Track getTrackByDerivativeId(String id) throws DatabaseException {
363 Query query = new Query(Type.SELECT, "TRACKS");
364 query.addField(new Field("TRACKS.*"));
365 query.addJoin(new Join(JoinType.INNER, "TRACK_DERIVATIVES", new Field("TRACK_DERIVATIVES.TRACK"), new Field("TRACKS.ID")));
366 query.addWhereClause(new ValueFieldWhereClause(new ValueField("TRACK_DERIVATIVES.ID", new StringParameter(id))));
367 return loadTrackProperties(database.getSingle(query, trackCreator));
371 * Returns all tracks by the artist with the given ID.
374 * The ID of the artist
375 * @return All tracks by the given artist
376 * @throws DatabaseException
377 * if a database error occurs
379 public Collection<Track> getTracksByArtist(String artistId) throws DatabaseException {
380 Query query = new Query(Type.SELECT, "TRACKS");
381 query.addField(new Field("TRACKS.*"));
382 query.addJoin(new Join(JoinType.INNER, "TRACK_ARTISTS", new Field("TRACKS.ID"), new Field("TRACK_ARTISTS.TRACK")));
383 query.addWhereClause(new ValueFieldWhereClause(new ValueField("TRACK_ARTISTS.ARTIST", new StringParameter(artistId))));
384 return loadTrackProperties(database.getMultiple(query, trackCreator));
388 * Returns all tracks that were released at the party with the given ID.
391 * The ID of the party
392 * @return All tracks that were released at the given party
393 * @throws DatabaseException
394 * if a database error occurs
396 public Collection<Track> getTracksByParty(String partyId) throws DatabaseException {
397 Query query = new Query(Type.SELECT, "TRACKS");
398 query.addField(new Field("TRACKS.*"));
399 query.addJoin(new Join(JoinType.INNER, "PARTY_TRACKS", new Field("PARTY_TRACKS.TRACK"), new Field("TRACKS.ID")));
400 query.addWhereClause(new ValueFieldWhereClause(new ValueField("PARTY_TRACKS.PARTY", new StringParameter(partyId))));
401 return loadTrackProperties(database.getMultiple(query, trackCreator));
405 * Loads the properties for the given track.
408 * The track for which to load the properties
409 * @return The track with the properties loaded
410 * @throws DatabaseException
411 * if a database error occurs
413 public Track loadTrackProperties(Track track) throws DatabaseException {
414 return loadProperties(track, "TRACK_PROPERTIES", "TRACK");
418 * Loads the properties for the given tracks.
421 * The tracks for which to load the properties
422 * @return The tracks with the properties loaded
423 * @throws DatabaseException
424 * if a database error occurs
426 public List<Track> loadTrackProperties(List<Track> tracks) throws DatabaseException {
427 for (Track track : tracks) {
428 loadTrackProperties(track);
434 * Creates a new track with the given name.
437 * The name of the track
438 * @return The created track
439 * @throws DatabaseException
440 * if a database error occurs
442 public Track createTrack(String name) throws DatabaseException {
443 Query query = new Query(Type.INSERT, "TRACKS");
444 String id = UUID.randomUUID().toString();
445 query.addValueField(new ValueField("ID", new StringParameter(id)));
446 query.addValueField(new ValueField("NAME", new StringParameter(name)));
447 database.insert(query);
448 return getTrackById(id);
452 * Saves the given track. This also saves all relationships of the track.
456 * @throws DatabaseException
457 * if a database error occurs
459 public void saveTrack(Track track) throws DatabaseException {
460 Query query = new Query(Type.UPDATE, "TRACKS");
461 query.addValueField(new ValueField("TRACKS.NAME", new StringParameter(track.getName())));
462 query.addValueField(new ValueField("TRACKS.REMIX", new StringParameter(track.getRemix())));
463 query.addWhereClause(new ValueFieldWhereClause(new ValueField("TRACKS.ID", new StringParameter(track.getId()))));
464 database.update(query);
465 /* store artist information. */
466 track.getArtists(); /* prefetch artists. */
467 query = new Query(Type.DELETE, "TRACK_ARTISTS");
468 query.addWhereClause(new ValueFieldWhereClause(new ValueField("TRACK_ARTISTS.TRACK", new StringParameter(track.getId()))));
469 database.update(query);
470 for (int index = 0; index < track.getArtists().size(); ++index) {
471 query = new Query(Type.INSERT, "TRACK_ARTISTS");
472 query.addValueField(new ValueField("TRACK_ARTISTS.TRACK", new StringParameter(track.getId())));
473 query.addValueField(new ValueField("TRACK_ARTISTS.ARTIST", new StringParameter(track.getArtists().get(index).getId())));
474 query.addValueField(new ValueField("TRACK_ARTISTS.DISPLAY_ORDER", new IntegerParameter(index + 1)));
475 database.insert(query);
478 /* store party links. */
479 Collection<Party> parties = track.getParties(); /* prefetch parties. */
480 query = new Query(Type.DELETE, "PARTY_TRACKS");
481 query.addWhereClause(new ValueFieldWhereClause(new ValueField("PARTY_TRACKS.TRACK", new StringParameter(track.getId()))));
482 database.update(query);
483 for (Party party : parties) {
484 query = new Query(Type.INSERT, "PARTY_TRACKS");
485 query.addValueField(new ValueField("PARTY_TRACKS.TRACK", new StringParameter(track.getId())));
486 query.addValueField(new ValueField("PARTY_TRACKS.PARTY", new StringParameter(party.getId())));
487 database.insert(query);
490 /* store properties. */
491 saveProperties(track.getProperties(), "TRACK_PROPERTIES", "TRACK", track.getId());
495 * Returns the derivative with the given ID.
498 * The ID of the derivatives to load
499 * @return The derivative with the given ID
500 * @throws DatabaseException
501 * if a database error occurs
503 public TrackDerivative getTrackDerivativeById(String id) throws DatabaseException {
504 Query query = new Query(Type.SELECT, "TRACK_DERIVATIVES");
505 query.addField(new Field("TRACK_DERIVATIVES.*"));
506 query.addWhereClause(new ValueFieldWhereClause(new ValueField("TRACK_DERIVATIVES.ID", new StringParameter(id))));
507 return loadTrackDerivativeProperties(database.getSingle(query, trackDerivativeCreator));
511 * Returns the derivatives for the given track.
514 * The track ID to get the derivatives for
515 * @return The derivatives for the given track
516 * @throws DatabaseException
517 * if a database error occurs
519 public Collection<TrackDerivative> getTrackDerivativesByTrack(String trackId) throws DatabaseException {
520 Query query = new Query(Type.SELECT, "TRACK_DERIVATIVES");
521 query.addField(new Field("TRACK_DERIVATIVES.*"));
522 query.addWhereClause(new ValueFieldWhereClause(new ValueField("TRACK_DERIVATIVES.TRACK", new StringParameter(trackId))));
523 return loadTrackDerivativeProperties(database.getMultiple(query, trackDerivativeCreator));
527 * Creates a new derivative for the given track.
530 * The track to create the derivative for
531 * @return The created derivative
532 * @throws DatabaseException
533 * if a database error occurs
535 public TrackDerivative createTrackDerivative(Track track) throws DatabaseException {
536 Query query = new Query(Type.INSERT, "TRACK_DERIVATIVES");
537 String id = UUID.randomUUID().toString();
538 query.addValueField(new ValueField("TRACK_DERIVATIVES.ID", new StringParameter(id)));
539 query.addValueField(new ValueField("TRACK_DERIVATIVES.TRACK", new StringParameter(track.getId())));
540 database.insert(query);
541 return getTrackDerivativeById(id);
545 * Loads the properties for the given track derivative.
547 * @param trackDerivative
548 * The track derivative to load the properties for
549 * @return The track derivative with its properties loaded
550 * @throws DatabaseException
551 * if a database error occurs
553 public TrackDerivative loadTrackDerivativeProperties(TrackDerivative trackDerivative) throws DatabaseException {
554 return loadProperties(trackDerivative, "TRACK_DERIVATIVE_PROPERTIES", "TRACK_DERIVATIVE");
558 * Loads the properties for the given track derivatives.
560 * @param trackDerivatives
561 * The track derivatives to load the properties for
562 * @return The track derivatives with their properties loaded
563 * @throws DatabaseException
564 * if a database error occurs
566 public List<TrackDerivative> loadTrackDerivativeProperties(List<TrackDerivative> trackDerivatives) throws DatabaseException {
567 for (TrackDerivative trackDerivative : trackDerivatives) {
568 loadTrackDerivativeProperties(trackDerivative);
570 return trackDerivatives;
574 * Saves the given track derivative. As a track derivative does not have any
575 * attributes of its own only its properties are saved.
577 * @param trackDerivative
578 * The track derivative to save
579 * @throws DatabaseException
580 * if a database error occurs
582 public void saveTrackDerivate(TrackDerivative trackDerivative) throws DatabaseException {
583 saveProperties(trackDerivative.getProperties(), "TRACK_DERIVATIVE_PROPERTIES", "TRACK_DERIVATIVE", trackDerivative.getId());
587 * Removes the given track derivative and all its properties from the
590 * @param trackDerivative
591 * The track derivative to remove
592 * @throws DatabaseException
593 * if a database error occurs
595 public void removeTrackDerivative(TrackDerivative trackDerivative) throws DatabaseException {
596 Query query = new Query(Type.DELETE, "TRACK_DERIVATIVES");
597 query.addWhereClause(new ValueFieldWhereClause(new ValueField("TRACK_DERIVATIVES.ID", new StringParameter(trackDerivative.getId()))));
598 database.update(query);
599 /* remove the properties. */
600 saveProperties(new Properties().set("dirty", "true").removeAll(), "TRACK_DERIVATIVE_PROPERTIES", "TRACK_DERIVATIVE", trackDerivative.getId());
604 * Returns all groups.
607 * @throws DatabaseException
608 * if a database error occurs
610 public Collection<Group> getAllGroups() throws DatabaseException {
611 Query query = new Query(Type.SELECT, "GROUPS");
612 query.addField(new Field("GROUPS.*"));
613 return loadGroupProperties(database.getMultiple(query, groupCreator));
617 * Returns the group with the given ID.
620 * The ID of the group
621 * @return The group with the given ID, or {@code null} if no such group
623 * @throws DatabaseException
624 * if a database error occurs
626 public Group getGroupById(String groupId) throws DatabaseException {
627 Query query = new Query(Type.SELECT, "GROUPS");
628 query.addField(new Field("GROUPS.*"));
629 query.addWhereClause(new ValueFieldWhereClause(new ValueField("GROUPS.ID", new StringParameter(groupId))));
630 return loadGroupProperties(database.getSingle(query, groupCreator));
634 * Returns all groups the artist with the given ID belongs to.
637 * The ID of the artist
638 * @return All groups the artist belongs to
639 * @throws DatabaseException
640 * if a database error occurs
642 public Collection<Group> getGroupsByArtist(String artistId) throws DatabaseException {
643 Query query = new Query(Type.SELECT, "GROUPS");
644 query.addField(new Field("GROUPS.*"));
645 query.addJoin(new Join(JoinType.INNER, "GROUP_ARTISTS", new Field("GROUPS.ID"), new Field("GROUP_ARTISTS.GROUP_")));
646 query.addWhereClause(new ValueFieldWhereClause(new ValueField("GROUP_ARTISTS.ARTIST", new StringParameter(artistId))));
647 return database.getMultiple(query, groupCreator);
651 * Loads the properties of the given group.
654 * The group to load the properties for
655 * @return The group with its properties loaded
656 * @throws DatabaseException
657 * if a database error occurs
659 public Group loadGroupProperties(Group group) throws DatabaseException {
660 return loadProperties(group, "GROUP_PROPERTIES", "GROUP_ID");
664 * Loads the properties of the given groups.
667 * The groups to load the properties for
668 * @return The groups with their properties loaded
669 * @throws DatabaseException
670 * if a database error occurs
672 public Collection<Group> loadGroupProperties(Collection<Group> groups) throws DatabaseException {
673 for (Group group : groups) {
674 loadGroupProperties(group);
680 * Creates a group with the given name.
683 * The name of the new group
684 * @return The new group
685 * @throws DatabaseException
686 * if a database error occurs
688 public Group createGroup(String name) throws DatabaseException {
689 Query query = new Query(Type.INSERT, "GROUPS");
690 String id = UUID.randomUUID().toString();
691 query.addValueField(new ValueField("ID", new StringParameter(id)));
692 query.addValueField(new ValueField("NAME", new StringParameter(name)));
693 database.insert(query);
694 return getGroupById(id);
698 * Saves the given group.
702 * @throws DatabaseException
703 * if a database error occurs
705 public void saveGroup(Group group) throws DatabaseException {
706 Query query = new Query(Type.UPDATE, "GROUPS");
707 query.addValueField(new ValueField("NAME", new StringParameter(group.getName())));
708 query.addWhereClause(new ValueFieldWhereClause(new ValueField("ID", new StringParameter(group.getId()))));
709 database.update(query);
710 /* save properties. */
711 saveGroupProperties(group);
715 * Saves the properties of the given group.
718 * The group whose properties to save
719 * @throws DatabaseException
720 * if a database error occurs
722 public void saveGroupProperties(Group group) throws DatabaseException {
723 saveProperties(group.getProperties(), "GROUP_PROPERTIES", "GROUP_ID", group.getId());
727 * Returns all styles for the track with the given ID.
730 * The ID of the track
731 * @return All styles for the given track
732 * @throws DatabaseException
733 * if a database error occurs
735 public Collection<Style> getStylesByTrack(String trackId) throws DatabaseException {
736 Query query = new Query(Type.SELECT, "STYLES");
737 query.addField(new Field("STYLES.*"));
738 query.addJoin(new Join(JoinType.INNER, "TRACK_STYLES", new Field("STYLES.ID"), new Field("TRACK_STYLES.STYLE")));
739 query.addWhereClause(new ValueFieldWhereClause(new ValueField("TRACK_STYLES.TRACK", new StringParameter(trackId))));
740 return database.getMultiple(query, styleCreator);
744 * Returns all parties.
746 * @return All parties
747 * @throws DatabaseException
748 * if a database error occurs
750 public Collection<Party> getAllParties() throws DatabaseException {
751 Query query = new Query(Type.SELECT, "PARTIES");
752 query.addField(new Field("PARTIES.*"));
753 return loadPartyProperties(database.getMultiple(query, partyCreator));
757 * Returns all parties that the track with the given ID was released at.
760 * The ID of the track
761 * @return All parties the track was released at
762 * @throws DatabaseException
763 * if a database error occurs
765 public Collection<Party> getPartiesByTrackId(String trackId) throws DatabaseException {
766 Query query = new Query(Type.SELECT, "PARTIES");
767 query.addField(new Field("PARTIES.*"));
768 query.addJoin(new Join(JoinType.INNER, "PARTY_TRACKS", new Field("PARTY_TRACKS.PARTY"), new Field("PARTIES.ID")));
769 query.addWhereClause(new ValueFieldWhereClause(new ValueField("PARTY_TRACKS.TRACK", new StringParameter(trackId))));
770 return loadPartyProperties(database.getMultiple(query, partyCreator));
774 * Returns the party with the given ID.
777 * The ID of the party
778 * @return The party with the given ID
779 * @throws DatabaseException
780 * if a database error occurs
782 public Party getPartyById(String partyId) throws DatabaseException {
783 Query query = new Query(Type.SELECT, "PARTIES");
784 query.addField(new Field("PARTIES.*"));
785 query.addWhereClause(new ValueFieldWhereClause(new ValueField("PARTIES.ID", new StringParameter(partyId))));
786 return loadPartyProperties(database.getSingle(query, partyCreator));
790 * Loads the properties of the given party.
793 * The party to load the properties for
794 * @return The party with its properties loaded
795 * @throws DatabaseException
796 * if a database error occurs
798 public Party loadPartyProperties(Party party) throws DatabaseException {
799 return loadProperties(party, "PARTY_PROPERTIES", "PARTY");
803 * Loads the properties of the given parties.
806 * The parties to load the properties for
807 * @return The parties with their properties loaded
808 * @throws DatabaseException
809 * if a database error occurs
811 public List<Party> loadPartyProperties(List<Party> parties) throws DatabaseException {
812 for (Party party : parties) {
813 loadPartyProperties(party);
819 * Saves the given party.
823 * @throws DatabaseException
824 * if a database error occurs
826 public void saveParty(Party party) throws DatabaseException {
827 Query query = new Query(Type.UPDATE, "PARTIES");
828 query.addValueField(new ValueField("NAME", new StringParameter(party.getName())));
829 query.addWhereClause(new ValueFieldWhereClause(new ValueField("ID", new StringParameter(party.getId()))));
830 database.update(query);
831 savePartyProperties(party);
835 * Saves the properties of the given party.
838 * The party whose properties to save
839 * @throws DatabaseException
840 * if a database error occurs
842 public void savePartyProperties(Party party) throws DatabaseException {
843 saveProperties(party.getProperties(), "PARTY_PROPERTIES", "PARTY", party.getId());
847 * Creates a new party with the given name.
850 * The name of the party
851 * @return The new party
852 * @throws DatabaseException
853 * if a database error occurs
855 public Party createParty(String name) throws DatabaseException {
856 Query query = new Query(Type.INSERT, "PARTIES");
857 String id = UUID.randomUUID().toString();
858 query.addValueField(new ValueField("ID", new StringParameter(id)));
859 query.addValueField(new ValueField("NAME", new StringParameter(name)));
860 database.insert(query);
861 return getPartyById(id);
865 * Returns the user with the given name.
868 * The name of the user
869 * @return The user, or {@code null} if the user does not exist
870 * @throws DatabaseException
871 * if a database error occurs
873 public User getUserByName(String username) throws DatabaseException {
874 Query query = new Query(Type.SELECT, "USERS");
875 query.addField(new Field("USERS.*"));
876 query.addWhereClause(new ValueFieldWhereClause(new ValueField("USERS.NAME", new StringParameter(username))));
877 return database.getSingle(query, userCreator);
881 * Returns the user connected with the given OpenID.
884 * The OpenID to find the user for
885 * @return The user connected with the given OpenID, or {@code null} if
886 * there is no such user
887 * @throws DatabaseException
888 * if a database error occurs
890 public User getUserByOpenId(String openId) throws DatabaseException {
891 Query query = new Query(Type.SELECT, "USERS");
892 query.addField(new Field("USERS.*"));
893 query.addJoin(new Join(JoinType.INNER, "USER_OPENIDS", new Field("USER_OPENIDS.USER"), new Field("USERS.ID")));
894 query.addWhereClause(new ValueFieldWhereClause(new ValueField("USER_OPENIDS.OPENID", new StringParameter(openId))));
895 return database.getSingle(query, userCreator);
899 * Returns all OpenIDs connected with the user with the given ID.
903 * @return All OpenIDs connected with the given user
904 * @throws DatabaseException
905 * if a database error occurs
907 public Collection<String> getOpenIdsByUser(String userId) throws DatabaseException {
908 Query query = new Query(Type.SELECT, "USER_OPENIDS");
909 query.addField(new Field("USER_OPENIDS.*"));
910 query.addWhereClause(new ValueFieldWhereClause(new ValueField("USER_OPENIDS.USER", new StringParameter(userId))));
911 return database.getMultiple(query, new StringCreator("USER_OPENIDS.OPENID"));
919 * Loads the properties for the given object.
922 * The type of the object
926 * The table to load the properties from
928 * The type of the object (“ARTIST,” “TRACK,” etc.)
929 * @return The object with its properties loaded
930 * @throws DatabaseException
931 * if a database error occurs
933 private <T extends Base> T loadProperties(final T object, final String table, String type) throws DatabaseException {
934 if (object == null) {
937 Query query = new Query(Type.SELECT, table);
938 query.addField(new Field(table + ".PROPERTY"));
939 query.addField(new Field(table + ".VALUE"));
940 query.addWhereClause(new ValueFieldWhereClause(new ValueField(type, new StringParameter(object.getId()))));
941 database.process(query, new ResultProcessor() {
944 public void processResult(ResultSet resultSet) throws SQLException {
945 if (resultSet.isFirst()) {
946 object.getProperties().removeAll();
948 object.getProperties().set(resultSet.getString(table + ".PROPERTY"), resultSet.getString(table + ".VALUE"));
956 * Loads the properties for the given objects.
959 * The type of the object
963 * The table to load the properties from
965 * The type of the object (“ARTIST,” “TRACK,” etc.)
966 * @return The object with its properties loaded
967 * @throws DatabaseException
968 * if a database error occurs
970 private <T extends Base> List<T> loadProperties(List<T> objects, final String table, final String type) throws DatabaseException {
971 final Map<String, T> objectMap = new HashMap<String, T>();
972 final Set<String> firstObjects = new HashSet<String>();
973 for (T object : objects) {
974 objectMap.put(object.getId(), object);
975 firstObjects.add(object.getId());
977 Query query = new Query(Type.SELECT, table);
978 query.addField(new Field(table + "." + type));
979 query.addField(new Field(table + ".PROPERTY"));
980 query.addField(new Field(table + ".VALUE"));
981 OrWhereClause whereClause = new OrWhereClause();
982 for (T object : objects) {
983 whereClause.add(new ValueFieldWhereClause(new ValueField(type, new StringParameter(object.getId()))));
985 query.addWhereClause(whereClause);
986 database.process(query, new ResultProcessor() {
989 public void processResult(ResultSet resultSet) throws SQLException {
990 String id = resultSet.getString(table + "." + type);
991 T object = objectMap.get(id);
992 if (firstObjects.remove(id)) {
993 object.getProperties().removeAll();
995 object.getProperties().set(resultSet.getString(table + ".PROPERTY"), resultSet.getString(table + ".VALUE"));
1003 * {@link Artist} implementation that retrieves some attributes (such as
1004 * {@link #getGroups()}, and {@link #getTracks()}) from the
1005 * {@link DataManager} on demand.
1007 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
1009 private class LazyArtist extends DefaultArtist {
1011 /** Memoizer for the tracks by this artist. */
1012 private final Memoizer<Void> tracksMemoizer = new Memoizer<Void>(new Callable<Void>() {
1015 public Void call() throws DatabaseException {
1016 if (!hasValue("tracks")) {
1017 getValue("tracks", Collection.class).set(getTracksByArtist(getId()));
1023 /** Memoizer for the groups of this artist. */
1024 private final Memoizer<Void> groupsMemoizer = new Memoizer<Void>(new Callable<Void>() {
1027 public Void call() throws Exception {
1028 if (!hasValue("groups")) {
1029 getValue("groups", Collection.class).set(getGroupsByArtist(getId()));
1037 * Creates a new lazy artist.
1040 * The ID of the artist
1042 public LazyArtist(String id) {
1047 // DEFAULTARTIST METHODS
1054 public Collection<Group> getGroups() {
1055 groupsMemoizer.get();
1056 return super.getGroups();
1063 public Collection<Track> getTracks() {
1064 tracksMemoizer.get();
1065 return super.getTracks();
1071 * {@link ObjectCreator} implementation that can create {@link Artist}
1072 * objects. This specific class actually creates {@link LazyArtist}
1075 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
1077 private class ArtistCreator implements ObjectCreator<Artist> {
1083 public Artist createObject(ResultSet resultSet) throws SQLException {
1084 return new LazyArtist(resultSet.getString("ARTISTS.ID")).setName(resultSet.getString("ARTISTS.NAME"));
1090 * {@link Group} implementation that retrieves some attributes (such as
1091 * {@link #getArtists()}) from the {@link DataManager} on demand.
1093 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
1095 private class LazyGroup extends DefaultGroup {
1097 /** Memoizer for the artist. */
1098 private final Memoizer<Void> artistsMemoizer = new Memoizer<Void>(new Callable<Void>() {
1101 public Void call() throws Exception {
1102 if (!hasValue("artists")) {
1103 getValue("artists", Collection.class).set(getArtistsByGroup(getId()));
1111 * Creates a new lazy group.
1114 * The ID of the group
1116 public LazyGroup(String id) {
1121 // DEFAULTGROUP METHODS
1128 public Collection<Artist> getArtists() {
1129 artistsMemoizer.get();
1130 return super.getArtists();
1136 * {@link ObjectCreator} implementation that can create {@link Group}
1137 * objects. This specific implementation creates {@link LazyGroup}
1140 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
1142 private class GroupCreator implements ObjectCreator<Group> {
1148 public Group createObject(ResultSet resultSet) throws SQLException {
1149 return new LazyGroup(resultSet.getString("GROUPS.ID")).setName(resultSet.getString("GROUPS.NAME"));
1155 * {@link Track} implementation that retrieves some attributes (such as
1156 * {@link #getArtists()}, and {@link #getStyles()}) from the
1157 * {@link DataManager} on demand.
1159 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
1161 private class LazyTrack extends DefaultTrack {
1163 /** Memoizer for the artists. */
1164 private final Memoizer<Void> artistsMemoizer = new Memoizer<Void>(new Callable<Void>() {
1167 public Void call() throws Exception {
1168 if (!hasValue("artists")) {
1169 getValue("artists", List.class).set(getArtistsByTrack(getId()));
1176 /** Memoizer for the styles. */
1177 private final Memoizer<Void> stylesMemoizer = new Memoizer<Void>(new Callable<Void>() {
1180 public Void call() throws Exception {
1181 if (!hasValue("styles")) {
1182 getValue("styles", Collection.class).set(getStylesByTrack(getId()));
1189 /** Memoizer for the remix artists. */
1190 private final Memoizer<Void> remixArtistsMemoizer = new Memoizer<Void>(new Callable<Void>() {
1193 public Void call() throws Exception {
1194 if (!hasValue("remixArtists")) {
1195 getValue("remixArtists", List.class).set(getRemixArtistsByTrack(getId()));
1202 /** Memoizer for the track derivatives. */
1203 private final Memoizer<Void> derivativesMemoizer = new Memoizer<Void>(new Callable<Void>() {
1206 public Void call() throws Exception {
1207 if (!hasValue("derivatives")) {
1208 getValue("derivatives", Collection.class).set(getTrackDerivativesByTrack(getId()));
1215 /** Memoizer for the related tracks. */
1216 private final Memoizer<Void> relatedTracksMemoizer = new Memoizer<Void>(new Callable<Void>() {
1219 public Void call() throws Exception {
1220 if (!hasValue("relatedTracks")) {
1221 getValue("relatedTracks", Map.class).set(getRelatedTracksByTrack(getId()));
1229 * Creates a new track.
1232 * The ID of the track
1234 public LazyTrack(String id) {
1239 // DEFAULTTRACK METHODS
1246 public List<Artist> getArtists() {
1247 artistsMemoizer.get();
1248 return super.getArtists();
1255 public Collection<Style> getStyles() {
1256 stylesMemoizer.get();
1257 return super.getStyles();
1264 public List<Artist> getRemixArtists() {
1265 remixArtistsMemoizer.get();
1266 return super.getRemixArtists();
1273 public Collection<TrackDerivative> getDerivatives() {
1274 derivativesMemoizer.get();
1275 return super.getDerivatives();
1282 public Map<Relationship, Collection<Track>> getRelatedTracks() {
1283 relatedTracksMemoizer.get();
1284 return super.getRelatedTracks();
1291 public Collection<Party> getParties() {
1292 if (!hasValue("parties")) {
1294 getValue("parties", Collection.class).set(getPartiesByTrackId(getId()));
1295 } catch (DatabaseException de1) {
1296 throw new RuntimeException("Could not load Parties for Track " + getId() + ".", de1);
1299 return super.getParties();
1305 * {@link ObjectCreator} implementation that can create {@link Track}
1306 * objects. This specific implementation creates {@link LazyTrack}
1309 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
1311 private class TrackCreator implements ObjectCreator<Track> {
1317 public Track createObject(ResultSet resultSet) throws SQLException {
1318 return new LazyTrack(resultSet.getString("TRACKS.ID")).setName(resultSet.getString("TRACKS.NAME")).setRemix(resultSet.getString("TRACKS.REMIX"));
1324 * {@link ObjectCreator} implementation that can create
1325 * {@link TrackDerivative} objects.
1327 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
1329 private class TrackDerivativeCreator implements ObjectCreator<TrackDerivative> {
1335 public TrackDerivative createObject(ResultSet resultSet) throws SQLException {
1336 return new DefaultTrackDerivative(resultSet.getString("TRACK_DERIVATIVES.ID"));
1342 * {@link ObjectCreator} implementation that can create {@link Style}
1345 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
1347 private class StyleCreator implements ObjectCreator<Style> {
1353 public Style createObject(ResultSet resultSet) throws SQLException {
1354 return new DefaultStyle(resultSet.getString("STYLES.ID")).setName(resultSet.getString("STYLES.NAME"));
1360 * {@link Party} implementation that loads additional information only on
1363 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
1365 private class LazyParty extends DefaultParty {
1368 * Creates a new party.
1371 * The ID of the party
1373 public LazyParty(String id) {
1385 public Collection<Track> getReleases() {
1386 if (!hasValue("releases")) {
1388 getValue("releases", Collection.class).set(getTracksByParty(getId()));
1389 } catch (DatabaseException de1) {
1390 throw new RuntimeException("Could not loaded Tracks for Party " + getId() + ".", de1);
1393 return super.getReleases();
1399 * {@link ObjectCreator} implementation that can create {@link Party}
1402 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
1404 private class PartyCreator implements ObjectCreator<Party> {
1410 public Party createObject(ResultSet resultSet) throws SQLException {
1411 return new LazyParty(resultSet.getString("PARTIES.ID")).setName(resultSet.getString("PARTIES.NAME"));
1417 * {@link User} implementation that retrieves some attributes (such as
1418 * {@link #getOpenIds()}) from the {@link DataManager} on demand.
1420 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
1422 private class LazyUser extends DefaultUser {
1424 /** Memoizer for a user’s OpenIDs. */
1425 private final Memoizer<Void> openIdMemoizer = new Memoizer<Void>(new Callable<Void>() {
1428 public Void call() throws Exception {
1429 if (!hasValue("openIds")) {
1430 getValue("openIds", Collection.class).set(getOpenIdsByUser(getId()));
1437 * Creates a new user.
1440 * The ID of the user
1442 public LazyUser(String id) {
1450 public Collection<String> getOpenIds() {
1451 openIdMemoizer.get();
1452 return super.getOpenIds();
1458 * {@link ObjectCreator} implementation that can create {@link User}
1459 * objects. This specific implementation creates {@link LazyUser} instances.
1461 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
1463 private class UserCreator implements ObjectCreator<User> {
1469 public User createObject(ResultSet resultSet) throws SQLException {
1470 return new LazyUser(resultSet.getString("USERS.ID")).setName(resultSet.getString("USERS.NAME")).setPasswordHash(resultSet.getString("USERS.PASSWORD")).setLevel(resultSet.getInt("USERS.LEVEL"));