org.carrot2.text.clustering

Class MultilingualClustering

java.lang.Object

org.carrot2.text.clustering.MultilingualClustering

@Bindable(prefix="MultilingualClustering")
public class MultilingualClustering
extends Object

A helper for clustering multilingual collections of documents. The helper partitions the input documents by Document.LANGUAGE, clusters each such monolingual partition separately and then aggregates the partial cluster lists based on the selected MultilingualClustering.LanguageAggregationStrategy.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MultilingualClustering.LanguageAggregationStrategy Defines how monolingual partial clusters will be combined to form final results.

Field Summary

Fields

Modifier and Type	Field and Description
LanguageCode	defaultLanguage Default clustering language.
MultilingualClustering.LanguageAggregationStrategy	languageAggregationStrategy Language aggregation strategy.
Map<String,Integer>	languageCounts Document languages.
String	majorityLanguage Majority language.

Constructor Summary

Constructors

Constructor and Description
MultilingualClustering()

Method Summary

Modifier and Type	Method and Description
List<Cluster>	process(List<Document> documents, IMonolingualClusteringAlgorithm algorithm)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

languageAggregationStrategy

@Input
 @Processing
 @Attribute
 @Required
 @Group(value="Multilingual clustering")
 @Level(value=MEDIUM)
public MultilingualClustering.LanguageAggregationStrategy languageAggregationStrategy

Language aggregation strategy. Determines how clusters generated for individual languages should be combined to form the final result. Please see MultilingualClustering.LanguageAggregationStrategy for the list of available options.

defaultLanguage

@Input
 @Processing
 @Attribute
 @Required
 @Group(value="Multilingual clustering")
 @Level(value=MEDIUM)
public LanguageCode defaultLanguage

Default clustering language. The default language to use for documents with undefined Document.LANGUAGE.

languageCounts

@Output
 @Processing
 @Attribute
 @Group(value="Multilingual clustering")
 @Level(value=MEDIUM)
public Map<String,Integer> languageCounts

Document languages. The number of documents in each language. Empty string key means unknown language.

majorityLanguage

@Output
 @Processing
 @Attribute
 @Group(value="Multilingual clustering")
 @Level(value=MEDIUM)
public String majorityLanguage

Majority language. If languageAggregationStrategy is MultilingualClustering.LanguageAggregationStrategy.CLUSTER_IN_MAJORITY_LANGUAGE, this attribute will provide the majority language that was used to cluster all the documents. If the majority of the documents have undefined language, this attribute will be empty and the clustering will be performed in the defaultLanguage.

Constructor Detail

MultilingualClustering

public MultilingualClustering()

Method Detail

process

public List<Cluster> process(List<Document> documents,
                             IMonolingualClusteringAlgorithm algorithm)