io.ebean.annotation

Annotation Type DocProperty

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

Specify the entity type maps to a document store (like ElasticSearch).

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	analyzer The analyzer to use.
float	boost Set a boost value specific to this property.
boolean	code Set this to true to indicate that this property should be un-analysed.
String	copyTo Set a copyTo field.
boolean	docValues Set this to false such that doc values are not stored separately for this property.
boolean	enabled Set to false to disable the field from indexing, it will only be get/set in _source.
boolean	includeInAll Set this to false to exclude this from the _all property.
boolean	norms Set to false such that norms are not stored.
String	nullValue Set a value to use instead of null.
DocProperty.Option	options The index options for this property.
String	searchAnalyzer The analyzer to use for searches.
boolean	sortable Set this to true to get an additional un-analysed 'raw' field to use for sorting etc.
boolean	store Set to true to have the property additionally stored separately from _source.

Element Detail

code

public abstract boolean code

Set this to true to indicate that this property should be un-analysed.

Default:

false

sortable

public abstract boolean sortable

Set this to true to get an additional un-analysed 'raw' field to use for sorting etc.

Default:

false

store

public abstract boolean store

Set to true to have the property additionally stored separately from _source.

Default:

false

boost

public abstract float boost

Set a boost value specific to this property.

Default:

1.0f

nullValue

public abstract String nullValue

Set a value to use instead of null.

Default:

""

includeInAll

public abstract boolean includeInAll

Set this to false to exclude this from the _all property.

Default:

true

analyzer

public abstract String analyzer

The analyzer to use.

Default:

""

searchAnalyzer

public abstract String searchAnalyzer

The analyzer to use for searches.

Default:

""

options

public abstract DocProperty.Option options

The index options for this property.

Default:

io.ebean.annotation.DocProperty.Option.DEFAULT

docValues

public abstract boolean docValues

Set this to false such that doc values are not stored separately for this property.

Default:

true

copyTo

public abstract String copyTo

Set a copyTo field.

Default:

""

enabled

public abstract boolean enabled

Set to false to disable the field from indexing, it will only be get/set in _source.

Default:

true

norms

public abstract boolean norms

Set to false such that norms are not stored.

Default:

true