org.apache.solr.handler.component

Class QueryElevationComponent

java.lang.Object

org.apache.solr.handler.component.SearchComponent

org.apache.solr.handler.component.QueryElevationComponent

All Implemented Interfaces:

SolrInfoMBean, NamedListInitializedPlugin, SolrCoreAware

public class QueryElevationComponent
extends SearchComponent
implements SolrCoreAware

A component to elevate some documents to the top of the result set.

Since:

solr 1.3

Version:

$Id: QueryElevationComponent.java 1215518 2011-12-17 16:06:16Z gsingers $

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) class	QueryElevationComponent.ElevationObj

Nested classes/interfaces inherited from interface org.apache.solr.core.SolrInfoMBean

SolrInfoMBean.Category

Field Summary

Fields

Modifier and Type	Field and Description
private org.apache.lucene.analysis.Analyzer	analyzer
(package private) static java.lang.String	CONFIG_FILE
(package private) java.util.Map<org.apache.lucene.index.IndexReader,java.util.Map<java.lang.String,QueryElevationComponent.ElevationObj>>	elevationCache
(package private) static java.lang.String	EXCLUDE
(package private) static java.lang.String	FIELD_TYPE
(package private) boolean	forceElevation
private java.lang.String	idField
private FieldType	idSchemaFT
private SolrParams	initArgs
private static org.slf4j.Logger	log

Constructor Summary

Constructors

Constructor and Description
QueryElevationComponent()

Method Summary

Modifier and Type	Method and Description
(package private) java.lang.String	getAnalyzedQuery(java.lang.String query)
java.lang.String	getDescription() Simple one or two line description
java.net.URL[]	getDocs() Documentation URL list.
(package private) java.util.Map<java.lang.String,QueryElevationComponent.ElevationObj>	getElevationMap(org.apache.lucene.index.IndexReader reader, SolrCore core)
java.lang.String	getSource() CVS Source, SVN Source, etc
java.lang.String	getSourceId() CVS Id, SVN Id, etc
java.lang.String	getVersion() Simple common usage version, e.g.
void	inform(SolrCore core)
void	init(NamedList args)
private java.util.Map<java.lang.String,QueryElevationComponent.ElevationObj>	loadElevationMap(Config cfg)
void	prepare(ResponseBuilder rb) Prepare the response.
void	process(ResponseBuilder rb) Process the request for this component
(package private) void	setTopQueryResults(org.apache.lucene.index.IndexReader reader, java.lang.String query, java.lang.String[] ids, java.lang.String[] ex) Helpful for testing without loading config.xml

Methods inherited from class org.apache.solr.handler.component.SearchComponent

distributedProcess, finishStage, getCategory, getName, getStatistics, handleResponses, modifyRequest

Methods inherited from class java.lang.Object

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

Field Detail

log

private static org.slf4j.Logger log

FIELD_TYPE

static final java.lang.String FIELD_TYPE

See Also:

Constant Field Values

CONFIG_FILE

static final java.lang.String CONFIG_FILE

See Also:

Constant Field Values

EXCLUDE

static final java.lang.String EXCLUDE

See Also:

Constant Field Values

initArgs

private SolrParams initArgs

analyzer

private org.apache.lucene.analysis.Analyzer analyzer

idField

private java.lang.String idField

idSchemaFT

private FieldType idSchemaFT

forceElevation

boolean forceElevation

elevationCache

final java.util.Map<org.apache.lucene.index.IndexReader,java.util.Map<java.lang.String,QueryElevationComponent.ElevationObj>> elevationCache

Constructor Detail

QueryElevationComponent

public QueryElevationComponent()

Method Detail

init

public void init(NamedList args)

Specified by:

init in interface NamedListInitializedPlugin

Overrides:

init in class SearchComponent

inform

public void inform(SolrCore core)

Specified by:

inform in interface SolrCoreAware

getElevationMap

java.util.Map<java.lang.String,QueryElevationComponent.ElevationObj> getElevationMap(org.apache.lucene.index.IndexReader reader,
                                                                                     SolrCore core)
                                                                              throws java.lang.Exception

Throws:

java.lang.Exception

loadElevationMap

private java.util.Map<java.lang.String,QueryElevationComponent.ElevationObj> loadElevationMap(Config cfg)
                                                                                       throws java.io.IOException

Throws:

java.io.IOException

setTopQueryResults

void setTopQueryResults(org.apache.lucene.index.IndexReader reader,
                        java.lang.String query,
                        java.lang.String[] ids,
                        java.lang.String[] ex)
                 throws java.io.IOException

Helpful for testing without loading config.xml

Throws:

java.io.IOException

getAnalyzedQuery

java.lang.String getAnalyzedQuery(java.lang.String query)
                           throws java.io.IOException

Throws:

java.io.IOException

prepare

public void prepare(ResponseBuilder rb)
             throws java.io.IOException

Description copied from class: SearchComponent

Prepare the response. Guaranteed to be called before any SearchComponent SearchComponent.process(org.apache.solr.handler.component.ResponseBuilder) method. Called for every incoming request. The place to do initialization that is request dependent.

Specified by:

prepare in class SearchComponent

Parameters:

rb - The ResponseBuilder

Throws:

java.io.IOException

process

public void process(ResponseBuilder rb)
             throws java.io.IOException

Description copied from class: SearchComponent

Process the request for this component

Specified by:

process in class SearchComponent

Parameters:

rb - The ResponseBuilder

Throws:

java.io.IOException

getDescription

public java.lang.String getDescription()

Description copied from interface: SolrInfoMBean

Simple one or two line description

Specified by:

getDescription in interface SolrInfoMBean

Specified by:

getDescription in class SearchComponent

getVersion

public java.lang.String getVersion()

Description copied from interface: SolrInfoMBean

Simple common usage version, e.g. 2.0

Specified by:

getVersion in interface SolrInfoMBean

Specified by:

getVersion in class SearchComponent

getSourceId

public java.lang.String getSourceId()

Description copied from interface: SolrInfoMBean

CVS Id, SVN Id, etc

Specified by:

getSourceId in interface SolrInfoMBean

Specified by:

getSourceId in class SearchComponent

getSource

public java.lang.String getSource()

Description copied from interface: SolrInfoMBean

CVS Source, SVN Source, etc

Specified by:

getSource in interface SolrInfoMBean

Specified by:

getSource in class SearchComponent

getDocs

public java.net.URL[] getDocs()

Description copied from interface: SolrInfoMBean

Documentation URL list.

Suggested documentation URLs: Homepage for sponsoring project, FAQ on class usage, Design doc for class, Wiki, bug reporting URL, etc...

Specified by:

getDocs in interface SolrInfoMBean

Overrides:

getDocs in class SearchComponent