1
|
/**
|
2
|
* Copyright (C) 2009 EDIT
|
3
|
* European Distributed Institute of Taxonomy
|
4
|
* http://www.e-taxonomy.eu
|
5
|
*
|
6
|
* The contents of this file are subject to the Mozilla Public License Version 1.1
|
7
|
* See LICENSE.TXT at the top of this package for the full license terms.
|
8
|
*/
|
9
|
|
10
|
package eu.etaxonomy.cdm.model.term;
|
11
|
|
12
|
import java.util.Iterator;
|
13
|
import java.util.NoSuchElementException;
|
14
|
import java.util.Set;
|
15
|
import java.util.SortedSet;
|
16
|
import java.util.TreeSet;
|
17
|
|
18
|
import javax.persistence.Entity;
|
19
|
import javax.persistence.Transient;
|
20
|
import javax.xml.bind.annotation.XmlAccessType;
|
21
|
import javax.xml.bind.annotation.XmlAccessorType;
|
22
|
import javax.xml.bind.annotation.XmlRootElement;
|
23
|
import javax.xml.bind.annotation.XmlType;
|
24
|
|
25
|
import org.apache.log4j.Logger;
|
26
|
import org.hibernate.envers.Audited;
|
27
|
|
28
|
import eu.etaxonomy.cdm.common.URI;
|
29
|
import eu.etaxonomy.cdm.model.common.CdmBase;
|
30
|
|
31
|
/**
|
32
|
* @author a.mueller
|
33
|
*
|
34
|
*/
|
35
|
@XmlAccessorType(XmlAccessType.FIELD)
|
36
|
@XmlType(name = "OrderedTermVocabulary")
|
37
|
@XmlRootElement(name = "OrderedTermVocabulary")
|
38
|
@Entity
|
39
|
@Audited
|
40
|
public class OrderedTermVocabulary<T extends OrderedTermBase>
|
41
|
extends TermVocabulary<T>
|
42
|
implements ITermGraph<T, TermNode> {
|
43
|
|
44
|
|
45
|
private static final long serialVersionUID = 7871741306306371242L;
|
46
|
@SuppressWarnings("unused")
|
47
|
private static final Logger logger = Logger.getLogger(OrderedTermVocabulary.class);
|
48
|
|
49
|
// ************************* FACTORY METHODS ***********************************************/
|
50
|
|
51
|
|
52
|
/**
|
53
|
* @param type the {@link TermType term type}, must be the same as for all included terms
|
54
|
* @return
|
55
|
* @throws NullPointerException if type is <code>null</code>
|
56
|
*/
|
57
|
public static OrderedTermVocabulary NewInstance(TermType type){
|
58
|
return new OrderedTermVocabulary(type);
|
59
|
}
|
60
|
|
61
|
|
62
|
/**
|
63
|
* @param type the {@link TermType term type}, must be the same as for all included terms
|
64
|
* @param description the description of this vocabulary
|
65
|
* @param label
|
66
|
* @param labelAbbrev
|
67
|
* @param termSourceUri
|
68
|
* @return
|
69
|
* @throws NullPointerException if type is <code>null</code>
|
70
|
* @deprecated use {@link #NewOrderedInstance(TermType, Class, String, String, String, URI)} instead
|
71
|
*/
|
72
|
@Deprecated
|
73
|
public static OrderedTermVocabulary NewInstance(TermType type, String description, String label, String labelAbbrev, URI termSourceUri){
|
74
|
return new OrderedTermVocabulary(type, description, label, labelAbbrev, termSourceUri);
|
75
|
}
|
76
|
|
77
|
public static <T extends OrderedTermBase<T>> OrderedTermVocabulary<T> NewOrderedInstance(TermType type, Class<T> clazz, String description, String label, String labelAbbrev, URI termSourceUri){
|
78
|
return new OrderedTermVocabulary<T>(type, description, label, labelAbbrev, termSourceUri);
|
79
|
}
|
80
|
|
81
|
|
82
|
//************************ CONSTRUCTOR *****************************************************/
|
83
|
|
84
|
//for hibernate use only
|
85
|
@Deprecated
|
86
|
protected OrderedTermVocabulary() {
|
87
|
super();
|
88
|
}
|
89
|
|
90
|
/**
|
91
|
* @param term
|
92
|
* @param label
|
93
|
* @param termSourceUri
|
94
|
*/
|
95
|
protected OrderedTermVocabulary(TermType type) {
|
96
|
super(type);
|
97
|
}
|
98
|
|
99
|
/**
|
100
|
* @param term
|
101
|
* @param label
|
102
|
* @param termSourceUri
|
103
|
*/
|
104
|
protected OrderedTermVocabulary(TermType type, String term, String label, String labelAbbrev, URI termSourceUri) {
|
105
|
super(type, term, label, labelAbbrev, termSourceUri);
|
106
|
}
|
107
|
|
108
|
|
109
|
//************************* METHODS **************************************/
|
110
|
|
111
|
@Transient
|
112
|
@Override
|
113
|
protected Set<T> newTermSet() {
|
114
|
return new TreeSet<T>();
|
115
|
}
|
116
|
|
117
|
@Transient
|
118
|
public SortedSet<T> getOrderedTerms() {
|
119
|
SortedSet<T> result = getSortedSetOfTerms();
|
120
|
return result;
|
121
|
}
|
122
|
|
123
|
public SortedSet<T> getHigherAndEqualTerms(T otb) {
|
124
|
SortedSet<T> result = new TreeSet<>();
|
125
|
SortedSet<T> sortedSet = getSortedSetOfTerms();
|
126
|
result.addAll( sortedSet.tailSet(otb));
|
127
|
return result;
|
128
|
}
|
129
|
|
130
|
public SortedSet<T> getHigherTerms(T otb) {
|
131
|
SortedSet<T> result = getHigherAndEqualTerms(otb);
|
132
|
for (DefinedTermBase<?> setObjectUnproxied : terms){
|
133
|
@SuppressWarnings("unchecked")
|
134
|
T setObject = (T)CdmBase.deproxy(setObjectUnproxied, OrderedTermBase.class);
|
135
|
if (setObject.compareTo(otb) == 0){
|
136
|
result.remove(setObject);
|
137
|
}
|
138
|
}
|
139
|
return result;
|
140
|
}
|
141
|
|
142
|
public SortedSet<T> getLowerAndEqualTerms(T otb) {
|
143
|
SortedSet<T> result = new TreeSet<>();
|
144
|
result = getLowerTerms(otb);
|
145
|
/*SortedSet<T> sortedSet = getSortedSetOfTerms();
|
146
|
|
147
|
result.addAll( sortedSet.headSet(otb));*/
|
148
|
//getLowerTerms Returns a view of the portion of this set whose elements are STRICTLY less than toElement
|
149
|
for (DefinedTermBase<?> setObjectUnproxied : terms){
|
150
|
@SuppressWarnings("unchecked")
|
151
|
T setObject = (T)CdmBase.deproxy(setObjectUnproxied, OrderedTermBase.class);
|
152
|
if (setObject.compareTo(otb) == 0){
|
153
|
result.add(setObject);
|
154
|
}
|
155
|
}
|
156
|
return result;
|
157
|
}
|
158
|
|
159
|
public SortedSet<T> getLowerTerms(T otb) {
|
160
|
/*SortedSet<T> result = getLowerAndEqualTerms(otb);
|
161
|
for (T setObject : terms){
|
162
|
if (setObject.compareTo(otb) == 0){
|
163
|
result.remove(setObject);
|
164
|
}
|
165
|
}*/
|
166
|
SortedSet<T> result = new TreeSet<>();
|
167
|
SortedSet<T> sortedSet = getSortedSetOfTerms();
|
168
|
//headSet Returns a view of the portion of this set whose elements are STRICTLY less than toElement
|
169
|
result.addAll( sortedSet.headSet(otb));
|
170
|
return result;
|
171
|
}
|
172
|
|
173
|
public SortedSet<T> getEqualTerms(T otb) {
|
174
|
SortedSet<T> result = new TreeSet<>();
|
175
|
for (DefinedTermBase<?> setObjectUnproxied : terms){ //use Unproxied to avoid ClassCastException in certain contexts
|
176
|
@SuppressWarnings("unchecked")
|
177
|
T setObject = (T)CdmBase.deproxy(setObjectUnproxied, OrderedTermBase.class);
|
178
|
if (setObject.compareTo(otb) == 0){
|
179
|
result.add(setObject);
|
180
|
}
|
181
|
}
|
182
|
return result;
|
183
|
}
|
184
|
|
185
|
public T getNextHigherTerm(T otb) {
|
186
|
try {
|
187
|
return getHigherTerms(otb).first();
|
188
|
} catch (NoSuchElementException e) {
|
189
|
return null;
|
190
|
}
|
191
|
}
|
192
|
|
193
|
public T getNextLowerTerm(T otb) {
|
194
|
try {
|
195
|
return getLowerTerms(otb).last();
|
196
|
} catch (NoSuchElementException e) {
|
197
|
return null;
|
198
|
}
|
199
|
}
|
200
|
|
201
|
@Transient
|
202
|
public T getLowestTerm() {
|
203
|
try {
|
204
|
SortedSet<T> sortedSet = getSortedSetOfTerms();
|
205
|
return sortedSet.first();
|
206
|
//return ((SortedSet<T>)terms).first();
|
207
|
} catch (NoSuchElementException e) {
|
208
|
return null;
|
209
|
}
|
210
|
}
|
211
|
|
212
|
@Transient
|
213
|
public T getHighestTerm() {
|
214
|
try {
|
215
|
SortedSet<T> sortedSet = getSortedSetOfTerms();
|
216
|
return sortedSet.last();
|
217
|
} catch (NoSuchElementException e) {
|
218
|
return null;
|
219
|
}
|
220
|
}
|
221
|
|
222
|
/**
|
223
|
* Adds a term to the the end / lowest
|
224
|
* @see eu.etaxonomy.cdm.model.term.TermVocabulary#addTerm(eu.etaxonomy.cdm.model.term.DefinedTermBase)
|
225
|
*/
|
226
|
@Override
|
227
|
public void addTerm(T term) {
|
228
|
SortedSet<T> sortedTerms = getSortedSetOfTerms();
|
229
|
int lowestOrderIndex;
|
230
|
if (sortedTerms.isEmpty()){
|
231
|
lowestOrderIndex = 0;
|
232
|
}else{
|
233
|
T first = sortedTerms.first();
|
234
|
lowestOrderIndex = first.orderIndex;
|
235
|
}
|
236
|
term.orderIndex = lowestOrderIndex + 1;
|
237
|
super.addTerm(term);
|
238
|
}
|
239
|
|
240
|
public void addTermAbove(T termToBeAdded, T lowerTerm) {
|
241
|
int orderInd = lowerTerm.orderIndex;
|
242
|
termToBeAdded.orderIndex = orderInd;
|
243
|
//increment all orderIndexes of terms below
|
244
|
Set<T> myTerms = getSortedSetOfTerms();
|
245
|
for(T term : myTerms){
|
246
|
if (term.orderIndex >= orderInd){ //should always be true
|
247
|
term.orderIndex++;
|
248
|
}
|
249
|
}
|
250
|
super.addTerm(termToBeAdded);
|
251
|
}
|
252
|
|
253
|
public void addTermBelow(T termToBeAdded, T higherTerm) {
|
254
|
int orderInd = higherTerm.orderIndex;
|
255
|
termToBeAdded.orderIndex = orderInd + 1;
|
256
|
//increment all orderIndexes of terms below
|
257
|
Iterator<T> iterator = getLowerTerms(higherTerm).iterator();
|
258
|
while(iterator.hasNext()){
|
259
|
T term = iterator.next();
|
260
|
if (term.orderIndex > orderInd){
|
261
|
term.orderIndex++;
|
262
|
}
|
263
|
}
|
264
|
super.addTerm(termToBeAdded);
|
265
|
}
|
266
|
|
267
|
public void addTermEqualLevel(T termToBeAdded, T equalLevelTerm) {
|
268
|
int orderInd = equalLevelTerm.orderIndex;
|
269
|
termToBeAdded.orderIndex = orderInd;
|
270
|
super.addTerm(termToBeAdded);
|
271
|
}
|
272
|
|
273
|
@Override
|
274
|
public void removeTerm(T term) {
|
275
|
if (term == null){
|
276
|
return;
|
277
|
}
|
278
|
if (this.getEqualTerms(term).size() == 0){
|
279
|
Iterator<T> iterator = getLowerTerms(term).iterator();
|
280
|
while (iterator.hasNext()){
|
281
|
T otb = iterator.next();
|
282
|
toBeChangedByObject = otb;
|
283
|
otb.decreaseIndex(this);
|
284
|
toBeChangedByObject = null;
|
285
|
}
|
286
|
}
|
287
|
super.removeTerm(term);
|
288
|
}
|
289
|
|
290
|
@Transient
|
291
|
private T toBeChangedByObject;
|
292
|
|
293
|
public boolean indexChangeAllowed(OrderedTermBase orderedTermBase){
|
294
|
return orderedTermBase == toBeChangedByObject ;
|
295
|
}
|
296
|
|
297
|
|
298
|
@Transient
|
299
|
private SortedSet<T> getSortedSetOfTerms(){
|
300
|
SortedSet<T> sortedSet = new TreeSet<>();
|
301
|
for (DefinedTermBase<?> termUnproxied : terms){
|
302
|
@SuppressWarnings("unchecked")
|
303
|
T term = (T)CdmBase.deproxy(termUnproxied, OrderedTermBase.class);
|
304
|
sortedSet.add(term);
|
305
|
}
|
306
|
return sortedSet;
|
307
|
}
|
308
|
|
309
|
@Override
|
310
|
public Set<TermNode> getTermRelations() {
|
311
|
return super.termRelations();
|
312
|
}
|
313
|
/**
|
314
|
* For now protected to avoid type checking etc. Might become
|
315
|
* public in future
|
316
|
* @param termRelations
|
317
|
*/
|
318
|
// @Override //not yet public
|
319
|
protected void setTermRelations(Set<TermNode> termRelations) {
|
320
|
super.termRelations(termRelations);
|
321
|
}
|
322
|
|
323
|
}
|