org.frekele.elasticsearch.mapping.annotations.ElasticGeoShapeField 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.annotations.values.FloatValue;
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;

/**
 * The geo_shape datatype facilitates the indexing of and searching with arbitrary geo shapes such as rectangles and polygons.
 * It should be used when either the data being indexed or the queries being executed contain shapes other than just points.
 *
 * @author frekele - Leandro Kersting de Freitas
 * @see Site Elasticsearch Reference Guide.
 */
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface ElasticGeoShapeField {

    FieldType type = FieldType.GEO_SHAPE;

    String suffixName() default "geoShape";

    String tree() default "";

    String precision() default "";

    String treeLevels() default "";

    String strategy() default "";

    FloatValue distanceErrorPct() default @FloatValue(ignore = true);

    String orientation() default "";

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

}