org.carrot2.source.solr

Class SolrDocumentSource

java.lang.Object

org.carrot2.core.ProcessingComponentBase

org.carrot2.source.SearchEngineBase

org.carrot2.source.SimpleSearchEngine

org.carrot2.source.xml.RemoteXmlSimpleSearchEngineBase

org.carrot2.source.solr.SolrDocumentSource

All Implemented Interfaces:

IDocumentSource, IProcessingComponent

@Bindable(prefix="SolrDocumentSource")
public class SolrDocumentSource
extends RemoteXmlSimpleSearchEngineBase

Fetches documents from an instance of Solr.

See Also:

Apache SOLR

Field Summary

Fields

Modifier and Type	Field and Description
List<Cluster>	clusters If readClusters is true and clusters are present in the input XML, they will be deserialized and exposed to components further down the processing chain.
boolean	copyFields Copy Solr fields from the search result to Carrot2 Document instances (as fields).
protected static String	FIELD_MAPPING
boolean	readClusters If clusters are present in the Solr output they will be read and exposed to components further down the processing chain.
String	serviceUrlBase Solr service URL base.
String	solrFilterQuery Filter query appended to serviceUrlBase.
String	solrIdFieldName Document identifier field name (specified in Solr schema).
String	solrSummaryFieldName Summary field name.
String	solrTitleFieldName Title field name.
String	solrUrlFieldName URL field name.
IResource	solrXsltAdapter Provides a custom XSLT stylesheet for converting from Solr's output to an XML format parsed by Carrot2.
boolean	useHighlighterOutput If highlighter fragments are present in the Solr output they will be used (and preferred) over full field content.

Fields inherited from class org.carrot2.source.xml.RemoteXmlSimpleSearchEngineBase

redirectStrategy, xmlDocumentSourceHelper

Fields inherited from class org.carrot2.source.SearchEngineBase

compressed, documents, POSTPROCESSING, query, results, resultsTotal, SERVICE, start, statistics

Constructor Summary

Constructors

Constructor and Description
SolrDocumentSource()

Method Summary

Modifier and Type	Method and Description
protected void	afterFetch(SearchEngineResponse response, ProcessingResult processingResult) Invoked after the response has been partially parsed and ProcessingResult deserialized.
protected String	buildServiceUrl() Builds the URL from which XML stream will be fetched.
protected Map<String,String>	getXsltParameters() Returns parameters to be passed to the XSLT transformer.
protected IResource	getXsltResource() Returns the XSLT stylesheet that transforms the custom XML into Carrot2 compliant XML.

Methods inherited from class org.carrot2.source.xml.RemoteXmlSimpleSearchEngineBase

beforeProcessing, fetchSearchResponse, getPassword, getUser, init, loadProcessingResult

Methods inherited from class org.carrot2.source.SimpleSearchEngine

process

Methods inherited from class org.carrot2.source.SearchEngineBase

afterFetch, clean, urlEncode

Methods inherited from class org.carrot2.core.ProcessingComponentBase

afterProcessing, dispose, getContext, getSharedExecutor

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.carrot2.core.IProcessingComponent

afterProcessing, dispose

Field Detail

FIELD_MAPPING

protected static final String FIELD_MAPPING

See Also:

Constant Field Values

serviceUrlBase

@Input
 @Processing
 @Attribute
 @Label(value="Service URL")
 @Level(value=ADVANCED)
 @Group(value="Service")
public String serviceUrlBase

Solr service URL base. The URL base can contain additional Solr parameters, for example: http://localhost:8983/solr/select?fq=timestemp:[NOW-24HOUR TO NOW]

solrFilterQuery

@Input
 @Processing
 @Attribute
 @Label(value="Filter query")
 @Level(value=MEDIUM)
 @Group(value="Service")
public String solrFilterQuery

Filter query appended to serviceUrlBase.

solrTitleFieldName

@Input
 @Processing
 @Attribute
 @Label(value="Title field name")
 @Level(value=MEDIUM)
 @Group(value="Index field mapping")
public String solrTitleFieldName

Title field name. Name of the Solr field that will provide document titles.

solrSummaryFieldName

