org.carrot2.source.etools

Class EToolsDocumentSource

java.lang.Object

org.carrot2.core.ProcessingComponentBase

org.carrot2.source.SearchEngineBase

org.carrot2.source.SimpleSearchEngine

org.carrot2.source.xml.RemoteXmlSimpleSearchEngineBase

org.carrot2.source.etools.EToolsDocumentSource

All Implemented Interfaces:

IDocumentSource, IProcessingComponent

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

A Carrot2 input component for the eTools service (https://www.etools.ch). For commercial licensing of the eTools feed, please e-mail: contact@comcepta.com.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EToolsDocumentSource.Country Enumeration for countries supported by EToolsDocumentSource, see country.
static class	EToolsDocumentSource.DataSources Enumeration for the data sources modes supported by EToolsDocumentSource, see dataSources.
static class	EToolsDocumentSource.Language Enumeration for languages supported by EToolsDocumentSource, see language.

Field Summary

Fields

Modifier and Type	Field and Description
EToolsDocumentSource.Country	country Determines the country of origin for the returned search results.
String	customerId eTools customer identifier.
EToolsDocumentSource.DataSources	dataSources Determines which data sources to search.
EToolsDocumentSource.Language	language Determines the language of the returned search results.
String	partnerId eTools partner identifier.
boolean	safeSearch If enabled, excludes offensive content from the results.
String	serviceUrlBase Base URL for the eTools service
String	site Site URL or comma-separated list of site site URLs to which the returned results should be restricted.
int	timeout Maximum time in milliseconds to wait for all data sources to return results.

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
EToolsDocumentSource()

Method Summary

Modifier and Type	Method and Description
protected void	afterFetch(SearchEngineResponse response) Called after a single search engine response has been fetched.
void	beforeProcessing() Invoked after the attributes marked with Processing and Input annotations have been bound, but before a call to IProcessingComponent.process().
protected String	buildServiceUrl() Builds the URL from which XML stream will be fetched.
protected SearchEngineResponse	fetchSearchResponse() Requests and returns results from the underlying search engine.
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

afterFetch, getPassword, getUser, getXsltParameters, init, loadProcessingResult

Methods inherited from class org.carrot2.source.SimpleSearchEngine

process

Methods inherited from class org.carrot2.source.SearchEngineBase

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

serviceUrlBase

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

Base URL for the eTools service

country

@Input
 @Processing
 @Attribute
 @Label(value="Country")
 @Level(value=MEDIUM)
 @Group(value="Filtering")
public EToolsDocumentSource.Country country

Determines the country of origin for the returned search results.

language

@Input
 @Processing
 @Attribute
 @Label(value="Language")
 @Level(value=MEDIUM)
 @Group(value="Filtering")
public EToolsDocumentSource.Language language

Determines the language of the returned search results.

timeout

@Input
 @Processing
 @Attribute
 @IntRange(min=0)
 @Label(value="Timeout")
 @Level(value=ADVANCED)
 @Group(value="Service")
public int timeout

Maximum time in milliseconds to wait for all data sources to return results.

dataSources

@Input
 @Processing
 @Attribute
 @Label(value="Data sources")
 @Level(value=ADVANCED)
 @Group(value="Service")
public EToolsDocumentSource.DataSources dataSources

Determines which data sources to search.

safeSearch

@Input
 @Processing
 @Attribute
 @Label(value="Safe search")
 @Level(value=BASIC)
 @Group(value="Filtering")
public boolean safeSearch

If enabled, excludes offensive content from the results.

site

@Input
 @Processing
 @Attribute
 @Label(value="Site restriction")
 @Level(value=ADVANCED)
 @Group(value="Filtering")
public String site

Site URL or comma-separated list of site site URLs to which the returned results should be restricted. For example: wikipedia.org or en.wikipedia.org,de.wikipedia.org. Very larger lists of site restrictions (larger than 2000 characters) may result in a processing exception.

partnerId

@Input
 @Processing
 @Attribute
 @Internal
 @Label(value="Partner ID")
 @Level(value=ADVANCED)
 @Group(value="Service")
public String partnerId

eTools partner identifier. If you have commercial arrangements with eTools, specify your partner id here.

customerId

@Input
 @Processing
 @Attribute
 @Label(value="Customer ID")
 @Level(value=MEDIUM)
 @Group(value="Service")
public String customerId

eTools customer identifier. For commercial use of eTools, please e-mail: contact@comcepta.com to obtain your customer identifier.

Constructor Detail

EToolsDocumentSource

public EToolsDocumentSource()

Method Detail

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

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

fetchSearchResponse

protected SearchEngineResponse fetchSearchResponse()
                                            throws Exception

Description copied from class: SimpleSearchEngine

Requests and returns results from the underlying search engine.

Overrides:

fetchSearchResponse in class RemoteXmlSimpleSearchEngineBase

Throws:

Exception - in case of problems with the underlying search engine

beforeProcessing

public void beforeProcessing()
                      throws ProcessingException

Description copied from interface: IProcessingComponent

Invoked after the attributes marked with Processing and Input annotations have been bound, but before a call to IProcessingComponent.process(). In this method, the processing component should perform any initializations based on the runtime attributes. This method is called once per request.

Specified by:

beforeProcessing in interface IProcessingComponent

Overrides:

beforeProcessing in class RemoteXmlSimpleSearchEngineBase

Throws:

ProcessingException - when processing cannot start, e.g. because some attributes were not bound. If thrown, the IProcessingComponent.process() method will not be called. Instead, IProcessingComponent.afterProcessing() will be called immediately to allow clean-up actions, and the component will be ready to accept further requests or to be disposed of. Finally, the exception will be rethrown from the controller method that caused the component to perform processing.

afterFetch

protected void afterFetch(SearchEngineResponse response)

Description copied from class: SearchEngineBase

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.

Overrides:

afterFetch in class SearchEngineBase