package cgeo.geocaching; import cgeo.geocaching.connector.gc.GCLogin; import cgeo.geocaching.enumerations.CacheType; import cgeo.geocaching.enumerations.LoadFlags; import cgeo.geocaching.enumerations.LoadFlags.LoadFlag; import cgeo.geocaching.enumerations.LoadFlags.SaveFlag; import cgeo.geocaching.enumerations.StatusCode; import cgeo.geocaching.gcvote.GCVote; import org.apache.commons.collections4.CollectionUtils; import org.apache.commons.lang3.StringUtils; import android.os.Parcel; import android.os.Parcelable; import java.util.ArrayList; import java.util.Collection; import java.util.Collections; import java.util.EnumSet; import java.util.HashSet; import java.util.Set; public class SearchResult implements Parcelable { final private Set geocodes; final private Set filteredGeocodes; private StatusCode error = null; private String url = ""; public String[] viewstates = null; private int totalCnt = 0; final public static Parcelable.Creator CREATOR = new Parcelable.Creator() { @Override public SearchResult createFromParcel(Parcel in) { return new SearchResult(in); } @Override public SearchResult[] newArray(int size) { return new SearchResult[size]; } }; /** * Build a new empty search result. */ public SearchResult() { this(new HashSet()); } /** * Copy a search result, for example to apply different filters on it. * * @param searchResult the original search result, which cannot be null */ public SearchResult(final SearchResult searchResult) { geocodes = new HashSet(searchResult.geocodes); filteredGeocodes = new HashSet(searchResult.filteredGeocodes); error = searchResult.error; url = searchResult.url; viewstates = searchResult.viewstates; setTotal(searchResult.getTotal()); } /** * Build a search result from an existing collection of geocodes. * * @param geocodes a non-null collection of geocodes * @param total the total number of geocodes (FIXME: what is the meaning of this number wrt to geocodes.size()?) */ public SearchResult(final Collection geocodes, final int total) { this.geocodes = new HashSet(geocodes.size()); this.geocodes.addAll(geocodes); this.filteredGeocodes = new HashSet(); this.setTotal(total); } /** * Build a search result from an existing collection of geocodes. * * @param geocodes a non-null set of geocodes */ public SearchResult(final Set geocodes) { this(geocodes, geocodes.size()); } public SearchResult(final Parcel in) { final ArrayList list = new ArrayList(); in.readStringList(list); geocodes = new HashSet(list); final ArrayList filteredList = new ArrayList(); in.readStringList(filteredList); filteredGeocodes = new HashSet(filteredList); error = (StatusCode) in.readSerializable(); url = in.readString(); final int length = in.readInt(); if (length >= 0) { viewstates = new String[length]; in.readStringArray(viewstates); } setTotal(in.readInt()); } /** * Build a search result designating a single cache. * * @param cache the cache to include */ public SearchResult(final Geocache cache) { this(Collections.singletonList(cache)); } /** * Build a search result from a collection of caches. * * @param caches the non-null collection of caches to include */ public SearchResult(final Collection caches) { this(); for (final Geocache cache : caches) { addAndPutInCache(cache); } } @Override public void writeToParcel(final Parcel out, final int flags) { out.writeStringArray(geocodes.toArray(new String[geocodes.size()])); out.writeStringArray(filteredGeocodes.toArray(new String[filteredGeocodes.size()])); out.writeSerializable(error); out.writeString(url); if (viewstates == null) { out.writeInt(-1); } else { out.writeInt(viewstates.length); out.writeStringArray(viewstates); } out.writeInt(getTotal()); } @Override public int describeContents() { return 0; } public Set getGeocodes() { return Collections.unmodifiableSet(geocodes); } public int getCount() { return geocodes.size(); } public StatusCode getError() { return error; } public void setError(final StatusCode error) { this.error = error; } public String getUrl() { return url; } public void setUrl(String url) { this.url = url; } public String[] getViewstates() { return viewstates; } public void setViewstates(String[] viewstates) { if (GCLogin.isEmpty(viewstates)) { return; } System.arraycopy(viewstates, 0, this.viewstates, 0, viewstates.length); } public int getTotal() { return totalCnt; } public void setTotal(int totalCnt) { this.totalCnt = totalCnt; } /** * @param excludeDisabled * @param excludeMine * @param cacheType * @return */ public SearchResult filterSearchResults(final boolean excludeDisabled, final boolean excludeMine, final CacheType cacheType) { SearchResult result = new SearchResult(this); result.geocodes.clear(); final ArrayList cachesForVote = new ArrayList(); final Set caches = DataStore.loadCaches(geocodes, LoadFlags.LOAD_CACHE_OR_DB); int excluded = 0; for (Geocache cache : caches) { // Is there any reason to exclude the cache from the list? final boolean excludeCache = (excludeDisabled && cache.isDisabled()) || (excludeMine && (cache.isOwner() || cache.isFound())) || (!cacheType.contains(cache)); if (excludeCache) { excluded++; } else { result.addAndPutInCache(cache); cachesForVote.add(cache); } } // decrease maximum number of caches by filtered ones result.setTotal(result.getTotal() - excluded); GCVote.loadRatings(cachesForVote); return result; } public Geocache getFirstCacheFromResult(final EnumSet loadFlags) { return CollectionUtils.isNotEmpty(geocodes) ? DataStore.loadCache(geocodes.iterator().next(), loadFlags) : null; } public Set getCachesFromSearchResult(final EnumSet loadFlags) { return DataStore.loadCaches(geocodes, loadFlags); } /** Add the geocode to the search. No cache is loaded into the CacheCache */ public boolean addGeocode(final String geocode) { if (StringUtils.isBlank(geocode)) { throw new IllegalArgumentException("geocode must not be blank"); } return geocodes.add(geocode); } /** Add the geocodes to the search. No caches are loaded into the CacheCache */ public boolean addGeocodes(Set geocodes) { return this.geocodes.addAll(geocodes); } /** Add the cache geocode to the search and store the cache in the CacheCache */ public boolean addAndPutInCache(final Geocache cache) { addGeocode(cache.getGeocode()); return DataStore.saveCache(cache, EnumSet.of(SaveFlag.SAVE_CACHE)); } public boolean isEmpty() { return geocodes.isEmpty(); } public boolean hasUnsavedCaches() { for (final String geocode : getGeocodes()) { if (!DataStore.isOffline(geocode, null)) { return true; } } return false; } public void addFilteredGeocodes(Set cachedMissingFromSearch) { filteredGeocodes.addAll(cachedMissingFromSearch); } public Set getFilteredGeocodes() { return Collections.unmodifiableSet(filteredGeocodes); } public void addSearchResult(SearchResult other) { if (other != null) { addGeocodes(other.geocodes); addFilteredGeocodes(other.filteredGeocodes); if (StringUtils.isBlank(url)) { url = other.url; } } } }