org.frekele.elasticsearch.mapping.annotations.ElasticGeoPointField Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of elasticsearch-mapping-builder Show documentation

Elasticsearch Java Mapping Builder.

The newest version!

package org.frekele.elasticsearch.mapping.annotations;

import org.frekele.elasticsearch.mapping.annotations.values.BoolValue;
import org.frekele.elasticsearch.mapping.enums.FieldType;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * Fields of type geo_point accept latitude-longitude pairs, which can be used:
 * - to find geo-points within a bounding box, within a certain distance of a central point, or within a polygon.
 * - to aggregate documents by geographically or by distance from a central point.
 * - to integrate distance into a document’s relevance score.
 * - to sort documents by distance.
 *
 * @author frekele - Leandro Kersting de Freitas
 * @see Site Elasticsearch Reference Guide.
 */
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface ElasticGeoPointField {

    FieldType type = FieldType.GEO_POINT;

    String suffixName() default "geoPoint";

    BoolValue ignoreMalformed() default @BoolValue(ignore = true);

}