Package io.jmix.search.index.annotation

Annotation Interface AutoMappedField

@Target(METHOD)
@Retention(RUNTIME)
@Repeatable(Container.class)
public @interface AutoMappedField

One of the field-mapping annotation. Should be set on methods in index definition interfaces.

Entity properties covered by this annotation will be indexed the most common way depends on their datatype.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static @interface	AutoMappedField.Container

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
String	analyzer	Provides analyzer that should be applied to all textual fields covered by this annotation.
String[]	excludeProperties	Provides entity properties that should NOT be covered by this annotation.
String[]	includeProperties	Provides entity properties that should be covered by this annotation.
boolean	indexFileContent	Defines if content of file found in matched File properties should be indexed.

Element Details

includeProperties

String[] includeProperties

Provides entity properties that should be covered by this annotation.

Properties should be defined in a full-name format started from the root entity ("localPropertyName", "refPropertyName.propertyName").

Wildcard is allowed at the last level of multilevel properties ("*", "refPropertyName.*").

Returns:

properties should be processed

Default:

{""}

excludeProperties

String[] excludeProperties

Provides entity properties that should NOT be covered by this annotation.

Properties should be defined in a full-name format started from the root entity ("localPropertyName", "refPropertyName.propertyName").

Wildcard is allowed at the last level of multilevel properties ("*", "refPropertyName.*").

Returns:

properties should not be processed

Default:

{""}

analyzer

String analyzer

Provides analyzer that should be applied to all textual fields covered by this annotation.

Returns:

name of analyzer

Default:

""

indexFileContent

boolean indexFileContent

Defines if content of file found in matched File properties should be indexed.

Returns:

True if both file name and content are indexed (default) or false if only file name is indexed

Default:

true