org.carrot2.source

Class SearchEngineBase

java.lang.Object

org.carrot2.core.ProcessingComponentBase

org.carrot2.source.SearchEngineBase

All Implemented Interfaces:

IDocumentSource, IProcessingComponent

Direct Known Subclasses:

MultipageSearchEngine, SimpleSearchEngine

@Bindable(prefix="SearchEngineBase",
          inherit=CommonAttributes.class)
public abstract class SearchEngineBase
extends ProcessingComponentBase
implements IDocumentSource

A base class facilitating implementation of IDocumentSources wrapping external search engines with remote/ network-based interfaces. The base class defines the common attribute fields used by more specific base classes and concrete implementations.

See Also:

SimpleSearchEngine, MultipageSearchEngine

Field Summary

Fields

Modifier and Type	Field and Description
boolean	compressed Indicates whether the search engine returned a compressed result stream.
Collection<Document>	documents
protected static String	POSTPROCESSING Group name.
String	query
int	results
long	resultsTotal
static String	SERVICE Group name.
int	start
SearchEngineStats	statistics This component usage statistics.

Constructor Summary

Constructors

Constructor and Description
SearchEngineBase()

Method Summary

Modifier and Type	Method and Description
protected void	afterFetch(SearchEngineResponse response) Called after a single search engine response has been fetched.
protected static void	clean(SearchEngineResponse response, boolean keepHighlights, String... fields) Unescape HTML entities and tags from a given set of fields of all documents in the provided response.
protected static String	urlEncode(String string) URL-encodes a string into UTF-8.

Methods inherited from class org.carrot2.core.ProcessingComponentBase

afterProcessing, beforeProcessing, dispose, getContext, getSharedExecutor, init, process

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, beforeProcessing, dispose, init, process

Field Detail

SERVICE

public static final String SERVICE

Group name.

See Also:

Constant Field Values

POSTPROCESSING

protected static final String POSTPROCESSING

Group name.

See Also:

Constant Field Values

start

@Processing
 @Input
 @Attribute(key="start",
           inherit=true)
 @IntRange(min=0)
public int start

results

@Processing
 @Input
 @Attribute(key="results",
           inherit=true)
 @IntRange(min=1)
public int results

query

@Processing
 @Input
 @Attribute(key="query",
           inherit=true)
 @Required
public String query

resultsTotal

@Processing
 @Output
 @Attribute(key="results-total",
           inherit=true)
public long resultsTotal

documents

@Processing
 @Output
 @Attribute(key="documents",
           inherit=true)
 @Internal
public Collection<Document> documents

compressed

@Processing
 @Output
 @Attribute
 @Label(value="Compression used")
 @Group(value="Search result information")
public boolean compressed

Indicates whether the search engine returned a compressed result stream.

statistics

public SearchEngineStats statistics

This component usage statistics.

Constructor Detail

SearchEngineBase

public SearchEngineBase()

Method Detail

clean

protected static void clean(SearchEngineResponse response,
                            boolean keepHighlights,
                            String... fields)

Unescape HTML entities and tags from a given set of fields of all documents in the provided response.

Parameters:

response - the search engine response to clean

keepHighlights - set to true to keep query terms highlights

fields - names of fields to clean

afterFetch

protected void afterFetch(SearchEngineResponse response)

Called after a single search engine response has been fetched. The concrete implementation may want to override this empty implementation to e.g., clean or otherwise postprocess the returned results.

urlEncode

protected static final String urlEncode(String string)

URL-encodes a string into UTF-8.