sirius.db.es.annotations

Annotation Type IndexMode

@Retention(value=RUNTIME)
 @Target(value=FIELD)
public @interface IndexMode

Changes the index mode of the annotated field.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
ESOption	docValues Permits to specify if the contents of this field are stored on disk in a column-stride fashion.
boolean	excludeFromSource Permits to exclude the contents of this field from the _source field.
ESOption	indexed Determines whether this field should be indexed in general by elasticsearch.
ESOption	normsEnabled Only for String and List<String> fields.
ESOption	stored Determines whether this field should be stored separately from the _source field by elasticsearch.

Element Detail

indexed

public abstract ESOption indexed

Determines whether this field should be indexed in general by elasticsearch.

Returns:

true if this field should be indexed or not.

See Also:

https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-index.html

Default:

sirius.db.es.annotations.ESOption.ES_DEFAULT

stored

public abstract ESOption stored

Determines whether this field should be stored separately from the _source field by elasticsearch.

Returns:

true if this field should be stored separately from the _source field by elasticsearch.

See Also:

https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-store.html

Default:

sirius.db.es.annotations.ESOption.ES_DEFAULT

normsEnabled

public abstract ESOption normsEnabled

Only for String and List<String> fields. Permits to specify if norms are enabled for this field or not.

Returns:

whether norms are enabled or not.

See Also:

https://www.elastic.co/guide/en/elasticsearch/reference/current/norms.html

Default:

sirius.db.es.annotations.ESOption.ES_DEFAULT

docValues

public abstract ESOption docValues

Permits to specify if the contents of this field are stored on disk in a column-stride fashion.

Returns:

"true" if the contents of this field should be stored on disk in a column-stride fashion, "false" otherwise.

See Also:

https://www.elastic.co/guide/en/elasticsearch/reference/current/doc-values.html

Default:

sirius.db.es.annotations.ESOption.ES_DEFAULT

excludeFromSource

public abstract boolean excludeFromSource

Permits to exclude the contents of this field from the _source field. This should be used with care!

See the elasticsearch docs for a detailed description of the behaviour.

Returns:

true if the value is excluded from source, false otherwise

Default:

false