com.github.tlrx.elasticsearch.test.annotations.ElasticsearchMappingField Maven / Gradle / Ivy

Go to download

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

elasticsearch-test, a framework that makes ElasticSearch unit testing a breeze

There is a newer version: 1.2.1

/**
 *
 */
package com.github.tlrx.elasticsearch.test.annotations;

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

/**
 * ElasticsearchMappingField Annotation, used to define the mapping properties  for a given document field
 *
 * @author tlrx
 */
@Retention(RetentionPolicy.RUNTIME)
public @interface ElasticsearchMappingField {

    /**
     * Globally defined analyzer
     */
    public static final String DEFAULT_ANALYZER = "default-analyzer";

    public enum Types {
        String, Integer, Long, Boolean, Date, Float, Double, Null
    }

    public enum Store {
        Yes, No
    }

    public enum Index {
        Undefined, Analyzed, Not_Analyzed, No
    }

    public enum TermVector {
        Yes, No, With_Offsets, With_Positions, With_Positions_Offsets
    }

    /**
     * The field's name for which properties are defined
     */
    String name();

    /**
     * Default field type
     */
    Types type() default Types.String;

    /**
     * Store property (true means "yes", false means "no" and default is set to false)
     */
    Store store() default Store.No;

    /**
     * Index property (analyzed, not_analyzed, no)
     */
    Index index() default Index.Undefined;

    /**
     * Name of the analyzer
     */
    String analyzerName() default DEFAULT_ANALYZER;

    /**
     * The analyzer used to analyze the text contents when analyzed during indexing.
     */
    String indexAnalyzerName() default DEFAULT_ANALYZER;

    /**
     * The analyzer used to analyze the field when part of a query string.
     */
    String searchAnalyzerName() default DEFAULT_ANALYZER;

    /**
     * The term_vector value for analyzed field
     */
    TermVector termVector() default TermVector.No;
}