com.bericotech.clavin.gazetteer.query

Class QueryBuilder

java.lang.Object

com.bericotech.clavin.gazetteer.query.QueryBuilder

public class QueryBuilder
extends Object

A Builder class to assist in creating GazetteerQuery configurations. QueryBuilders can be re-used to create varied queries but are not thread-safe.

Constructor Summary

Constructors

Constructor and Description
QueryBuilder()

Method Summary

Methods

Modifier and Type	Method and Description
QueryBuilder	addAdminCodes() Convenience method to add the FeatureCodes representing administrative divisions to the restriction list.
QueryBuilder	addAncestryAdminCodes() Convenience method to add the FeatureCodes representing administrative divisions that can be part of the ancestry tree to the restriction list.
QueryBuilder	addCityCodes() Convenience method to add the FeatureCodes representing cities and other populated places to the restriction list.
QueryBuilder	addCountryCodes() Convenience method to add the FeatureCodes representing countries and similar top-level political entities to the restriction list.
QueryBuilder	addFeatureCodes(Collection<FeatureCode> codes) Add the provided FeatureCodes to the set of query constraints.
QueryBuilder	addFeatureCodes(FeatureCode code) Add the provided FeatureCode to the set of query constraints.
QueryBuilder	addFeatureCodes(FeatureCode code1, FeatureCode... codes) Add the provided FeatureCodes to the set of query constraints.
QueryBuilder	addParentIds(Collection<Integer> ids) Add the provided parent IDs to the set of query constraints.
QueryBuilder	addParentIds(Integer id) Add the provided parent ID to the set of query constraints.
QueryBuilder	addParentIds(Integer id1, Integer... ids) Add the provided parent IDs to the set of query constraints.
GazetteerQuery	build() Constructs a query from the current configuration of this Builder.
QueryBuilder	clearFeatureCodes() Convenience method to clear any existing FeatureCode restrictions.
QueryBuilder	clearParentIds() Convenience method to remove all current parent ID restrictions.
Set<FeatureCode>	featureCodes() Get the set of FeatureCodes that will be used to constrain the query results.
QueryBuilder	featureCodes(Set<FeatureCode> codes) Set the FeatureCodes that will be used to constraint the query results; replacing any previously configured IDs.
boolean	filterDupes() Does this builder filter duplicate results?
QueryBuilder	filterDupes(boolean filter) Indicate whether or not this builder should filter duplicate results.
FuzzyMode	fuzzyMode() Get the current fuzzy matching mode.
QueryBuilder	fuzzyMode(FuzzyMode mode) Configure the fuzzy matching mode.
boolean	includeHistorical() Does this builder include historical locations?
QueryBuilder	includeHistorical(boolean incHist) Indicate whether or not this builder includes historical locations in the search results.
LocationOccurrence	location() Get the currently configured location to query for.
QueryBuilder	location(LocationOccurrence loc) Set the location to query for.
QueryBuilder	location(String locName) Convenience method to create a LocationOccurrence at position 0 for the given location name.
int	maxResults() Get the current maximum number of results.
QueryBuilder	maxResults(int max) Set the maximum number of search results.
Set<Integer>	parentIds() Get the set of parent IDs that will be used to constrain the query results.
QueryBuilder	parentIds(Set<Integer> ids) Set the parent IDs that will be used to constraint the query results; replacing any previously configured IDs.
QueryBuilder	removeAdminCodes() Convenience method to remove the FeatureCodes representing administrative divisions from the restriction list.
QueryBuilder	removeAncestryAdminCodes() Convenience method to remove the FeatureCodes representing administrative divisions that can be part of the ancestry tree from the restriction list.
QueryBuilder	removeCityCodes() Convenience method to remove the FeatureCodes representing cities and other populated places from the restriction list.
QueryBuilder	removeCountryCodes() Convenience method to remove the FeatureCodes representing countries and similar top-level political entities from the restriction list.
QueryBuilder	removeFeatureCodes(Collection<FeatureCode> codes) Remove the provided FeatureCodes from the set of query constraints.
QueryBuilder	removeFeatureCodes(FeatureCode code) Remove the provided FeatureCode from the set of query constraints.
QueryBuilder	removeFeatureCodes(FeatureCode code1, FeatureCode... codes) Remove the provided FeatureCode from the set of query constraints.
QueryBuilder	removeParentIds(Collection<Integer> ids) Remove the provided parent IDs from the set of query constraints.
QueryBuilder	removeParentIds(Integer id) Remove the provided parent ID from the set of query constraints.
QueryBuilder	removeParentIds(Integer id1, Integer... ids) Remove the provided parent IDs from the set of query constraints.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

