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.

See Also:
See Lucene's TermEnum class

Nested Class Summary
 
Nested classes/interfaces inherited from interface org.apache.solr.core.SolrInfoMBean
SolrInfoMBean.Category
 
Field Summary
static int UNLIMITED_MAX_COUNT
           
 
Constructor Summary
TermsComponent()
           
 
Method Summary
 String getDescription()
          Simple one or two line description
 String getSource()
          CVS Source, SVN Source, etc
 String getSourceId()
          CVS Id, SVN Id, etc
 String getVersion()
          Simple common usage version, e.g.
 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
distributedProcess, finishStage, getCategory, getDocs, getName, getStatistics, handleResponses, init, modifyRequest
 
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
Constructor Detail

TermsComponent

public TermsComponent()
Method Detail

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

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

getVersion

public 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 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 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 © 2010 Apache Software Foundation. All Rights Reserved.