Module org.elasticsearch.server

Package org.elasticsearch.plugins

Class SearchPlugin.RetrieverSpec<RB extends RetrieverBuilder>

java.lang.Object

org.elasticsearch.plugins.SearchPlugin.RetrieverSpec<RB>

Enclosing interface:

SearchPlugin

public static class SearchPlugin.RetrieverSpec<RB extends RetrieverBuilder>
extends Object

Specification of custom RetrieverBuilder.

Constructor Summary

Constructors

Constructor	Description
RetrieverSpec(String name, RetrieverParser<RB> parser)	Specification of custom RetrieverBuilder.
RetrieverSpec(ParseField name, RetrieverParser<RB> parser)	Specification of custom RetrieverBuilder.

Method Summary

Modifier and Type	Method	Description
ParseField	getName()
RetrieverParser<RB>	getParser()

Methods inherited from class java.lang.Object

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

Constructor Details

RetrieverSpec

public RetrieverSpec(ParseField name,
 RetrieverParser<RB> parser)

Specification of custom RetrieverBuilder.

Parameters:

name - holds the names by which this retriever might be parsed. The ParseField.getPreferredName() is special as it is the name by under which the reader is registered. So it is the name that the retriever should use as its NamedWriteable.getWriteableName() too.

parser - the parser the reads the retriever builder from xcontent

RetrieverSpec

public RetrieverSpec(String name,
 RetrieverParser<RB> parser)

Specification of custom RetrieverBuilder.

Parameters:

name - the name by which this retriever might be parsed or deserialized. Make sure that the retriever builder returns this name for NamedWriteable.getWriteableName().

parser - the parser the reads the retriever builder from xcontent

Method Details

getName

public ParseField getName()

getParser

public RetrieverParser<RB> getParser()