1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
|
/*
This file is part of Subsonic.
Subsonic is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
Subsonic is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with Subsonic. If not, see <http://www.gnu.org/licenses/>.
Copyright 2009 (C) Sindre Mehus
*/
package net.sourceforge.subsonic.domain;
import java.util.ArrayList;
import java.util.List;
import java.io.Serializable;
/**
* A music index is a mapping from an index string to a list of prefixes. A complete index consists of a list of
* <code>MusicIndex</code> instances.<p/>
* <p/>
* For a normal alphabetical index, such a mapping would typically be <em>"A" -> ["A"]</em>. The index can also be used
* to group less frequently used letters, such as <em>"X-Å" -> ["X", "Y", "Z", "Æ", "Ø", "Å"]</em>, or to make multiple
* indexes for frequently used letters, such as <em>"SA" -> ["SA"]</em> and <em>"SO" -> ["SO"]</em><p/>
* <p/>
* Clicking on an index in the user interface will typically bring up a list of all music files that are categorized
* under that index.
*
* @author Sindre Mehus
*/
public class MusicIndex implements Serializable {
public static final MusicIndex OTHER = new MusicIndex("#");
private final String index;
private final List<String> prefixes = new ArrayList<String>();
/**
* Creates a new index with the given index string.
*
* @param index The index string, e.g., "A" or "The".
*/
public MusicIndex(String index) {
this.index = index;
}
/**
* Adds a prefix to this index. Music files that starts with this prefix will be categorized under this index entry.
*
* @param prefix The prefix.
*/
public void addPrefix(String prefix) {
prefixes.add(prefix);
}
/**
* Returns the index name.
*
* @return The index name.
*/
public String getIndex() {
return index;
}
/**
* Returns the list of prefixes.
*
* @return The list of prefixes.
*/
public List<String> getPrefixes() {
return prefixes;
}
/**
* Returns whether this object is equal to another one.
*
* @param o Object to compare to.
* @return <code>true</code> if, and only if, the other object is a <code>MusicIndex</code> with the same
* index name as this one.
*/
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (!(o instanceof MusicIndex)) {
return false;
}
final MusicIndex musicIndex = (MusicIndex) o;
if (index != null ? !index.equals(musicIndex.index) : musicIndex.index != null) {
return false;
}
return true;
}
/**
* Returns a hash code for this object.
*
* @return A hash code for this object.
*/
@Override
public int hashCode() {
return (index != null ? index.hashCode() : 0);
}
/**
* An artist in an index.
*/
public static class Artist implements Comparable<Artist>, Serializable {
private final String name;
private final String sortableName;
private final List<MediaFile> mediaFiles = new ArrayList<MediaFile>();
public Artist(String name, String sortableName) {
this.name = name;
this.sortableName = sortableName;
}
public void addMediaFile(MediaFile mediaFile) {
mediaFiles.add(mediaFile);
}
public String getName() {
return name;
}
public String getSortableName() {
return sortableName;
}
public List<MediaFile> getMediaFiles() {
return mediaFiles;
}
public int compareTo(Artist artist) {
return sortableName.compareToIgnoreCase(artist.sortableName);
}
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
Artist artist = (Artist) o;
return sortableName.equalsIgnoreCase(artist.sortableName);
}
@Override
public int hashCode() {
return sortableName.hashCode();
}
}
}
|
