Package org.apache.solr.response.transform

Class ExplainAugmenterFactory

java.lang.Object

org.apache.solr.response.transform.TransformerFactory

org.apache.solr.response.transform.ExplainAugmenterFactory

All Implemented Interfaces:

NamedListInitializedPlugin

public class ExplainAugmenterFactory
extends TransformerFactory

Since:

solr 4.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ExplainAugmenterFactory.Style

Nested classes/interfaces inherited from class org.apache.solr.response.transform.TransformerFactory

TransformerFactory.FieldRenamer

Field Summary

Fields

Modifier and Type	Field	Description
protected ExplainAugmenterFactory.Style	defaultStyle

Fields inherited from class org.apache.solr.response.transform.TransformerFactory

defaultFactories, defaultUserArgs

Constructor Summary

Constructors

Constructor	Description
ExplainAugmenterFactory()

Method Summary

Modifier and Type	Method	Description
DocTransformer	create(String field, org.apache.solr.common.params.SolrParams params, SolrQueryRequest req)
static ExplainAugmenterFactory.Style	getStyle(String str)
void	init(org.apache.solr.common.util.NamedList<?> args)	init will be called just once, immediately after creation.
static String	toHtml(org.apache.lucene.search.Explanation explanation)	Render an explanation as HTML.

Methods inherited from class java.lang.Object

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

Field Details

defaultStyle

protected ExplainAugmenterFactory.Style defaultStyle

Constructor Details

ExplainAugmenterFactory

public ExplainAugmenterFactory()

Method Details

init

public void init(org.apache.solr.common.util.NamedList<?> args)

Description copied from interface: NamedListInitializedPlugin

init will be called just once, immediately after creation.

Source of the initialization arguments will typically be solrconfig.xml, but will ultimately depends on the plugin itself

Specified by:

init in interface NamedListInitializedPlugin

Overrides:

init in class TransformerFactory

Parameters:

args - non-null list of initialization parameters (may be empty)

getStyle

public static ExplainAugmenterFactory.Style getStyle(String str)

create

public DocTransformer create(String field,
 org.apache.solr.common.params.SolrParams params,
 SolrQueryRequest req)

Specified by:

create in class TransformerFactory

toHtml

public static String toHtml(org.apache.lucene.search.Explanation explanation)

Render an explanation as HTML.