blob: 2dee713559cbba2cd59b8f67058c16e5f0283f9f (
plain)
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
|
package cgeo.geocaching.sorting;
import cgeo.geocaching.Geocache;
import cgeo.geocaching.utils.Log;
/**
* abstract super implementation for all cache comparators
*
*/
public abstract class AbstractCacheComparator implements CacheComparator {
@Override
public final int compare(final Geocache cache1, final Geocache cache2) {
try {
// first check that we have all necessary data for the comparison
if (!canCompare(cache1, cache2)) {
return 0;
}
return compareCaches(cache1, cache2);
} catch (Exception e) {
Log.e("AbstractCacheComparator.compare", e);
}
return 0;
}
/**
* Check necessary preconditions (like missing fields) before running the comparison itself
*
* @param cache1
* @param cache2
* @return
*/
protected abstract boolean canCompare(final Geocache cache1, final Geocache cache2);
/**
* Compares two caches. Logging and exception handling is implemented outside this method already.
* <p/>
* A cache is smaller than another cache if it is desirable to show it first when presented to the user.
* For example, a highly rated cache must be considered smaller than a poorly rated one.
*
* @param cache1
* @param cache2
* @return an integer < 0 if cache1 is less than cache2, 0 if they are equal, and > 0 if cache1 is greater than
* cache2.
*/
protected abstract int compareCaches(final Geocache cache1, final Geocache cache2);
}
|