org.carrot2.input.alexa
Class AlexaInputComponent

java.lang.Object
  org.carrot2.core.LocalComponentBase
      org.carrot2.core.LocalInputComponentBase
          org.carrot2.input.alexa.AlexaInputComponent

All Implemented Interfaces:

RawDocumentsProducer, LocalComponent, LocalInputComponent

public final class AlexaInputComponent
extends LocalInputComponentBase
implements RawDocumentsProducer

An input component for Alexa Search. This component was donated to the Carrot2 project by deepVertical.

Author:

Dawid Weiss

Field Summary

static int	MAXIMUM_RESULTS Maximum number of results (starting offset + length).
static int	MAXIMUM_RESULTS_PERQUERY Maximum allowed results per query.
static String	PROPERTY_DISABLE_PARALLEL_MODE If any value is set in the request context under this key, full parallel mode is disabled.

Fields inherited from class org.carrot2.core.LocalInputComponentBase

next

Fields inherited from interface org.carrot2.core.clustering.RawDocumentsProducer

PARAM_ORIGINAL_RAW_CLUSTERS, PROPERTY_CATID

Fields inherited from interface org.carrot2.core.LocalInputComponent

PARAM_QUERY, PARAM_REQUESTED_RESULTS, PARAM_START_AT, PARAM_TOTAL_MATCHING_DOCUMENTS

Constructor Summary

AlexaInputComponent(String accessKey, String secretKey)
Create an input component with the default service descriptor and a custom application identifier.

Method Summary

Set	getComponentCapabilities() Provides an implementation that has no capabilities (an empty set).
String	getName() The default implementation returning null.
Set	getRequiredSuccessorCapabilities() Provides an implementation that requires no capabilities of the successor component.
void	setNext(LocalComponent next) The default implementation sets the LocalInputComponentBase.next field and verifies the contract in LocalFilterComponent.setNext(LocalComponent)
void	setParallelMode(boolean value) Enables or disables full parallel mode of search results fetching.
void	setQuery(String query) Sets the query for the current request.
void	startProcessing(RequestContext requestContext) The default implementation invokes protected LocalInputComponentBase.validate() method first to verify preconditions.

Methods inherited from class org.carrot2.core.LocalInputComponentBase

endProcessing, flushResources, getRequestedResults, processingErrorOccurred, validate

Methods inherited from class org.carrot2.core.LocalComponentBase

getDescription, getIntFromRequestContext, getProperty, getRequiredPredecessorCapabilities, init, setProperty, toSet, toSet, toSet

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.LocalComponent

getDescription, getRequiredPredecessorCapabilities, init, setProperty

Field Detail

PROPERTY_DISABLE_PARALLEL_MODE

public static final String PROPERTY_DISABLE_PARALLEL_MODE

If any value is set in the request context under this key, full parallel mode is disabled.

See Also:

ParallelFetcher.setParallelMode(boolean), Constant Field Values

MAXIMUM_RESULTS_PERQUERY

public static final int MAXIMUM_RESULTS_PERQUERY

Maximum allowed results per query.

See Also:

Constant Field Values

MAXIMUM_RESULTS

public static final int MAXIMUM_RESULTS

Maximum number of results (starting offset + length).

See Also:

Constant Field Values

Constructor Detail

AlexaInputComponent

public AlexaInputComponent(String accessKey,
                           String secretKey)

Create an input component with the default service descriptor and a custom application identifier.

Method Detail

setQuery

public void setQuery(String query)

Description copied from interface: LocalInputComponent

Sets the query for the current request. The format of the query depends on the component used.

Specified by:

setQuery in interface LocalInputComponent

Parameters:

query - A String with the query.

getComponentCapabilities

public Set getComponentCapabilities()

Description copied from class: LocalComponentBase

Provides an implementation that has no capabilities (an empty set).

Specified by:

getComponentCapabilities in interface LocalComponent

Overrides:

getComponentCapabilities in class LocalComponentBase

Returns:

A Setobject with capabilities. The object returned may be empty, but should never be null.

getRequiredSuccessorCapabilities

public Set getRequiredSuccessorCapabilities()

Description copied from class: LocalComponentBase

Provides an implementation that requires no capabilities of the successor component.

Specified by:

getRequiredSuccessorCapabilities in interface LocalComponent

Overrides:

getRequiredSuccessorCapabilities in class LocalComponentBase

Returns:

A Setobject with capabilities. The object returned may be empty, but should never be null.

setNext

public void setNext(LocalComponent next)

Description copied from class: LocalInputComponentBase

The default implementation sets the LocalInputComponentBase.next field and verifies the contract in LocalFilterComponent.setNext(LocalComponent)

Specified by:

setNext in interface LocalInputComponent

Overrides:

setNext in class LocalInputComponentBase

Parameters:

next - A reference to an instance of LocalComponent that is the successor component in a processing chain assembled for the execution of a single query.

startProcessing

public void startProcessing(RequestContext requestContext)
                     throws ProcessingException

Description copied from class: LocalInputComponentBase

The default implementation invokes protected LocalInputComponentBase.validate() method first to verify preconditions. Then it invokes startProcessing(requestContext) method on the successor component.

Specified by:

startProcessing in interface LocalComponent

Overrides:

startProcessing in class LocalInputComponentBase

Parameters:

requestContext - A RequestContextinterface instance passed by the container processing the query. The context may be used to retrieve parameters associated with the query (see RequestContext.getRequestParameters() method).

Throws:

ProcessingException - Thrown if the component encountered a problem in processing the query. May also be thrown from a chained successor component.

getName

public String getName()

Description copied from class: LocalComponentBase

The default implementation returning null. In concrete implementations override this method to provide the appropriate name.

Specified by:

getName in interface LocalComponent

Overrides:

getName in class LocalComponentBase

Returns:

null name

setParallelMode

public void setParallelMode(boolean value)

Enables or disables full parallel mode of search results fetching.