org.geonames

Class ToponymSearchCriteria

java.lang.Object

org.geonames.ToponymSearchCriteria

public class ToponymSearchCriteria
extends java.lang.Object

search criteria for web services returning toponyms. The string parameters do not have to be utf8 encoded. The encoding is done transparently in the call to the web service. The main parameter for the search over all fields is the 'q' parameter.

Author:

marc@geonames

See Also:

WebService.search(java.lang.String, java.lang.String, java.lang.String, java.lang.String[], int), search webservice documentation< /a>

Constructor Summary

Constructors

Constructor and Description
ToponymSearchCriteria()

Method Summary

Modifier and Type	Method and Description
void	addCountryCode(java.lang.String countryCode)
java.lang.String	getAdminCode1()
java.lang.String	getAdminCode2()
java.lang.String	getAdminCode3()
java.lang.String	getAdminCode4()
BoundingBox	getBoundingBox()
java.lang.String	getContinentCode()
java.lang.String	getCountryBias()
java.lang.String	getCountryCode()
java.util.Set<java.lang.String>	getCountryCodes()
FeatureClass	getFeatureClass()
java.lang.String[]	getFeatureCodes()
double	getFuzzy()
java.lang.String	getLanguage()
int	getMaxRows()
java.lang.String	getName()
java.lang.String	getNameEquals()
java.lang.String	getNameStartsWith()
java.lang.String	getQ()
int	getStartRow()
Style	getStyle()
java.lang.String	getTag()
void	setAdminCode1(java.lang.String adminCode1)
void	setAdminCode2(java.lang.String adminCode2)
void	setAdminCode3(java.lang.String adminCode3)
void	setAdminCode4(java.lang.String adminCode4)
void	setBoundingBox(BoundingBox boundingBox)
void	setContinentCode(java.lang.String continentCode)
void	setCountryBias(java.lang.String countryBias)
void	setCountryCode(java.lang.String countryCode)
void	setCountryCodes(java.util.Set<java.lang.String> countryCodes)
void	setFeatureClass(FeatureClass featureClass)
void	setFeatureCode(java.lang.String featureCode)
void	setFeatureCodes(java.lang.String[] featureCodes)
void	setFuzzy(double fuzzy)
void	setLanguage(java.lang.String language)
void	setMaxRows(int maxRows)
void	setName(java.lang.String name) search over the name field only.
void	setNameEquals(java.lang.String exactName)
void	setNameStartsWith(java.lang.String nameStartsWith)
void	setQ(java.lang.String q) The main search term.
void	setStartRow(int startRow)
void	setStyle(Style style)
void	setTag(java.lang.String tag)

Methods inherited from class java.lang.Object

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

Constructor Detail

ToponymSearchCriteria

public ToponymSearchCriteria()

Method Detail

getCountryCode

public java.lang.String getCountryCode()

Returns:

Returns the ISO 3166-1-alpha-2 countryCode.

setCountryCode

public void setCountryCode(java.lang.String countryCode)
                    throws InvalidParameterException

Parameters:

countryCode - The ISO 3166-1-alpha-2 countryCode to set.

Throws:

InvalidParameterException

addCountryCode

public void addCountryCode(java.lang.String countryCode)
                    throws InvalidParameterException

Parameters:

countryCode - The ISO 3166-1-alpha-2 countryCode to set.

Throws:

InvalidParameterException

getCountryCodes

public java.util.Set<java.lang.String> getCountryCodes()

Returns:

the countryCodes

setCountryCodes

public void setCountryCodes(java.util.Set<java.lang.String> countryCodes)

Parameters:

countryCodes - the countryCodes to set

getCountryBias

public java.lang.String getCountryBias()

Returns:

the countryBias

setCountryBias

public void setCountryBias(java.lang.String countryBias)

Parameters:

countryBias - the countryBias to set

getContinentCode

public java.lang.String getContinentCode()

Returns:

the continentCode

setContinentCode

public void setContinentCode(java.lang.String continentCode)

Parameters:

continentCode - the continentCode to set

getNameEquals

public java.lang.String getNameEquals()

Returns:

Returns the nameEquals.

setNameEquals

public void setNameEquals(java.lang.String exactName)

Parameters:

nameEquals - The nameEquals to set.

getFeatureCodes

public java.lang.String[] getFeatureCodes()

Returns:

Returns the featureCodes.

setFeatureCodes

public void setFeatureCodes(java.lang.String[] featureCodes)

Parameters:

featureCodes - The featureCodes to set.

setFeatureCode

public void setFeatureCode(java.lang.String featureCode)

getLanguage

public java.lang.String getLanguage()

Returns:

Returns the language.

setLanguage

public void setLanguage(java.lang.String language)

Parameters:

language - The language to set.

getMaxRows

public int getMaxRows()

Returns:

Returns the maxRows.

setMaxRows

public void setMaxRows(int maxRows)

Parameters:

maxRows - The maxRows to set.

getName

public java.lang.String getName()

Returns:

Returns the name.

setName

public void setName(java.lang.String name)

search over the name field only.

Parameters:

name - The name to set.

getQ

public java.lang.String getQ()

Returns:

Returns the q.

setQ

public void setQ(java.lang.String q)

The main search term. The search is executed over all fields (place name, country name, admin names, etc)

Parameters:

q - The q to set.

getStartRow

public int getStartRow()

Returns:

Returns the startRow.

setStartRow

public void setStartRow(int startRow)

Parameters:

startRow - The startRow to set.

getStyle

public Style getStyle()

Returns:

Returns the style.

setStyle

public void setStyle(Style style)

Parameters:

style - The style to set.

getTag

public java.lang.String getTag()

Returns:

Returns the tag.

setTag

public void setTag(java.lang.String tag)

Parameters:

tag - The tag to set.

getNameStartsWith

public java.lang.String getNameStartsWith()

Returns:

Returns the nameStartsWith.

setNameStartsWith

public void setNameStartsWith(java.lang.String nameStartsWith)

Parameters:

nameStartsWith - The nameStartsWith to set.

getFeatureClass

public FeatureClass getFeatureClass()

Returns:

the featureClass

setFeatureClass

public void setFeatureClass(FeatureClass featureClass)

Parameters:

featureClass - the featureClass to set

getAdminCode1

public java.lang.String getAdminCode1()

Returns:

the adminCode1

setAdminCode1

public void setAdminCode1(java.lang.String adminCode1)

Parameters:

adminCode1 - the adminCode1 to set

getAdminCode2

public java.lang.String getAdminCode2()

Returns:

the adminCode2

setAdminCode2

public void setAdminCode2(java.lang.String adminCode2)

Parameters:

adminCode2 - the adminCode2 to set

getAdminCode3

public java.lang.String getAdminCode3()

Returns:

the adminCode3

setAdminCode3

public void setAdminCode3(java.lang.String adminCode3)

Parameters:

adminCode3 - the adminCode3 to set

getAdminCode4

public java.lang.String getAdminCode4()

setAdminCode4

public void setAdminCode4(java.lang.String adminCode4)

getFuzzy

public double getFuzzy()

Returns:

the fuzzy

setFuzzy

public void setFuzzy(double fuzzy)

Parameters:

fuzzy - the fuzzy to set

getBoundingBox

public BoundingBox getBoundingBox()

Returns:

the boundingBox

setBoundingBox

public void setBoundingBox(BoundingBox boundingBox)

Parameters:

boundingBox - the boundingBox to set