public class JOpenCageForwardRequest extends JOpenCageRequest
| Constructor and Description |
|---|
JOpenCageForwardRequest(java.lang.String... queryParts) |
JOpenCageForwardRequest(java.lang.String query) |
| Modifier and Type | Method and Description |
|---|---|
JOpenCageBounds |
getBounds() |
java.lang.String |
getLanguage() |
java.lang.Integer |
getLimit() |
java.lang.Integer |
getMinConfidence() |
java.util.Map<java.lang.String,java.lang.String> |
getParameter() |
java.lang.String |
getRestrictToCountryCode() |
boolean |
isNoAnnotations() |
boolean |
isNoDedupe() |
boolean |
isPretty() |
void |
setBounds(java.lang.Double northEastLat,
java.lang.Double northEastLng,
java.lang.Double southWestLat,
java.lang.Double southWestLng)
Provides the geocoder with a hint to the region that the query resides in.
|
void |
setBounds(JOpenCageBounds bounds) |
void |
setLanguage(java.lang.String language)
An IETF format language code (such as es for Spanish or pt-BR for Brazilian Portuguese); if this is omitted a code of en (English) will be assumed
|
void |
setLimit(java.lang.Integer limit)
How many results should be returned.
|
void |
setMinConfidence(java.lang.Integer minConfidence)
An integer from 1-10 only results with at least this confidence will be returned.
|
void |
setNoAnnotations(boolean noAnnotations)
If set to true the results will not contain annotations.
|
void |
setNoDedupe(boolean noDedupe)
If set to true the results will not be deduplicated.
|
void |
setPretty(boolean pretty)
If set to true pretty printing of the response payload is enabled.
|
void |
setQueryPartSeparator(java.lang.String queryPartSeparator)
If you use the query part constructor this String separates the query parts from each other.
|
void |
setRestrictToCountryCode(java.lang.String restrictToCountryCode)
Restricts the results to the given country.
|
getSubkey, setSubkeypublic JOpenCageForwardRequest(java.lang.String query)
public JOpenCageForwardRequest(java.lang.String... queryParts)
public java.util.Map<java.lang.String,java.lang.String> getParameter()
getParameter in class JOpenCageRequestpublic JOpenCageBounds getBounds()
public void setBounds(JOpenCageBounds bounds)
public java.lang.String getRestrictToCountryCode()
public void setRestrictToCountryCode(java.lang.String restrictToCountryCode)
restrictToCountryCode - 2 character code as defined by the ISO 3166-1 Alpha 2 standard. E.g. 'gb' for the United Kingdom, fr for Francepublic java.lang.String getLanguage()
public void setLanguage(java.lang.String language)
language - the language codepublic java.lang.Integer getLimit()
public void setLimit(java.lang.Integer limit)
limit - maximum number of results.public java.lang.Integer getMinConfidence()
public void setMinConfidence(java.lang.Integer minConfidence)
minConfidence - minimum confidence that the result matchespublic boolean isNoAnnotations()
public void setNoAnnotations(boolean noAnnotations)
noAnnotations - If true no annotations are included. Defaults to false.public boolean isNoDedupe()
public void setNoDedupe(boolean noDedupe)
noDedupe - If true the result will not be deduplicated. Defaults to false.public boolean isPretty()
public void setPretty(boolean pretty)
pretty - If true the response will be pretty formatted.public void setBounds(java.lang.Double northEastLat,
java.lang.Double northEastLng,
java.lang.Double southWestLat,
java.lang.Double southWestLng)
northEastLat - north east latitudenorthEastLng - north east longitudesouthWestLat - south west latitudesouthWestLng - south west longitudepublic void setQueryPartSeparator(java.lang.String queryPartSeparator)
queryPartSeparator - the query part separator. Defaults to a colon.