com.attivio.sdk.search.query

Class GeoDistanceQuery

java.lang.Object

com.attivio.sdk.search.query.Query

com.attivio.sdk.search.query.GeoDistanceQuery

All Implemented Interfaces:

QueryParameters, LocaleAware, Serializable, Cloneable

public final class GeoDistanceQuery
extends Query

Query for matching documents that are a desired distance from a center point.

NOTE: Distances are treated in kilometers by default. Latitude and Longitude are specified in degrees. Use setDistanceUnits(DistanceUnits) to change the units used for the distance.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	QueryComponent.Parameter Linked list of parameters.

Field Summary

Fields

Modifier and Type	Field and Description
static DistanceUnits	DEFAULT_DISTANCE_UNITS Default units for distance measurements.
protected QueryComponent.Parameter	parameters

Fields inherited from class com.attivio.sdk.search.query.Query

boost, DEFAULT_PARAMETERS, IGNORE_PARAMETERS

Fields inherited from interface com.attivio.sdk.search.query.QueryParameters

ACL, ACRONYMS, ACRONYMS_EXPANDED, ACRONYMS_ORIGINAL, ALIAS, ALLOW, ANONYMOUS, BOOST, BOOST_FREQUENCY, BOOST_POSITION, BOOST_PROXIMITY, COMPLETENESS_BOOST, DEFAULT_BOOST, DEFAULT_DEPTH, DEFAULT_FIELD_NORMS, DEFAULT_FUZZY_MAX_TERMS, DEFAULT_MINIMUM, DEFAULT_QUOTED, DEFAULT_RECURSIVE, DEFAULT_ROLLUP_LIMIT, DEFAULT_SCORE_DEPTH, DEFAULT_SCORE_EXPLAIN, DEFAULT_SEARCH_FIELD, DEFAULT_SIMILARITY, DEFAULT_SPAN, DENY, DEPTH, DISABLE_COORD, DISTANCE, FACET, FIELD_NORMS, FUZZY_MAX_TERMS, LANGUAGE, LOWER, METHOD, MINIMUM, ON, ORDER, QUERY, QUERY_LANGUAGE, QUOTED, RECURSIVE, RELEVANCY_MODEL, ROLLUP, SCORE_DEPTH, SCORE_EXPLAIN, SCORE_FUNCTIONS, SCORE_MODE, SIMILARITY, SIMILARITY_PREFIX, SOUNDS_LIKE, SPAN, SPELLCHECK_CORRECTED, SPELLCHECK_EXPANDED, SPELLCHECK_MODE, SPELLCHECK_ORIGINAL, SPELLCHECK_SUGGESTIONS, STOPWORDS, SYNONYMS, SYNONYMS_EXPANDED, SYNONYMS_ORIGINAL, TOKENIZE, UNSECURED_ZONES, UPPER, WARNING, WILDCARD, XON

Constructor Summary

Constructors

Constructor and Description
GeoDistanceQuery() Constructor
GeoDistanceQuery(double distance)
GeoDistanceQuery(double distance, DistanceUnits units)
GeoDistanceQuery(String field, Point center, double distance)
GeoDistanceQuery(String field, Point center, double distance, DistanceUnits distanceUnits)

Method Summary

