IndexableId.java

package com.github.kzwang.osem.annotations;


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

/**
 * Id field of the object, it will not be include in the json unless has annotation {@link com.github.kzwang.osem.annotations.IndexableProperty}
 *
 * @see <a href="http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/mapping-id-field.html">_id field</a>
 */
@Retention(RetentionPolicy.RUNTIME)
@Target(value = {ElementType.FIELD, ElementType.METHOD})
public @interface IndexableId {
    /**
     * "store" field in mapping
     */
    boolean store() default false;

    /**
     * "index" field in mapping
     */
    IndexEnum index() default IndexEnum.NA;


}