sirius.db.es.annotations

Annotation Type Analyzed

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

Only for String fields.

This will make elasticsearch use an analyzer to split the contents of the field into separate tokens which are then searchable.

Field Summary

Fields

Modifier and Type	Fields and Description
static String	ANALYZER_TRIGRAM Sets the analyzer() to "trigram".
static String	ANALYZER_WHITESPACE Sets the analyzer() to "whitespace".

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	analyzer Permits to specify the analyzer to use for this field.
Analyzed.IndexOption	indexOptions Permits to specify additional index options sent to elasticsearch.

Field Detail

ANALYZER_WHITESPACE

public static final String ANALYZER_WHITESPACE

Sets the analyzer() to "whitespace".

This will instruct elasticsearch to use the whitespace analyzer which creates a token for each whitespace separated word.

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

ANALYZER_TRIGRAM

public static final String ANALYZER_TRIGRAM

Sets the analyzer() to "trigram".

This will instruct elasticsearch to use a trigram analyzer which creates "shingles" of min length 2 and max length 3.

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

Element Detail

analyzer

public abstract String analyzer

Permits to specify the analyzer to use for this field. By default the standard analyzer set by elasticsearch is used.

Returns:

the name of the analyzer to use for this field. If left empty, no value will be sent to elasticsearch so that it will use its default analyzer.

See Also:

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

Default:

""

indexOptions

public abstract Analyzed.IndexOption indexOptions

Permits to specify additional index options sent to elasticsearch.

Returns:

additional options sent to elasticsearch (use a constant defined by this annotation). If empty, nothing will be sent to elasticsearch (which will then apply its default value).

See Also:

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

Default:

sirius.db.es.annotations.Analyzed.IndexOption.DEFAULT