Package org.carrot2.core

Definitions of Carrot2 core interfaces and their implementations.

See:
          Description

Interface Summary
Document.IDocumentSerializationListener Enables listening to events related to XML/JSON serialization of Documents.
IClusteringAlgorithm A marker interface for processing components performing clustering of documents.
IControllerContext The controller context is a map of key-value pairs, attached to an initialized Controller instance.
IControllerContextListener A listener receiving events related to a IControllerContext.
IDocumentSource A marker interface for processing components providing documents for further processing.
IProcessingComponent Defines the life cycle of a Carrot2 processing component.
IProcessingComponentManager A component management strategy used by a Controller.
 

Class Summary
CachingProcessingComponentManager An IProcessingComponentManager that implements processing results caching functionality.
Cluster A cluster (group) of Documents.
ClusterWithParent Wraps a Cluster to add information about the cluster's parent cluster, if any.
Controller A controller implementing the life cycle described in IProcessingComponent.
ControllerContextListenerAdapter An empty adapter implementation of IControllerContextListener.
ControllerFactory Creates Controllers in a number of common configurations.
ControllerStatistics Provides some statistics about processing performed in a Controller.
Document A document that to be processed by the framework.
Document.DocumentToId Transforms a Document to its identifier returned by Document.getId().
DocumentSourceDescriptor Descriptor of a IDocumentSource being part of a ProcessingComponentSuite.
PoolingProcessingComponentManager An IProcessingComponentManager that pools instances of processing components.
ProcessingComponentBase A base class for implementation of the IProcessingComponent interface that provides empty implementations of all life cycle methods.
ProcessingComponentConfiguration Represents a specific configuration of a IProcessingComponent.
ProcessingComponentDescriptor Descriptor of a IProcessingComponent being part of a ProcessingComponentSuite.
ProcessingComponentDescriptor.ProcessingComponentDescriptorToId Transforms a ProcessingComponentDescriptor to its identifier.
ProcessingComponentSuite A set of IProcessingComponents used in Carrot2 applications.
ProcessingResult Encapsulates the results of processing.
SimpleProcessingComponentManager An IProcessingComponentManager that creates a new component for each processing request.
 

Enum Summary
LanguageCode Codes for languages for which linguistic resources are available in DefaultLanguageModelFactory.
Platform Provides the runtime execution platform environment information.
 

Exception Summary
ComponentInitializationException Exception thrown if component initialization was unsuccessful.
ProcessingException An exception thrown if processing failed.
 

Package org.carrot2.core Description

Definitions of Carrot2 core interfaces and their implementations.



Copyright (c) Dawid Weiss, Stanislaw Osinski