QueryBuilder

public QueryBuilder()

Method Detail

build

public GazetteerQuery build()

Constructs a query from the current configuration of this Builder.

Returns:

a GazetteerQuery configuration object

location

public LocationOccurrence location()

Get the currently configured location to query for.

Returns:

the location to query for

location

public QueryBuilder location(LocationOccurrence loc)

Set the location to query for.

Parameters:

loc - the location to query for.

Returns:

this

location

public QueryBuilder location(String locName)

Convenience method to create a LocationOccurrence at position 0 for the given location name.

Parameters:

locName - the name of the location to query for

Returns:

this

maxResults

public int maxResults()

Get the current maximum number of results.

Returns:

the maximum number of results

maxResults

public QueryBuilder maxResults(int max)

Set the maximum number of search results.

Parameters:

max - the maximum number of results

Returns:

this

fuzzyMode

public FuzzyMode fuzzyMode()

Get the current fuzzy matching mode.

Returns:

the fuzzy matching mode

fuzzyMode

public QueryBuilder fuzzyMode(FuzzyMode mode)

Configure the fuzzy matching mode.

Parameters:

mode - the fuzzy matching mode

Returns:

this

includeHistorical

public boolean includeHistorical()

Does this builder include historical locations?

Returns:

true if this builder is configured to return historical locations

includeHistorical

public QueryBuilder includeHistorical(boolean incHist)

Indicate whether or not this builder includes historical locations in the search results.

Parameters:

incHist - true to include historical locations in the results

Returns:

this

filterDupes

public boolean filterDupes()

Does this builder filter duplicate results?

Returns:

true if this builder is configured to filter duplicates

filterDupes

public QueryBuilder filterDupes(boolean filter)

Indicate whether or not this builder should filter duplicate results.

Parameters:

filter - true to filter duplicate results

Returns:

this

parentIds

public Set<Integer> parentIds()

Get the set of parent IDs that will be used to constrain the query results. This set may not be modifiable and modifications, if allowed, will not affect the generated queries.

Returns:

the current set of parent IDs used to constrain the query results

parentIds

public QueryBuilder parentIds(Set<Integer> ids)

Set the parent IDs that will be used to constraint the query results; replacing any previously configured IDs. Use the addParentIds() and removeParentIds() methods to modify the existing configuration.

Parameters:

ids - the new set of parent IDs used to constrain the query results

Returns:

this

addParentIds

public QueryBuilder addParentIds(Integer id)

Add the provided parent ID to the set of query constraints.

Parameters:

id - the parent ID to add

Returns:

this

addParentIds

public QueryBuilder addParentIds(Integer id1,
                        Integer... ids)

Add the provided parent IDs to the set of query constraints.

Parameters:

id1 - the first parent ID to add

ids - the subsequent parent IDs to add

Returns:

this

addParentIds

public QueryBuilder addParentIds(Collection<Integer> ids)

Add the provided parent IDs to the set of query constraints.

Parameters:

ids - the parent IDs to add

Returns:

this

removeParentIds

public QueryBuilder removeParentIds(Integer id)

Remove the provided parent ID from the set of query constraints.

Parameters:

id - the parent ID to remove

Returns:

this

removeParentIds

public QueryBuilder removeParentIds(Integer id1,
                           Integer... ids)

Remove the provided parent IDs from the set of query constraints.

Parameters:

id1 - the first parent ID to remove

ids - the subsequent parent IDs to remove

Returns:

this

removeParentIds

public QueryBuilder removeParentIds(Collection<Integer> ids)

Remove the provided parent IDs from the set of query constraints.

Parameters:

ids - the parent IDs to remove

Returns:

this

clearParentIds

public QueryBuilder clearParentIds()

Convenience method to remove all current parent ID restrictions.

Returns:

this

featureCodes

