com.stratio.cassandra.lucene.common.GeoDistanceUnit Maven / Gradle / Ivy
The newest version!
/*
* Copyright (C) 2014 Stratio (http://stratio.com)
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.stratio.cassandra.lucene.common;
import com.fasterxml.jackson.annotation.JsonCreator;
/**
* Enum representing a spatial distance unit.
*/
public enum GeoDistanceUnit {
MILLIMETRES(0.001, "mm", "millimetres"),
CENTIMETRES(0.01, "cm", "centimetres"),
DECIMETRES(0.1, "dm", "decimetres"),
DECAMETRES(10, "dam", "decametres"),
HECTOMETRES(100, "hm", "hectometres"),
KILOMETRES(1000, "km", "kilometres"),
FOOTS(0.3048, "ft", "foots"),
YARDS(0.9144, "yd", "yards"),
INCHES(0.0254, "in", "inches"),
MILES(1609.344, "mi", "miles"),
METRES(1, "m", "metres"),
NAUTICAL_MILES(1850, "M", "NM", "mil", "nautical_miles");
private final String[] names;
private final Double metres;
/**
* Builds the {@link GeoDistanceUnit} defined by the specified value in metres and the specified identifying names.
*
* @param metres the value in metres
* @param names the identifying names
*/
GeoDistanceUnit(double metres, String... names) {
this.names = names;
this.metres = metres;
}
/**
* Returns the equivalency in metres.
*
* @return the equivalency in metres
*/
public Double getMetres() {
return metres;
}
/**
* Returns the identifying names.
*
* @return the identifying names
*/
public String[] getNames() {
return names;
}
/**
* Returns the {@link GeoDistanceUnit} represented by the specified {@code String}.
*
* @param value the {@code String} representation of the {@link GeoDistanceUnit} to be created
* @return the {@link GeoDistanceUnit} represented by the specified {@code String}
*/
@JsonCreator
public static GeoDistanceUnit create(String value) {
if (value == null) {
throw new IllegalArgumentException();
}
for (GeoDistanceUnit v : values()) {
for (String s : v.names) {
if (s.equals(value)) {
return v;
}
}
}
throw new IllegalArgumentException();
}
}