sirius.db.es

Class IndexMappings

java.lang.Object

sirius.db.es.IndexMappings

All Implemented Interfaces:

sirius.kernel.di.std.Priorized, sirius.kernel.Startable

public class IndexMappings
extends Object
implements sirius.kernel.Startable

Creates the mappings for all available Elasticsearch entities.

Field Summary

Fields

Modifier and Type	Field and Description
static String	MAPPING_DOC_VALUES Mapping key used to tell ES about the doc_values setting.
static String	MAPPING_INDEX Mapping key used to tell ES if a property is indexed (searchable).
static String	MAPPING_NORMS Mapping key used to tell ES if and how to store norms.
static String	MAPPING_STORED Mapping key used to tell ES if and how a property is stored
static String	MAPPING_TYPE Mapping key used to tell ES the mapping type of a field.
static String	MAPPING_TYPE_KEWORD Mapping value used to mark a field as "keywors" meaning that it is indexed but not analyzed.

Fields inherited from interface sirius.kernel.di.std.Priorized

DEFAULT_PRIORITY

Constructor Summary

Constructors

Constructor and Description
IndexMappings()

Method Summary

Modifier and Type	Method and Description
void	ensureYearlyIndexExists(EntityDescriptor ed, int year) Ensures that the index for the given entity type and year exists and contains the appropriate mappings.
protected boolean	setupEntity(EntityDescriptor ed)
void	started()
boolean	yearlyIndexExists(String name) Determines if the given yearly index exists.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface sirius.kernel.Startable

getPriority

Field Detail

MAPPING_STORED

public static final String MAPPING_STORED

Mapping key used to tell ES if and how a property is stored

See Also:

Constant Field Values

MAPPING_INDEX

public static final String MAPPING_INDEX

Mapping key used to tell ES if a property is indexed (searchable).

See Also:

Constant Field Values

MAPPING_DOC_VALUES

public static final String MAPPING_DOC_VALUES

Mapping key used to tell ES about the doc_values setting.

See Also:

Constant Field Values

MAPPING_NORMS

public static final String MAPPING_NORMS

Mapping key used to tell ES if and how to store norms.

See Also:

Constant Field Values

MAPPING_TYPE

public static final String MAPPING_TYPE

Mapping key used to tell ES the mapping type of a field.

See Also:

Constant Field Values

MAPPING_TYPE_KEWORD

public static final String MAPPING_TYPE_KEWORD

Mapping value used to mark a field as "keywors" meaning that it is indexed but not analyzed.

See Also:

Constant Field Values

Constructor Detail

IndexMappings

public IndexMappings()

Method Detail

started

public void started()

Specified by:

started in interface sirius.kernel.Startable

setupEntity

protected boolean setupEntity(EntityDescriptor ed)

yearlyIndexExists

public boolean yearlyIndexExists(String name)

Determines if the given yearly index exists.

As we might check this frequently (for queries against entities stored per year) the result is cached.

Parameters:

name - the name of the index to check.

Returns:

true if an index exists, false if it hasn't been created yet

ensureYearlyIndexExists

public void ensureYearlyIndexExists(EntityDescriptor ed,
                                    int year)

Ensures that the index for the given entity type and year exists and contains the appropriate mappings.

Parameters:

ed - the descriptor of the entity type

year - the year to create the index for