Package org.carrot2.core

This package contains the specification of core classes and implementations of the Carrot² framework (components, processes).

See:
Description

Interface Summary

LocalComponent	Local component interface identifies objects that can be assembled in "local" query processing chains.
LocalComponentFactory	Objects implementing this interface can produce new instances of LocalComponent objects.
LocalController	A container for local processes and local components.
LocalControllerContext	An interface providing access to several utility methods of a local controller (local components container object).
LocalFilterComponent	Local filters transform or enrich the data stream and are placed in between input and output components in a processing chain.
LocalInputComponent	Local input components generate the initial data-related method calls to successive components in a processing chain in response to a query, passed from a LocalProcess object.
LocalOutputComponent	Output components act in response to the result of processing of a query.
LocalProcess	A local process embodies the logic needed to process queries and assemble componenents in a processing chain.
ProcessingResult	Provides results of query processing.
RequestContext	A request context object functions as a medium of communication between local components linked in a processing chain.

Class Summary

CapabilityMatchVerifier	An implementation of capability match verifier.
LocalComponentBase	A reference implementation of a LocalComponentinterface.
LocalControllerBase	A complete base implementation of the LocalController interface.
LocalControllerBase.Result	Default implementation of the ProcessingResult interface.
LocalFilterComponentBase	A baseline implementation of a LocalFilterComponent.
LocalInputComponentBase	A baseline implementation of a LocalInputComponent.
LocalOutputComponentBase	A baseline implementation of a LocalOutputComponent interface.
LocalProcessBase	Provides a reference implementation of a LocalProcess interface.
PoolableComponentFactory	An adapter between LocalComponentFactory and PoolableObjectFactory.
RequestContextBase	A complete base implementation of the RequestContext interface used by the LocalControllerBase.

Exception Summary

DuplicatedKeyException	Thrown when addition of a key-value pair failed because the key already exist in the container.
InitializationException	An exception thrown when a process cannot be initialized due to some problem or incompatibility.
MissingComponentException	An exception thrown if an operation has been attempted on a component identifier that is not associated with any factory.
MissingProcessException	An exception thrown if an operation has been attempted on a process identifier that is not associated with any factory.
ProcessingException	An exception that may be thrown during processing of a query.
UncheckedProcessingException	A subclass of ProcessingException which signals the process ended with a runtime exception (premature exit from the processing chain).

Package org.carrot2.core Description

This package contains the specification of core classes and implementations of the Carrot² framework (components, processes).