Package com.rbmhtechnology.vind.model

Class MultiValuedComplexField.LocationComplexFieldDescriptor<T,F extends LatLng,S>

java.lang.Object

com.rbmhtechnology.vind.model.FieldDescriptor<T>

com.rbmhtechnology.vind.model.ComplexFieldDescriptor

com.rbmhtechnology.vind.model.MultiValuedComplexField<T,F,S>

com.rbmhtechnology.vind.model.MultiValuedComplexField.LocationComplexFieldDescriptor<T,F,S>

Type Parameters:

T - The field content type, must extend LatLng.

All Implemented Interfaces:

Serializable

Enclosing class:

MultiValuedComplexField<T,F,S>

public static class MultiValuedComplexField.LocationComplexFieldDescriptor<T,F extends LatLng,S>
extends MultiValuedComplexField<T,F,S>

Class to instantiate Document complex fields containing location type facet values.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.rbmhtechnology.vind.model.MultiValuedComplexField

MultiValuedComplexField.DateComplexField<T,F extends ZonedDateTime,S>, MultiValuedComplexField.LocationComplexFieldDescriptor<T,F extends LatLng,S>, MultiValuedComplexField.NumericComplexField<T,F extends Number,S>, MultiValuedComplexField.TextComplexField<T,F extends CharSequence,S>, MultiValuedComplexField.UtilDateComplexField<T,F extends Date,S>

Nested classes/interfaces inherited from class com.rbmhtechnology.vind.model.FieldDescriptor

FieldDescriptor.UseCase

Field Summary

Fields inherited from class com.rbmhtechnology.vind.model.FieldDescriptor

sort, sortFunction

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	LocationComplexFieldDescriptor(String fieldName, Class<T> type, Class<F> facetType, Class<S> suggestion)

Method Summary

Modifier and Type	Method	Description
Filter	withinBBox(LatLng upperLeft, LatLng lowerRight)	Instantiates a new Filter to checking if a field value is within a bounding box.
Filter	withinCircle(LatLng center, double distance)	Instantiates a new Filter to checking if a field value is within a circle.

Methods inherited from class com.rbmhtechnology.vind.model.MultiValuedComplexField

getSortFunction

Methods inherited from class com.rbmhtechnology.vind.model.ComplexFieldDescriptor

getAdvanceFilter, getFacetFunction, getFacetType, getFullTextFunction, getStoreFunction, getStoreType, getSuggestFunction, hasUseCase, isAdvanceFilter, isEmpty, isEmpty, isNotEmpty, isNotEmpty, setAdvanceFilter, setFacet, setFullText, setStored, setSuggest

Methods inherited from class com.rbmhtechnology.vind.model.FieldDescriptor

checkFieldType, getBoost, getLanguage, getMetadata, getName, getType, isContextualized, isFacet, isFullText, isIndexed, isMultiValue, isSort, isStored, isSuggest, isUpdate, setBoost, setContextualized, setFacet, setFullText, setIndexed, setLanguage, setMetadata, setMultiValue, setName, setSort, setStored, setSuggest, setUpdate, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

LocationComplexFieldDescriptor

protected LocationComplexFieldDescriptor(String fieldName,
                                         Class<T> type,
                                         Class<F> facetType,
                                         Class<S> suggestion)

Method Detail

withinBBox

public Filter withinBBox(LatLng upperLeft,
                         LatLng lowerRight)

Instantiates a new Filter to checking if a field value is within a bounding box.

Parameters:

upperLeft - the upper left corner of the box

lowerRight - the lower left corner of the box

Returns:

A configured filter for the field.

withinCircle

public Filter withinCircle(LatLng center,
                           double distance)

Instantiates a new Filter to checking if a field value is within a circle.

Parameters:

center - the of teh circle

distance - the radius of the circle

Returns:

A configured filter for the field.