public Set<FeatureCode> featureCodes()

Get the set of FeatureCodes that will be used to constrain the query results. This set may not be modifiable and modifications, if allowed, will not affect the generated queries.

Returns:

the current set of FeatureCodes used to constrain the query results

featureCodes

public QueryBuilder featureCodes(Set<FeatureCode> codes)

Set the FeatureCodes that will be used to constraint the query results; replacing any previously configured IDs. Use the addFeatureCodes() and removeFeatureCodes() methods to modify the existing configuration.

Parameters:

codes - the new set of FeatureCodes used to constrain the query results

Returns:

this

addFeatureCodes

public QueryBuilder addFeatureCodes(FeatureCode code)

Add the provided FeatureCode to the set of query constraints.

Parameters:

code - the FeatureCode to add

Returns:

this

addFeatureCodes

public QueryBuilder addFeatureCodes(FeatureCode code1,
                           FeatureCode... codes)

Add the provided FeatureCodes to the set of query constraints.

Parameters:

code1 - the first FeatureCode to add

codes - the subsequent FeatureCodes to add

Returns:

this

addFeatureCodes

public QueryBuilder addFeatureCodes(Collection<FeatureCode> codes)

Add the provided FeatureCodes to the set of query constraints.

Parameters:

codes - the FeatureCodes to add

Returns:

this

removeFeatureCodes

public QueryBuilder removeFeatureCodes(FeatureCode code)

Remove the provided FeatureCode from the set of query constraints.

Parameters:

code - the FeatureCode to remove

Returns:

this

removeFeatureCodes

public QueryBuilder removeFeatureCodes(FeatureCode code1,
                              FeatureCode... codes)

Remove the provided FeatureCode from the set of query constraints.

Parameters:

code1 - the first FeatureCode to remove

codes - the subsequent FeatureCodes to remove

Returns:

this

removeFeatureCodes

public QueryBuilder removeFeatureCodes(Collection<FeatureCode> codes)

Remove the provided FeatureCodes from the set of query constraints.

Parameters:

codes - the FeatureCodes to remove

Returns:

this

clearFeatureCodes

public QueryBuilder clearFeatureCodes()

Convenience method to clear any existing FeatureCode restrictions.

Returns:

this

addCountryCodes

public QueryBuilder addCountryCodes()

Convenience method to add the FeatureCodes representing countries and similar top-level political entities to the restriction list. This method modifies the existing set of codes.

Returns:

this

removeCountryCodes

public QueryBuilder removeCountryCodes()

Convenience method to remove the FeatureCodes representing countries and similar top-level political entities from the restriction list. This method modifies the existing set of codes.

Returns:

this

addAdminCodes

public QueryBuilder addAdminCodes()

Convenience method to add the FeatureCodes representing administrative divisions to the restriction list. This includes all ADM* codes, territories (TERR) and parishes (PRSH). This method modifies the existing set of codes.

Returns:

this

removeAdminCodes

public QueryBuilder removeAdminCodes()

Convenience method to remove the FeatureCodes representing administrative divisions from the restriction list. This includes all ADM* codes, territories (TERR) and parishes (PRSH). This method modifies the existing set of codes.

Returns:

this

addAncestryAdminCodes

public QueryBuilder addAncestryAdminCodes()

Convenience method to add the FeatureCodes representing administrative divisions that can be part of the ancestry tree to the restriction list. This only includes administrative divisions 1-4 (ADM[1-4]). This method modifies the existing set of codes.

Returns:

this

removeAncestryAdminCodes

public QueryBuilder removeAncestryAdminCodes()

Convenience method to remove the FeatureCodes representing administrative divisions that can be part of the ancestry tree from the restriction list. This only includes administrative divisions 1-4 (ADM[1-4]). This method modifies the existing set of codes.

Returns:

this

addCityCodes

public QueryBuilder addCityCodes()

Convenience method to add the FeatureCodes representing cities and other populated places to the restriction list. This method modifies the existing set of codes.

Returns:

this

removeCityCodes

public QueryBuilder removeCityCodes()

Convenience method to remove the FeatureCodes representing cities and other populated places from the restriction list. This method modifies the existing set of codes.

Returns:

this

toString

public String toString()

Overrides:

toString in class Object