Modifier and Type	Method and Description
protected static void	addParameter(StringBuilder buffer, String name, Object value) Add "\"name\"=\"value\"" to buffer.
protected static void	appendParameter(StringBuilder buffer, String name, Object value) Add ", \"name\"=\"value\"" to buffer.
GeoDistanceQuery	clone() Returns a deep copy of this Query instance.
boolean	containsParameter(String name) Returns true if the specified parameter exists for this Query object.
protected boolean	equals(Object other, Map<String,Object> defaults, Set<String> ignore) Checks whether query equals this Query object.
protected static void	escape(StringBuilder buffer, Object value)
protected void	escape(StringBuilder buffer, String value, boolean quote) Helper method to escape a string for toString() .
Point	getCenter() Get the center point to calculate distance from.
double	getDistance() Get the maximum distance from the center a document must have to match.
DistanceUnits	getDistanceUnits() Get the units that minDistance and maxDistance are specified in
String	getField() Get the field to query.
Object	getParameter(String name) Returns a named property for this Query object.
boolean	getParameter(String name, boolean defaultValue) Gets a boolean parameter.
double	getParameter(String name, double defaultValue) Gets a double parameter.
float	getParameter(String name, float defaultValue) Gets a float parameter.
int	getParameter(String name, int defaultValue) Gets an integer parameter.
long	getParameter(String name, long defaultValue) Gets a long parameter.
Object	getParameter(String name, Object defaultValue) Gets a parameter.
String	getParameter(String name, String defaultValue) Gets a String parameter.
int	hashCode()
protected static StringBuilder	indent(StringBuilder buffer, int indent) Support method to indent a "line" in a StringBuilder.
Iterator<Map.Entry<String,Object>>	parameters() Get an iterator for returning all custom parameters.
protected static int	parseIntParameter(Object value, int defaultValue)
String	prettyFormat() Returns a hierarchical representation of this query as a string.
protected void	prettyFormat(StringBuilder buffer, int indent) Pretty format all parameters for this Query instance.
void	prettyPrint() Sends a hierarchical representation of this query to standard out.
void	prettyPrint(PrintStream out) Sends a hierarchical representation of this query specified PrintStream.
Object	removeParameter(String name) Remove the value for a parameter for this Query object.
protected void	setBooleanParameter(String key, Object value) Internal method for setting a boolean parameter.
void	setCenter(Point value) Set the center point to calculate distance from.
void	setDistance(double value) Set the maximum distance from the center a document must have to match.
void	setDistanceUnits(DistanceUnits units) Set the units that minDistance and maxDistance are specified in
protected void	setEnumParameter(String key, Object value, String... enumValues) Internal method for setting an object parameter.
void	setField(String value) Set the field to query.
protected void	setIntegerParameter(String key, Object value) Internal method for setting an integer parameter.
void	setParameter(String key, Object value)
void	setParameters(Map<String,Object> value)
void	setParameters(Map<String,Object> params, boolean override) Copies parameters from a Map into this Query.
protected void	setRollupParameter(String key, Object value)
protected void	setStringParameter(String key, Object value) Internal method for setting a string parameter.
protected void	setUnsignedParameter(String key, Object value) Internal method for setting an integer parameter.
String	toString()
String	toString(boolean compact)
protected void	toString(StringBuilder buffer, boolean compact) Write the String representation of this query to buffer.

Methods inherited from class com.attivio.sdk.search.query.Query

addParameters, appendParameters, containsParameters, equals, equals, equals, getBoost, getFirstNode, getInternalParameter, getLocale, getNodes, getNodes, getQueryLanguage, getQueryString, isCompactParameter, optimize, prettyFormatParameters, rewrite, rewriteChildren, setBoost, setBoost, setLocale, setParameters, setParameters

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

DEFAULT_DISTANCE_UNITS

public static final DistanceUnits DEFAULT_DISTANCE_UNITS

Default units for distance measurements.

parameters

protected QueryComponent.Parameter parameters

Constructor Detail

GeoDistanceQuery

public GeoDistanceQuery()

Constructor

GeoDistanceQuery

public GeoDistanceQuery(double distance)

GeoDistanceQuery

public GeoDistanceQuery(double distance,
                        DistanceUnits units)

GeoDistanceQuery

public GeoDistanceQuery(String field,
                        Point center,
                        double distance)

GeoDistanceQuery

public GeoDistanceQuery(String field,
                        Point center,
                        double distance,
                        DistanceUnits distanceUnits)

Method Detail

setParameter

public void setParameter(String key,
                         Object value)

Overrides:

setParameter in class Query

getField

public String getField()

Get the field to query.

If null, the default geo location field for the query will be used. This is FieldNames.POSITION by default.

setField

public void setField(String value)

Set the field to query.

getCenter

public Point getCenter()

Get the center point to calculate distance from.

If null, the default geo location center point for the QueryRequest will be used. If QueryRequest does not have a geo location set, the query will fail.

setCenter

public void setCenter(Point value)

Set the center point to calculate distance from.

getDistance

public double getDistance()

Get the maximum distance from the center a document must have to match.

setDistance

public void setDistance(double value)

Set the maximum distance from the center a document must have to match.

getDistanceUnits

public DistanceUnits getDistanceUnits()

Get the units that minDistance and maxDistance are specified in

setDistanceUnits

public void setDistanceUnits(DistanceUnits units)

Set the units that minDistance and maxDistance are specified in

toString

protected void toString(StringBuilder buffer,
                        boolean compact)

Write the String representation of this query to buffer.

prettyFormat

protected void prettyFormat(StringBuilder buffer,
                            int indent)

Pretty format all parameters for this Query instance.

Parameters:

buffer - buffer to write pretty formated parameters to.

indent - the indentation level

hashCode

public int hashCode()

equals

protected boolean equals(Object other,
                         Map<String,Object> defaults,
                         Set<String> ignore)

Checks whether query equals this Query object.

