public interface PostingsFormatProvider
PostingsFormatProvider
acts as a named container for specific
PostingsFormat
implementations. Custom PostingsFormat
implementations can be exposed via
CodecModule.addPostingFormat(String, Class)
Each PostingsFormatProvider
must provide a unique name for its
postings format in order to map the postings format to a specific field via
the mapping API. The name provided via name()
is used to lookup the
postings format in PostingsFormatService.get(String)
and should be
identical to the values used in the field mappings.
PostingsFormatProvider
instances are initialized with a
Settings
subset below the
prefix and
will only see the sub-tree below their mapping name. For instance a postings
format ElasticFantastic will see settings below
index.codec.postings_format.elastic_fantastic given that the
postings format is exposed via
index.codec.postings_format.elastic_fantastic.type : "ElasticFantastic".
CodecModule
Modifier and Type | Interface and Description |
---|---|
static interface |
PostingsFormatProvider.Factory
A simple factory used to create
PostingsFormatProvider used by
delegating providers. |
static class |
PostingsFormatProvider.Helper
|
Modifier and Type | Field and Description |
---|---|
static String |
POSTINGS_FORMAT_SETTINGS_PREFIX |
Modifier and Type | Method and Description |
---|---|
org.apache.lucene.codecs.PostingsFormat |
get()
Returns this providers
PostingsFormat instance. |
String |
name()
Returns the name of this providers
PostingsFormat |
static final String POSTINGS_FORMAT_SETTINGS_PREFIX
org.apache.lucene.codecs.PostingsFormat get()
PostingsFormat
instance.String name()
PostingsFormat
Copyright © 2009–2015. All rights reserved.