org.carrot2.text.clustering

Class MultilingualClusteringDescriptor.AttributeBuilder

java.lang.Object

org.carrot2.text.clustering.MultilingualClusteringDescriptor.AttributeBuilder

Enclosing class:

MultilingualClusteringDescriptor

public static class MultilingualClusteringDescriptor.AttributeBuilder
extends Object

Attribute map builder for the MultilingualClustering component. You can use this builder as a type-safe alternative to populating the attribute map using attribute keys.

Field Summary

Fields

Modifier and Type	Field and Description
Map<String,Object>	map The attribute map populated by this builder.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MultilingualClusteringDescriptor.AttributeBuilder(Map<String,Object> map) Creates a builder backed by the provided map.

Method Summary

Methods

Modifier and Type	Method and Description
MultilingualClusteringDescriptor.AttributeBuilder	defaultLanguage(org.carrot2.util.attribute.IObjectFactory<? extends LanguageCode> value) Default clustering language.
MultilingualClusteringDescriptor.AttributeBuilder	defaultLanguage(LanguageCode value) Default clustering language.
MultilingualClusteringDescriptor.AttributeBuilder	languageAggregationStrategy(org.carrot2.util.attribute.IObjectFactory<? extends MultilingualClustering.LanguageAggregationStrategy> value) Language aggregation strategy.
MultilingualClusteringDescriptor.AttributeBuilder	languageAggregationStrategy(MultilingualClustering.LanguageAggregationStrategy value) Language aggregation strategy.
Map<String,Integer>	languageCounts() Document languages.
String	majorityLanguage() Majority language.

Methods inherited from class java.lang.Object

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

Field Detail

map

public final Map<String,Object> map

The attribute map populated by this builder.

Constructor Detail

MultilingualClusteringDescriptor.AttributeBuilder

protected MultilingualClusteringDescriptor.AttributeBuilder(Map<String,Object> map)

Creates a builder backed by the provided map.

Method Detail

languageAggregationStrategy

public MultilingualClusteringDescriptor.AttributeBuilder languageAggregationStrategy(MultilingualClustering.LanguageAggregationStrategy value)

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.

See Also:

MultilingualClustering.languageAggregationStrategy

languageAggregationStrategy

public MultilingualClusteringDescriptor.AttributeBuilder languageAggregationStrategy(org.carrot2.util.attribute.IObjectFactory<? extends MultilingualClustering.LanguageAggregationStrategy> value)

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.

See Also:

MultilingualClustering.languageAggregationStrategy

defaultLanguage

public MultilingualClusteringDescriptor.AttributeBuilder defaultLanguage(LanguageCode value)

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

See Also:

MultilingualClustering.defaultLanguage

defaultLanguage

public MultilingualClusteringDescriptor.AttributeBuilder defaultLanguage(org.carrot2.util.attribute.IObjectFactory<? extends LanguageCode> value)

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

See Also:

MultilingualClustering.defaultLanguage

languageCounts

public Map<String,Integer> languageCounts()

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

See Also:

MultilingualClustering.languageCounts

majorityLanguage

public String majorityLanguage()

Majority language. If MultilingualClustering.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 MultilingualClustering.defaultLanguage.

See Also:

MultilingualClustering.majorityLanguage