Overrides:

equals in class Query

Parameters:

other - the query to compare to

defaults - map of default values for query parameters

ignore - set of query parameters to ignore during equality check.

Returns:

true if other is equal to this Query

clone

public GeoDistanceQuery clone()

Returns a deep copy of this Query instance.

NOTE: values for parameters are shallow copied.

Overrides:

clone in class Query

Returns:

a copy of this Query.

parameters

public Iterator<Map.Entry<String,Object>> parameters()

Get an iterator for returning all custom parameters.

containsParameter

public boolean containsParameter(String name)

Returns true if the specified parameter exists for this Query object.

Parameters:

name - parameter name.

Returns:

true if the specified parameter exists.

getParameter

public final Object getParameter(String name)

Returns a named property for this Query object.

Parameters:

name - parameter name.

Returns:

the value for the named property (or null if not found)

getParameter

public final String getParameter(String name,
                                 String defaultValue)

Gets a String parameter.

Parameters:

name - parameter name.

defaultValue - default value to return if not set.

getParameter

public final boolean getParameter(String name,
                                  boolean defaultValue)

Gets a boolean parameter.

Parameters:

name - parameter name.

defaultValue - default value to return if not set.

getParameter

public final int getParameter(String name,
                              int defaultValue)

Gets an integer parameter.

Parameters:

name - parameter name.

defaultValue - default value to return if not set.

getParameter

public final long getParameter(String name,
                               long defaultValue)

Gets a long parameter.

Parameters:

name - parameter name.

defaultValue - default value to return if not set.

getParameter

public final float getParameter(String name,
                                float defaultValue)

Gets a float parameter.

Parameters:

name - parameter name.

defaultValue - default value to return if not set.

getParameter

public final double getParameter(String name,
                                 double defaultValue)

Gets a double parameter.

Parameters:

name - parameter name.

defaultValue - default value to return if not set.

getParameter

public Object getParameter(String name,
                           Object defaultValue)

Gets a parameter.

Parameters:

name - name of parameter to return.

defaultValue - default value to return if not set.

setParameters

public final void setParameters(Map<String,Object> value)

setParameters

public void setParameters(Map<String,Object> params,
                          boolean override)

Copies parameters from a Map into this Query.

Parameters:

params - the parameters to copy into this Query instance.

override - indicates if parameters from params should overwrite existing parameters in this Query

parseIntParameter

protected static int parseIntParameter(Object value,
                                       int defaultValue)

removeParameter

public Object removeParameter(String name)

Remove the value for a parameter for this Query object.

Parameters:

name - the parameter to remove.

setEnumParameter

protected final void setEnumParameter(String key,
                                      Object value,
                                      String... enumValues)

Internal method for setting an object parameter.

NOTE: enumValues must contain lower case strings.

setStringParameter

protected final void setStringParameter(String key,
                                        Object value)

Internal method for setting a string parameter.

setIntegerParameter

protected final void setIntegerParameter(String key,
                                         Object value)

Internal method for setting an integer parameter.

setUnsignedParameter

protected final void setUnsignedParameter(String key,
                                          Object value)

Internal method for setting an integer parameter.

setBooleanParameter

protected final void setBooleanParameter(String key,
                                         Object value)

Internal method for setting a boolean parameter.

setRollupParameter

protected final void setRollupParameter(String key,
                                        Object value)

appendParameter

protected static void appendParameter(StringBuilder buffer,
                                      String name,
                                      Object value)

Add ", \"name\"=\"value\"" to buffer.

addParameter

protected static void addParameter(StringBuilder buffer,
                                   String name,
                                   Object value)

Add "\"name\"=\"value\"" to buffer.

escape

protected static void escape(StringBuilder buffer,
                             Object value)

escape

protected void escape(StringBuilder buffer,
                      String value,
                      boolean quote)

Helper method to escape a string for toString() .

Parameters:

buffer - buffer to write escaped value to

value - the value to escape

quote - if true, escaped value will be wrapped in double quotes.

toString

public final String toString()

Overrides:

toString in class Object

toString

public final String toString(boolean compact)

prettyPrint

public final void prettyPrint()

Sends a hierarchical representation of this query to standard out.

prettyPrint

public final void prettyPrint(PrintStream out)

Sends a hierarchical representation of this query specified PrintStream.

Parameters:

out - stream to output query representation to

prettyFormat

public final String prettyFormat()

Returns a hierarchical representation of this query as a string.

indent

protected static StringBuilder indent(StringBuilder buffer,
                                      int indent)

Support method to indent a "line" in a StringBuilder.