@Input
 @Processing
 @Attribute
 @Label(value="Summary field name")
 @Level(value=MEDIUM)
 @Group(value="Index field mapping")
public String solrSummaryFieldName

Summary field name. Name of the Solr field that will provide document summary.

solrUrlFieldName

@Input
 @Processing
 @Attribute
 @Label(value="URL field name")
 @Level(value=MEDIUM)
 @Group(value="Index field mapping")
public String solrUrlFieldName

URL field name. Name of the Solr field that will provide document URLs.

solrIdFieldName

@Input
 @Processing
 @Attribute
 @Label(value="ID field name")
 @Level(value=MEDIUM)
 @Group(value="Index field mapping")
public String solrIdFieldName

Document identifier field name (specified in Solr schema). This field is necessary to connect Solr-side clusters or highlighter output to documents.

solrXsltAdapter

@Input
 @Attribute
 @Label(value="Custom XSLT adapter from Solr to Carrot2 format")
 @Level(value=ADVANCED)
 @Group(value="Index field mapping")
public IResource solrXsltAdapter

Provides a custom XSLT stylesheet for converting from Solr's output to an XML format parsed by Carrot2. For performance reasons this attribute can be provided at initialization time only (no processing-time overrides).

readClusters

@Input
 @Processing
 @Attribute
 @Label(value="Read Solr clusters if present")
 @Level(value=BASIC)
 @Group(value="Index field mapping")
public boolean readClusters

If clusters are present in the Solr output they will be read and exposed to components further down the processing chain. Note that solrIdFieldName is required to match document references.

useHighlighterOutput

@Input
 @Processing
 @Attribute
 @Label(value="Use highlighter output if present")
 @Level(value=BASIC)
 @Group(value="Index field mapping")
public boolean useHighlighterOutput

If highlighter fragments are present in the Solr output they will be used (and preferred) over full field content. This may be used to decrease the memory required for clustering. In general if highlighter is used the contents of full fields won't be emitted from Solr though (because it makes little sense).

Setting this option to false will disable using the highlighter output entirely.

copyFields

@Input
 @Processing
 @Attribute
 @Label(value="Copy Solr document fields")
 @Level(value=ADVANCED)
 @Group(value="Index field mapping")
public boolean copyFields

Copy Solr fields from the search result to Carrot2 Document instances (as fields).

clusters

@Processing
 @Input
 @Output
 @Internal
 @Attribute(key="clusters")
 @Label(value="Clusters")
 @Level(value=BASIC)
 @Group(value="Search result information")
public List<Cluster> clusters

If readClusters is true and clusters are present in the input XML, they will be deserialized and exposed to components further down the processing chain.

Constructor Detail

SolrDocumentSource

public SolrDocumentSource()

Method Detail

afterFetch

protected void afterFetch(SearchEngineResponse response,
                          ProcessingResult processingResult)

Description copied from class: RemoteXmlSimpleSearchEngineBase

Invoked after the response has been partially parsed and ProcessingResult deserialized.

Overrides:

afterFetch in class RemoteXmlSimpleSearchEngineBase

buildServiceUrl

protected String buildServiceUrl()

Description copied from class: RemoteXmlSimpleSearchEngineBase

Builds the URL from which XML stream will be fetched. This method will be called once per request processing cycle. Processing-time attributes will have been bound before this method the call to this method.

Specified by:

buildServiceUrl in class RemoteXmlSimpleSearchEngineBase

getXsltResource

protected IResource getXsltResource()

Description copied from class: RemoteXmlSimpleSearchEngineBase

Returns the XSLT stylesheet that transforms the custom XML into Carrot2 compliant XML. This method will be called once during component initialization. Initialization time attributes will have been bound before the call to this method.

Specified by:

getXsltResource in class RemoteXmlSimpleSearchEngineBase

getXsltParameters

protected Map<String,String> getXsltParameters()

Description copied from class: RemoteXmlSimpleSearchEngineBase

Returns parameters to be passed to the XSLT transformer. This method will be called once per processing cycle. Processing-time attributes will have been bound before this method the call to this method. The default implementation returns null.

Overrides:

getXsltParameters in class RemoteXmlSimpleSearchEngineBase