Package com.redis.vl.query

Enum Class Filter.GeoUnit

java.lang.Object

java.lang.Enum<Filter.GeoUnit>

com.redis.vl.query.Filter.GeoUnit

All Implemented Interfaces:

Serializable, Comparable<Filter.GeoUnit>, Constable

Enclosing class:

Filter

public static enum Filter.GeoUnit
extends Enum<Filter.GeoUnit>

Geographic units for radius queries

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
FT	Feet
KM	Kilometers
M	Meters
MI	Miles

Method Summary

Modifier and Type	Method	Description
String	getValue()	Get the string value of this geographic unit.
static Filter.GeoUnit	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Filter.GeoUnit[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

M

public static final Filter.GeoUnit M

Meters

KM

public static final Filter.GeoUnit KM

Kilometers

MI

public static final Filter.GeoUnit MI

Miles

FT

public static final Filter.GeoUnit FT

Feet

Method Details

values

public static Filter.GeoUnit[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static Filter.GeoUnit valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

getValue

public String getValue()

Get the string value of this geographic unit.

Returns:

The unit abbreviation (e.g., "m", "km", "mi", "ft")