org.springframework.data.elasticsearch.core

Class AbstractIndexTemplate

java.lang.Object

org.springframework.data.elasticsearch.core.AbstractIndexTemplate

All Implemented Interfaces:

IndexOperations

public abstract class AbstractIndexTemplate
extends Object
implements IndexOperations

Base implementation of IndexOperations common to Transport and Rest based Implementations of IndexOperations.

Since:

4.0

Author:

Peter-Josef Meisch, Sascha Woo

Field Summary

Fields

Modifier and Type	Field and Description
protected Class<?>	boundClass
protected ElasticsearchConverter	elasticsearchConverter

Constructor Summary

Constructors

Constructor and Description
AbstractIndexTemplate(ElasticsearchConverter elasticsearchConverter, Class<?> boundClass)
AbstractIndexTemplate(ElasticsearchConverter elasticsearchConverter, IndexCoordinates boundIndex)

Method Summary

Modifier and Type	Method and Description
protected Class<?>	checkForBoundClass()
boolean	create() Create an index.
boolean	create(Map<String,Object> settings) Create an index for given settings.
boolean	create(Map<String,Object> settings, Document mapping) Create an index for given settings and mapping.
Document	createMapping() Creates the index mapping for the entity this IndexOperations is bound to.
Document	createMapping(Class<?> clazz) Creates the index mapping for the given class
Settings	createSettings() Creates the index settings for the entity this IndexOperations is bound to.
Settings	createSettings(Class<?> clazz) Creates the index settings from the annotations on the given class
boolean	createWithMapping() Create an index with the settings and mapping defined for the entity this IndexOperations is bound to.
boolean	delete() Deletes the index this IndexOperations is bound to
protected abstract boolean	doCreate(IndexCoordinates index, Map<String,Object> settings, Document mapping)
protected abstract boolean	doDelete(IndexCoordinates index)
protected abstract boolean	doExists(IndexCoordinates index)
protected abstract Map<String,Set<AliasData>>	doGetAliases(String[] aliasNames, String[] indexNames)
protected abstract Map<String,Object>	doGetMapping(IndexCoordinates index)
protected abstract Settings	doGetSettings(IndexCoordinates index, boolean includeDefaults)
protected abstract boolean	doPutMapping(IndexCoordinates index, Document mapping)
protected abstract void	doRefresh(IndexCoordinates indexCoordinates)
boolean	exists() Checks if the index this IndexOperations is bound to exists
Map<String,Set<AliasData>>	getAliases(String... aliasNames) gets information about aliases
Map<String,Set<AliasData>>	getAliasesForIndex(String... indexNames) gets information about aliases
IndexCoordinates	getIndexCoordinates() get the current IndexCoordinates.
IndexCoordinates	getIndexCoordinatesFor(Class<?> clazz)
Map<String,Object>	getMapping() Get mapping for an index defined by a class.
Settings	getSettings() Get the index settings.
Settings	getSettings(boolean includeDefaults) Get the index settings.
boolean	putMapping(Document mapping) writes a mapping to the index
void	refresh() Refresh the index(es) this IndexOperations is bound to

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.data.elasticsearch.core.IndexOperations

alias, deleteTemplate, deleteTemplate, existsTemplate, existsTemplate, getInformation, getInformation, getTemplate, getTemplate, putMapping, putMapping, putTemplate

Field Detail

elasticsearchConverter

protected final ElasticsearchConverter elasticsearchConverter

boundClass

@Nullable
protected final Class<?> boundClass

Constructor Detail

AbstractIndexTemplate

public AbstractIndexTemplate(ElasticsearchConverter elasticsearchConverter,
                             Class<?> boundClass)

AbstractIndexTemplate

public AbstractIndexTemplate(ElasticsearchConverter elasticsearchConverter,
                             IndexCoordinates boundIndex)

Method Detail

checkForBoundClass

protected Class<?> checkForBoundClass()

create

public boolean create()

Description copied from interface: IndexOperations

Create an index.

Specified by:

create in interface IndexOperations

Returns:

true if the index was created

createSettings

public Settings createSettings(Class<?> clazz)

Description copied from interface: IndexOperations

Creates the index settings from the annotations on the given class

Specified by:

createSettings in interface IndexOperations

Parameters:

clazz - the class to create the index settings from

Returns:

a settings document.

createWithMapping

public boolean createWithMapping()

Description copied from interface: IndexOperations

Create an index with the settings and mapping defined for the entity this IndexOperations is bound to.

Specified by:

createWithMapping in interface IndexOperations

Returns:

true if the index was created

create

public boolean create(Map<String,Object> settings)

