SMILA (incubation) API documentation

org.eclipse.smila.solr.search
Class SolrSearchPipelet

java.lang.Object
  extended by org.eclipse.smila.solr.search.SolrSearchPipelet
All Implemented Interfaces:
Pipelet

public class SolrSearchPipelet
extends java.lang.Object
implements Pipelet

This pipelet integrates the solr search via the SolrJ client using the binary protocol by default.


Constructor Summary
SolrSearchPipelet()
           
 
Method Summary
 void configure(AnyMap config)
          set configuration of pipelet.
 SolrServerManager getSolrManager()
          Get SolrManager.
 java.lang.String[] process(Blackboard blackboard, java.lang.String[] queryIds)
          process records on Blackboard service.
 void setSolrManager(SolrServerManager solrManager)
          Set SolrManager.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SolrSearchPipelet

public SolrSearchPipelet()
Method Detail

configure

public void configure(AnyMap config)
               throws ProcessingException
set configuration of pipelet. called once after instantiation before the pipelet is actually used in a workflow.

Specified by:
configure in interface Pipelet
Parameters:
config - configuration of pipelet.
Throws:
ProcessingException - configuration is not applicable for pipelet (missing properties, wrong datatypes)
See Also:
Pipelet.configure(org.eclipse.smila.datamodel.AnyMap)

process

public java.lang.String[] process(Blackboard blackboard,
                                  java.lang.String[] queryIds)
                           throws ProcessingException
process records on Blackboard service.

Specified by:
process in interface Pipelet
Parameters:
blackboard - Blackboard service managing the records.
queryIds - Ids of records to process.
Returns:
Ids of result records. By default this should be the same as the passed in recordIds unless there is a specific reason not to do so. This is especially true for SearchPiplets.
Throws:
ProcessingException - error during processing.
See Also:
Pipelet.process(org.eclipse.smila.blackboard.Blackboard, java.lang.String[])

setSolrManager

public void setSolrManager(SolrServerManager solrManager)
Set SolrManager.

Parameters:
solrManager - the SolrManager.

getSolrManager

public SolrServerManager getSolrManager()
Get SolrManager.

Returns:
the SolrManager.

SMILA (incubation) API documentation