org.carrot2.core.impl
Class ArrayInputComponent

java.lang.Object
  org.carrot2.core.LocalComponentBase
      org.carrot2.core.LocalInputComponentBase
          org.carrot2.core.impl.ArrayInputComponent

All Implemented Interfaces:

RawDocumentsProducer, LocalComponent, LocalInputComponent

Direct Known Subclasses:

RawDocumentsProducerLocalInputComponent

public class ArrayInputComponent
extends LocalInputComponentBase
implements RawDocumentsProducer

Implements a dummy input component, with capabilities to send:

• RawDocuments provided in the PARAM_SOURCE_RAW_DOCUMENTS request parameter,
• RawClusters provided in the PARAM_SOURCE_RAW_CLUSTERS request parameter,

to components down the processing chain.

Field Summary

static String	PARAM_SOURCE_RAW_CLUSTERS This property must be set to a List or a Iterator over a list of RawClusters to be propagated down the processing chain.
static String	PARAM_SOURCE_RAW_DOCUMENTS This property must be set to a List or a Iterator over a list of RawDocuments to be propagated down the processing chain.

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

ArrayInputComponent()

Method Summary

void	flushResources() The default implementation invokes flushResources() method on the successor component.
Set	getComponentCapabilities() Provides an implementation that has no capabilities (an empty set).
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	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, getRequestedResults, processingErrorOccurred, validate

Methods inherited from class org.carrot2.core.LocalComponentBase

getDescription, getIntFromRequestContext, getName, 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, getName, getRequiredPredecessorCapabilities, init, setProperty

Field Detail

PARAM_SOURCE_RAW_DOCUMENTS

public static final String PARAM_SOURCE_RAW_DOCUMENTS

This property must be set to a List or a Iterator over a list of RawDocuments to be propagated down the processing chain.

See Also:

Constant Field Values

PARAM_SOURCE_RAW_CLUSTERS

public static final String PARAM_SOURCE_RAW_CLUSTERS

This property must be set to a List or a Iterator over a list of RawClusters to be propagated down the processing chain.

See Also:

Constant Field Values

Constructor Detail

ArrayInputComponent

public ArrayInputComponent()

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.

flushResources

public void flushResources()

Description copied from class: LocalInputComponentBase

The default implementation invokes flushResources() method on the successor component.

Specified by:

flushResources in interface LocalComponent

Overrides:

flushResources in class LocalInputComponentBase

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.