Description copied from interface: IndexOperations

Create an index for given settings.

Specified by:

create in interface IndexOperations

Parameters:

settings - the index settings

Returns:

true if the index was created

create

public boolean create(Map<String,Object> settings,
                      Document mapping)

Description copied from interface: IndexOperations

Create an index for given settings and mapping.

Specified by:

create in interface IndexOperations

Parameters:

settings - the index settings

mapping - the index mapping

Returns:

true if the index was created

doCreate

protected abstract boolean doCreate(IndexCoordinates index,
                                    Map<String,Object> settings,
                                    @Nullable
                                    Document mapping)

delete

public boolean delete()

Description copied from interface: IndexOperations

Deletes the index this IndexOperations is bound to

Specified by:

delete in interface IndexOperations

Returns:

true if the index was deleted

doDelete

protected abstract boolean doDelete(IndexCoordinates index)

exists

public boolean exists()

Description copied from interface: IndexOperations

Checks if the index this IndexOperations is bound to exists

Specified by:

exists in interface IndexOperations

Returns:

true if the index exists

doExists

protected abstract boolean doExists(IndexCoordinates index)

putMapping

public boolean putMapping(Document mapping)

Description copied from interface: IndexOperations

writes a mapping to the index

Specified by:

putMapping in interface IndexOperations

Parameters:

mapping - the Document with the mapping definitions

Returns:

true if the mapping could be stored

doPutMapping

protected abstract boolean doPutMapping(IndexCoordinates index,
                                        Document mapping)

getMapping

public Map<String,Object> getMapping()

Description copied from interface: IndexOperations

Get mapping for an index defined by a class.

Specified by:

getMapping in interface IndexOperations

Returns:

the mapping

doGetMapping

protected abstract Map<String,Object> doGetMapping(IndexCoordinates index)

getSettings

public Settings getSettings()

Description copied from interface: IndexOperations

Get the index settings.

Specified by:

getSettings in interface IndexOperations

Returns:

the settings

getSettings

public Settings getSettings(boolean includeDefaults)

Description copied from interface: IndexOperations

Get the index settings.

Specified by:

getSettings in interface IndexOperations

Parameters:

includeDefaults - whether or not to include all the default settings

Returns:

the settings

doGetSettings

protected abstract Settings doGetSettings(IndexCoordinates index,
                                          boolean includeDefaults)

refresh

public void refresh()

Description copied from interface: IndexOperations

Refresh the index(es) this IndexOperations is bound to

Specified by:

refresh in interface IndexOperations

doRefresh

protected abstract void doRefresh(IndexCoordinates indexCoordinates)

getAliases

public Map<String,Set<AliasData>> getAliases(String... aliasNames)

Description copied from interface: IndexOperations

gets information about aliases

Specified by:

getAliases in interface IndexOperations

Parameters:

aliasNames - alias names, must not be null

Returns:

a Map from index names to AliasData for that index

getAliasesForIndex

public Map<String,Set<AliasData>> getAliasesForIndex(String... indexNames)

Description copied from interface: IndexOperations

gets information about aliases

Specified by:

getAliasesForIndex in interface IndexOperations

Parameters:

indexNames - index names, must not be null

Returns:

a Map from index names to AliasData for that index

doGetAliases

protected abstract Map<String,Set<AliasData>> doGetAliases(@Nullable
                                                           String[] aliasNames,
                                                           @Nullable
                                                           String[] indexNames)

createMapping

public Document createMapping()

Description copied from interface: IndexOperations

Creates the index mapping for the entity this IndexOperations is bound to.

Specified by:

createMapping in interface IndexOperations

Returns:

mapping object

createMapping

public Document createMapping(Class<?> clazz)

Description copied from interface: IndexOperations

Creates the index mapping for the given class

Specified by:

createMapping in interface IndexOperations

Parameters:

clazz - the clazz to create a mapping for

Returns:

mapping object

createSettings

public Settings createSettings()

Description copied from interface: IndexOperations

Creates the index settings for the entity this IndexOperations is bound to.

Specified by:

createSettings in interface IndexOperations

Returns:

a settings document.

getIndexCoordinates

public IndexCoordinates getIndexCoordinates()

Description copied from interface: IndexOperations

get the current IndexCoordinates. These may change over time when the entity class has a SpEL constructed index name. When this IndexOperations is not bound to a class, the bound IndexCoordinates are returned.

Specified by:

getIndexCoordinates in interface IndexOperations

Returns:

IndexCoordinates

getIndexCoordinatesFor

public IndexCoordinates getIndexCoordinatesFor(Class<?> clazz)