org.elasticsearch.index.codec

Class CodecModule

java.lang.Object

org.elasticsearch.common.inject.AbstractModule

org.elasticsearch.index.codec.CodecModule

All Implemented Interfaces:

Module

public class CodecModule
extends AbstractModule

The CodecModule creates and loads the CodecService, PostingsFormatService and DocValuesFormatService, allowing low level data-structure specialization on a Lucene Segment basis.

The codec module is the authoritative source for build-in and custom PostingsFormatProvider. During module bootstrap it processes the index settings underneath the and instantiates the corresponding PostingsFormatProvider instances. To configure a custom provider implementations the class should reside in the org.elasticsearch.index.codec.postingsformat package and the classname should be suffixed with PostingsFormatProvider.
For example to expose the Elastic-Fantastic format provider one need to provide the following configuration settings and classes:

1. create a PostingsFormatProvider subclass in the package org.elasticsearch.index.codec.postingsformat
2. name the subclass ElasticFantatsticPostingsFormatProvider
3. configure the custom format in you index settings under index.codec.postings_format.elastic_fantatic.type : "ElasticFantatic"
4. provide any postings format settings for this custom format under the same key ie. index.codec.postings_format.elastic_fantatic.performance : "crazy_fast"

See Also:

CodecService

Constructor Summary

Constructors

Constructor and Description
CodecModule(Settings indexSettings)

Method Summary

Modifier and Type	Method and Description
CodecModule	addDocValuesFormat(String name, Class<? extends DocValuesFormatProvider> provider)
CodecModule	addPostingFormat(String name, Class<? extends PostingsFormatProvider> provider)
protected void	configure() Configures a Binder via the exposed methods.

Methods inherited from class org.elasticsearch.common.inject.AbstractModule

addError, addError, addError, bind, bind, bind, bindConstant, binder, bindListener, bindScope, configure, convertToTypes, currentStage, getMembersInjector, getMembersInjector, getProvider, getProvider, install, requestInjection, requestStaticInjection, requireBinding, requireBinding

Methods inherited from class java.lang.Object

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

Constructor Detail

CodecModule

public CodecModule(Settings indexSettings)

Method Detail

addPostingFormat

public CodecModule addPostingFormat(String name,
                                    Class<? extends PostingsFormatProvider> provider)

addDocValuesFormat

public CodecModule addDocValuesFormat(String name,
                                      Class<? extends DocValuesFormatProvider> provider)

configure

protected void configure()

Description copied from class: AbstractModule

Configures a Binder via the exposed methods.

Specified by:

configure in class AbstractModule