com.bericotech.clavin.gazetteer.query

Class GazetteerQuery

java.lang.Object

com.bericotech.clavin.gazetteer.query.GazetteerQuery

public class GazetteerQuery
extends Object

Configuration parameters for querying a Gazetteer. The QueryBuilder contains convenience methods to make query construction more readable.

Constructor Summary

Constructors

Constructor and Description
GazetteerQuery(LocationOccurrence occurrence, int maxResults, FuzzyMode fuzzyMode, AncestryMode ancestryMode, boolean includeHistorical, boolean filterDupes, Set<Integer> parentIds, Set<FeatureCode> featureCodes) Create a new GazetteerQuery.

Method Summary

Modifier and Type	Method and Description
AncestryMode	getAncestryMode() Indicates how the ancestry, the hierarchy of political divisions, for matching locations should be loaded.
Set<FeatureCode>	getFeatureCodes() Get the set of FeatureCodes that should be used to restrict the search.
FuzzyMode	getFuzzyMode() Indicates how fuzzy matching should be used.
int	getMaxResults() Get the maximum number of results that should be returned by this query.
LocationOccurrence	getOccurrence() Get the LocationOccurrence to search on.
Set<Integer>	getParentIds() Get the set of parents that should be used to restrict the search.
boolean	isFilterDupes() Should duplicate results be filtered so only the best match for each location is returned?
boolean	isIncludeHistorical() Should historical locations be included in the search results?

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GazetteerQuery

public GazetteerQuery(LocationOccurrence occurrence,
                      int maxResults,
                      FuzzyMode fuzzyMode,
                      AncestryMode ancestryMode,
                      boolean includeHistorical,
                      boolean filterDupes,
                      Set<Integer> parentIds,
                      Set<FeatureCode> featureCodes)

Create a new GazetteerQuery.

Parameters:

occurrence - the location occurrence

maxResults - the maximum number of results

fuzzyMode - the fuzzy mode for this query

ancestryMode - the ancestry loading mode for this query

includeHistorical - true to include historical locations

filterDupes - true to return only the highest scoring match for each individual location

parentIds - the set of parent IDs to restrict the search to; these will be OR'ed

featureCodes - the set of feature codes to restrict the search to; these will be OR'ed

Method Detail

getOccurrence

public LocationOccurrence getOccurrence()

Get the LocationOccurrence to search on.

Returns:

the LocationOccurrence to search for

getMaxResults

public int getMaxResults()

Get the maximum number of results that should be returned by this query.

Returns:

the maximum number of search results

getFuzzyMode

public FuzzyMode getFuzzyMode()

Indicates how fuzzy matching should be used.

Returns:

the fuzzy matching mode

getAncestryMode

public AncestryMode getAncestryMode()

Indicates how the ancestry, the hierarchy of political divisions, for matching locations should be loaded.

Returns:

the ancestry mode

isIncludeHistorical

public boolean isIncludeHistorical()

Should historical locations be included in the search results?

Returns:

true if historical locations should be included

isFilterDupes

public boolean isFilterDupes()

Should duplicate results be filtered so only the best match for each location is returned?

Returns:

true if duplicates should be filtered

getParentIds

public Set<Integer> getParentIds()

Get the set of parents that should be used to restrict the search.

Returns:

the IDs of the parents that should be used to restrict the search

getFeatureCodes

public Set<FeatureCode> getFeatureCodes()

Get the set of FeatureCodes that should be used to restrict the search.

Returns:

the set of FeatureCodes that should be used to restrict the search