org.carrot2.output.metrics

Class ContaminationMetricDescriptor.AttributeBuilder

java.lang.Object

org.carrot2.output.metrics.IdealPartitioningBasedMetricDescriptor.AttributeBuilder

org.carrot2.output.metrics.ContaminationMetricDescriptor.AttributeBuilder

Enclosing class:

ContaminationMetricDescriptor

public static class ContaminationMetricDescriptor.AttributeBuilder
extends IdealPartitioningBasedMetricDescriptor.AttributeBuilder

Attribute map builder for the ContaminationMetric 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	ContaminationMetricDescriptor.AttributeBuilder(Map<String,Object> map) Creates a builder backed by the provided map.

Method Summary

Methods

Modifier and Type	Method and Description
ContaminationMetricDescriptor.AttributeBuilder	clusters(org.carrot2.util.attribute.IObjectFactory<? extends List<Cluster>> value)
ContaminationMetricDescriptor.AttributeBuilder	clusters(List<Cluster> value)
ContaminationMetricDescriptor.AttributeBuilder	documents(org.carrot2.util.attribute.IObjectFactory<? extends List<Document>> value)
ContaminationMetricDescriptor.AttributeBuilder	documents(List<Document> value)
ContaminationMetricDescriptor.AttributeBuilder	enabled(boolean value) Calculate contamination metric.
ContaminationMetricDescriptor.AttributeBuilder	enabled(org.carrot2.util.attribute.IObjectFactory<? extends Boolean> value) Calculate contamination metric.
double	weightedAverageContamination() Average contamination of the whole cluster set, weighted by the size of cluster.

Methods inherited from class org.carrot2.output.metrics.IdealPartitioningBasedMetricDescriptor.AttributeBuilder

partitionIdFieldName, partitionIdFieldName

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

ContaminationMetricDescriptor.AttributeBuilder

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

Creates a builder backed by the provided map.

Method Detail

weightedAverageContamination

public double weightedAverageContamination()

Average contamination of the whole cluster set, weighted by the size of cluster.

See Also:

ContaminationMetric.weightedAverageContamination

enabled

public ContaminationMetricDescriptor.AttributeBuilder enabled(boolean value)

Calculate contamination metric.

See Also:

ContaminationMetric.enabled

enabled

public ContaminationMetricDescriptor.AttributeBuilder enabled(org.carrot2.util.attribute.IObjectFactory<? extends Boolean> value)

Calculate contamination metric.

See Also:

ContaminationMetric.enabled

documents

public ContaminationMetricDescriptor.AttributeBuilder documents(List<Document> value)

See Also:

ContaminationMetric.documents

documents

public ContaminationMetricDescriptor.AttributeBuilder documents(org.carrot2.util.attribute.IObjectFactory<? extends List<Document>> value)

See Also:

ContaminationMetric.documents

clusters

public ContaminationMetricDescriptor.AttributeBuilder clusters(List<Cluster> value)

See Also:

ContaminationMetric.clusters

clusters

public ContaminationMetricDescriptor.AttributeBuilder clusters(org.carrot2.util.attribute.IObjectFactory<? extends List<Cluster>> value)

See Also:

ContaminationMetric.clusters