com.byteowls.jopencage.model

Class JOpenCageForwardRequest

java.lang.Object

com.byteowls.jopencage.model.JOpenCageRequest

com.byteowls.jopencage.model.JOpenCageForwardRequest

public class JOpenCageForwardRequest
extends JOpenCageRequest

Constructor Summary

Constructors

Constructor and Description
JOpenCageForwardRequest(java.lang.String... queryParts)
JOpenCageForwardRequest(java.lang.String query)

Method Summary

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.

Methods inherited from class com.byteowls.jopencage.model.JOpenCageRequest

getSubkey, setSubkey

Methods inherited from class java.lang.Object

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

Constructor Detail

JOpenCageForwardRequest

public JOpenCageForwardRequest(java.lang.String query)

JOpenCageForwardRequest

public JOpenCageForwardRequest(java.lang.String... queryParts)

Method Detail

getParameter

public java.util.Map<java.lang.String,java.lang.String> getParameter()

Overrides:

getParameter in class JOpenCageRequest

getBounds

public JOpenCageBounds getBounds()

setBounds

public void setBounds(JOpenCageBounds bounds)

getRestrictToCountryCode

public java.lang.String getRestrictToCountryCode()

setRestrictToCountryCode

public void setRestrictToCountryCode(java.lang.String restrictToCountryCode)

Restricts the results to the given country.

Parameters:

restrictToCountryCode - 2 character code as defined by the ISO 3166-1 Alpha 2 standard. E.g. 'gb' for the United Kingdom, fr for France

getLanguage

public java.lang.String getLanguage()

setLanguage

public 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

Parameters:

language - the language code

getLimit

public java.lang.Integer getLimit()

setLimit

public void setLimit(java.lang.Integer limit)

How many results should be returned. Default is 10.

Parameters:

limit - maximum number of results.

getMinConfidence

public java.lang.Integer getMinConfidence()

setMinConfidence

public void setMinConfidence(java.lang.Integer minConfidence)

An integer from 1-10 only results with at least this confidence will be returned.

Parameters:

minConfidence - minimum confidence that the result matches

isNoAnnotations

public boolean isNoAnnotations()

setNoAnnotations

public void setNoAnnotations(boolean noAnnotations)

If set to true the results will not contain annotations.

Parameters:

noAnnotations - If true no annotations are included. Defaults to false.

isNoDedupe

public boolean isNoDedupe()

setNoDedupe

public void setNoDedupe(boolean noDedupe)

If set to true the results will not be deduplicated.

Parameters:

noDedupe - If true the result will not be deduplicated. Defaults to false.

isPretty

public boolean isPretty()

setPretty

public void setPretty(boolean pretty)

If set to true pretty printing of the response payload is enabled.

Parameters:

pretty - If true the response will be pretty formatted.

setBounds

public 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. This value will help the geocoder but will not restrict the possible results to the supplied region.

Parameters:

northEastLat - north east latitude

northEastLng - north east longitude

southWestLat - south west latitude

southWestLng - south west longitude

setQueryPartSeparator

public void setQueryPartSeparator(java.lang.String queryPartSeparator)

If you use the query part constructor this String separates the query parts from each other. Defaults to a colon.

Parameters:

queryPartSeparator - the query part separator. Defaults to a colon.