ToponymSearchCriteria (OpenEstate-Tool 1.0-beta43b API)

java.lang.Object
- org.geonames.ToponymSearchCriteria

```
public class ToponymSearchCriteria
extends 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()

Constructors
Constructor and Description
`ToponymSearchCriteria()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addCountryCode(String countryCode)`
`String`	`getAdminCode1()`
`String`	`getAdminCode2()`
`String`	`getAdminCode3()`
`String`	`getAdminCode4()`
`BoundingBox`	`getBoundingBox()`
`String`	`getContinentCode()`
`String`	`getCountryBias()`
`String`	`getCountryCode()`
`Set<String>`	`getCountryCodes()`
`FeatureClass`	`getFeatureClass()`
`String[]`	`getFeatureCodes()`
`double`	`getFuzzy()`
`String`	`getLanguage()`
`int`	`getMaxRows()`
`String`	`getName()`
`String`	`getNameEquals()`
`String`	`getNameStartsWith()`
`String`	`getQ()`
`int`	`getStartRow()`
`Style`	`getStyle()`
`String`	`getTag()`
`void`	`setAdminCode1(String adminCode1)`
`void`	`setAdminCode2(String adminCode2)`
`void`	`setAdminCode3(String adminCode3)`
`void`	`setAdminCode4(String adminCode4)`
`void`	`setBoundingBox(BoundingBox boundingBox)`
`void`	`setContinentCode(String continentCode)`
`void`	`setCountryBias(String countryBias)`
`void`	`setCountryCode(String countryCode)`
`void`	`setCountryCodes(Set<String> countryCodes)`
`void`	`setFeatureClass(FeatureClass featureClass)`
`void`	`setFeatureCode(String featureCode)`
`void`	`setFeatureCodes(String[] featureCodes)`
`void`	`setFuzzy(double fuzzy)`
`void`	`setLanguage(String language)`
`void`	`setMaxRows(int maxRows)`
`void`	`setName(String name)` search over the name field only.
`void`	`setNameEquals(String exactName)`
`void`	`setNameStartsWith(String nameStartsWith)`
`void`	`setQ(String q)` The main search term.
`void`	`setStartRow(int startRow)`
`void`	`setStyle(Style style)`
`void`	`setTag(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 String getCountryCode()
```
    Returns:
    
    Returns the ISO 3166-1-alpha-2 countryCode.
  - setCountryCode
```
public void setCountryCode(String countryCode)
                    throws InvalidParameterException
```
    Parameters:
    
    countryCode - The ISO 3166-1-alpha-2 countryCode to set.
    
    Throws:
    
    InvalidParameterException
  - addCountryCode
```
public void addCountryCode(String countryCode)
                    throws InvalidParameterException
```
    Parameters:
    
    countryCode - The ISO 3166-1-alpha-2 countryCode to set.
    
    Throws:
    
    InvalidParameterException
  - getCountryCodes
```
public Set<String> getCountryCodes()
```
    Returns:
    
    the countryCodes
  - setCountryCodes
```
public void setCountryCodes(Set<String> countryCodes)
```
    Parameters:
    
    countryCodes - the countryCodes to set
  - getCountryBias
```
public String getCountryBias()
```
    Returns:
    
    the countryBias
  - setCountryBias
```
public void setCountryBias(String countryBias)
```
    Parameters:
    
    countryBias - the countryBias to set
  - getContinentCode
```
public String getContinentCode()
```
    Returns:
    
    the continentCode
  - setContinentCode
```
public void setContinentCode(String continentCode)
```
    Parameters:
    
    continentCode - the continentCode to set
  - getNameEquals
```
public String getNameEquals()
```
    Returns:
    
    Returns the nameEquals.
  - setNameEquals
```
public void setNameEquals(String exactName)
```
    Parameters:
    
    nameEquals - The nameEquals to set.
  - getFeatureCodes
```
public String[] getFeatureCodes()
```
    Returns:
    
    Returns the featureCodes.
  - setFeatureCodes
```
public void setFeatureCodes(String[] featureCodes)
```
    Parameters:
    
    featureCodes - The featureCodes to set.
  - setFeatureCode
```
public void setFeatureCode(String featureCode)
```
  - getLanguage
```
public String getLanguage()
```
    Returns:
    
    Returns the language.
  - setLanguage
```
public void setLanguage(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 String getName()
```
    Returns:
    
    Returns the name.
  - setName
```
public void setName(String name)
```
    search over the name field only.
    
    Parameters:
    
    name - The name to set.
  - getQ
```
public String getQ()
```
    Returns:
    
    Returns the q.
  - setQ
```
public void setQ(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 String getTag()
```
    Returns:
    
    Returns the tag.
  - setTag
```
public void setTag(String tag)
```
    Parameters:
    
    tag - The tag to set.
  - getNameStartsWith
```
public String getNameStartsWith()
```
    Returns:
    
    Returns the nameStartsWith.
  - setNameStartsWith
```
public void setNameStartsWith(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 String getAdminCode1()
```
    Returns:
    
    the adminCode1
  - setAdminCode1
```
public void setAdminCode1(String adminCode1)
```
    Parameters:
    
    adminCode1 - the adminCode1 to set
  - getAdminCode2
```
public String getAdminCode2()
```
    Returns:
    
    the adminCode2
  - setAdminCode2
```
public void setAdminCode2(String adminCode2)
```
    Parameters:
    
    adminCode2 - the adminCode2 to set
  - getAdminCode3
```
public String getAdminCode3()
```
    Returns:
    
    the adminCode3
  - setAdminCode3
```
public void setAdminCode3(String adminCode3)
```
    Parameters:
    
    adminCode3 - the adminCode3 to set
  - getAdminCode4
```
public String getAdminCode4()
```
  - setAdminCode4
```
public void setAdminCode4(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

Class ToponymSearchCriteria

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ToponymSearchCriteria

Method Detail

getCountryCode

setCountryCode

addCountryCode

getCountryCodes

setCountryCodes

getCountryBias

setCountryBias

getContinentCode

setContinentCode

getNameEquals

setNameEquals

getFeatureCodes

setFeatureCodes

setFeatureCode

getLanguage

setLanguage

getMaxRows

setMaxRows

getName

setName

getQ

setQ

getStartRow

setStartRow

getStyle

setStyle

getTag

setTag

getNameStartsWith

setNameStartsWith

getFeatureClass

setFeatureClass

getAdminCode1

setAdminCode1

getAdminCode2

setAdminCode2

getAdminCode3

setAdminCode3

getAdminCode4

setAdminCode4

getFuzzy

setFuzzy

getBoundingBox

setBoundingBox