org.apache.solr.handler.component
Class TermsComponent

java.lang.Object
  extended by org.apache.solr.handler.component.SearchComponent
      extended by org.apache.solr.handler.component.TermsComponent
All Implemented Interfaces:
SolrInfoMBean, NamedListInitializedPlugin

public class TermsComponent
extends SearchComponent

Return TermEnum information, useful for things like auto suggest.

 <searchComponent name="termsComponent" class="solr.TermsComponent"/>
 
 <requestHandler name="/terms" class="solr.SearchHandler">
   <lst name="defaults">
     <bool name="terms">true</bool>
   </lst>
   <arr name="components">
     <str>termsComponent</str>
   </arr>
 </requestHandler>

See Also:
See Lucene's TermEnum class

Nested Class Summary
 class TermsComponent.TermsHelper
           
 
Nested classes/interfaces inherited from interface org.apache.solr.core.SolrInfoMBean
SolrInfoMBean.Category
 
Field Summary
static String COMPONENT_NAME
           
static int UNLIMITED_MAX_COUNT
           
 
Constructor Summary
TermsComponent()
           
 
Method Summary
 int distributedProcess(ResponseBuilder rb)
          Process for a distributed search.
 void finishStage(ResponseBuilder rb)
          Called after all responses have been received for this stage.
 String getDescription()
          Simple one or two line description
 String getSource()
          CVS Source, SVN Source, etc
 void handleResponses(ResponseBuilder rb, ShardRequest sreq)
          Called after all responses for a single request were received
 void prepare(ResponseBuilder rb)
          Prepare the response.
 void process(ResponseBuilder rb)
          Process the request for this component
 
Methods inherited from class org.apache.solr.handler.component.SearchComponent
getCategory, getDocs, getName, getStatistics, getVersion, init, modifyRequest, setName
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

UNLIMITED_MAX_COUNT

public static final int UNLIMITED_MAX_COUNT
See Also:
Constant Field Values

COMPONENT_NAME

public static final String COMPONENT_NAME
See Also:
Constant Field Values
Constructor Detail

TermsComponent

public TermsComponent()
Method Detail

prepare

public void prepare(ResponseBuilder rb)
             throws 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:
IOException - If there is a low-level I/O error.

process

public void process(ResponseBuilder rb)
             throws IOException
Description copied from class: SearchComponent
Process the request for this component

Specified by:
process in class SearchComponent
Parameters:
rb - The ResponseBuilder
Throws:
IOException - If there is a low-level I/O error.

distributedProcess

public int distributedProcess(ResponseBuilder rb)
                       throws IOException
Description copied from class: SearchComponent
Process for a distributed search.

Overrides:
distributedProcess in class SearchComponent
Returns:
the next stage for this component
Throws:
IOException

handleResponses

public void handleResponses(ResponseBuilder rb,
                            ShardRequest sreq)
Description copied from class: SearchComponent
Called after all responses for a single request were received

Overrides:
handleResponses in class SearchComponent

finishStage

public void finishStage(ResponseBuilder rb)
Description copied from class: SearchComponent
Called after all responses have been received for this stage. Useful when different requests are sent to each shard.

Overrides:
finishStage in class SearchComponent

getSource

public String getSource()
Description copied from interface: SolrInfoMBean
CVS Source, SVN Source, etc

Specified by:
getSource in interface SolrInfoMBean
Specified by:
getSource in class SearchComponent

getDescription

public 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


Copyright © 2000-2014 Apache Software Foundation. All Rights Reserved.