org.carrot2.clustering.stc

Class STCClusteringAlgorithmDescriptor.AttributeBuilder

java.lang.Object

org.carrot2.clustering.stc.STCClusteringAlgorithmDescriptor.AttributeBuilder

Enclosing class:

STCClusteringAlgorithmDescriptor

public static class STCClusteringAlgorithmDescriptor.AttributeBuilder
extends Object

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

Method Summary

Methods

Modifier and Type	Method and Description
List<Cluster>	clusters() Clusters created by the algorithm.
STCClusteringAlgorithmDescriptor.AttributeBuilder	documentCountBoost(double value) Document count boost.
STCClusteringAlgorithmDescriptor.AttributeBuilder	documentCountBoost(org.carrot2.util.attribute.IObjectFactory<? extends Double> value) Document count boost.
STCClusteringAlgorithmDescriptor.AttributeBuilder	documents(org.carrot2.util.attribute.IObjectFactory<? extends List<Document>> value) Documents to cluster.
STCClusteringAlgorithmDescriptor.AttributeBuilder	documents(List<Document> value) Documents to cluster.
STCClusteringAlgorithmDescriptor.AttributeBuilder	ignoreWordIfInFewerDocs(int value) Minimum word-document recurrences.
STCClusteringAlgorithmDescriptor.AttributeBuilder	ignoreWordIfInFewerDocs(org.carrot2.util.attribute.IObjectFactory<? extends Integer> value) Minimum word-document recurrences.
STCClusteringAlgorithmDescriptor.AttributeBuilder	ignoreWordIfInHigherDocsPercent(double value) Maximum word-document ratio.
STCClusteringAlgorithmDescriptor.AttributeBuilder	ignoreWordIfInHigherDocsPercent(org.carrot2.util.attribute.IObjectFactory<? extends Double> value) Maximum word-document ratio.
STCClusteringAlgorithmDescriptor.AttributeBuilder	maxBaseClusters(int value) Maximum base clusters count.
STCClusteringAlgorithmDescriptor.AttributeBuilder	maxBaseClusters(org.carrot2.util.attribute.IObjectFactory<? extends Integer> value) Maximum base clusters count.
STCClusteringAlgorithmDescriptor.AttributeBuilder	maxClusters(int value) Maximum final clusters.
STCClusteringAlgorithmDescriptor.AttributeBuilder	maxClusters(org.carrot2.util.attribute.IObjectFactory<? extends Integer> value) Maximum final clusters.
STCClusteringAlgorithmDescriptor.AttributeBuilder	maxDescPhraseLength(int value) Maximum words per label.
STCClusteringAlgorithmDescriptor.AttributeBuilder	maxDescPhraseLength(org.carrot2.util.attribute.IObjectFactory<? extends Integer> value) Maximum words per label.
STCClusteringAlgorithmDescriptor.AttributeBuilder	maxPhraseOverlap(double value) Maximum cluster phrase overlap.
STCClusteringAlgorithmDescriptor.AttributeBuilder	maxPhraseOverlap(org.carrot2.util.attribute.IObjectFactory<? extends Double> value) Maximum cluster phrase overlap.
STCClusteringAlgorithmDescriptor.AttributeBuilder	maxPhrases(int value) Maximum phrases per label.
STCClusteringAlgorithmDescriptor.AttributeBuilder	maxPhrases(org.carrot2.util.attribute.IObjectFactory<? extends Integer> value) Maximum phrases per label.
STCClusteringAlgorithmDescriptor.AttributeBuilder	mergeStemEquivalentBaseClusters(boolean value) Merge all stem-equivalent base clusters before running the merge phase.
STCClusteringAlgorithmDescriptor.AttributeBuilder	mergeStemEquivalentBaseClusters(org.carrot2.util.attribute.IObjectFactory<? extends Boolean> value) Merge all stem-equivalent base clusters before running the merge phase.
STCClusteringAlgorithmDescriptor.AttributeBuilder	mergeThreshold(double value) Base cluster merge threshold.
STCClusteringAlgorithmDescriptor.AttributeBuilder	mergeThreshold(org.carrot2.util.attribute.IObjectFactory<? extends Double> value) Base cluster merge threshold.
STCClusteringAlgorithmDescriptor.AttributeBuilder	minBaseClusterScore(double value) Minimum base cluster score.
STCClusteringAlgorithmDescriptor.AttributeBuilder	minBaseClusterScore(org.carrot2.util.attribute.IObjectFactory<? extends Double> value) Minimum base cluster score.
STCClusteringAlgorithmDescriptor.AttributeBuilder	minBaseClusterSize(int value) Minimum documents per base cluster.
STCClusteringAlgorithmDescriptor.AttributeBuilder	minBaseClusterSize(org.carrot2.util.attribute.IObjectFactory<? extends Integer> value) Minimum documents per base cluster.
STCClusteringAlgorithmDescriptor.AttributeBuilder	mostGeneralPhraseCoverage(double value) Minimum general phrase coverage.
STCClusteringAlgorithmDescriptor.AttributeBuilder	mostGeneralPhraseCoverage(org.carrot2.util.attribute.IObjectFactory<? extends Double> value) Minimum general phrase coverage.
MultilingualClusteringDescriptor.AttributeBuilder	multilingualClustering() Returns an attribute builder for the nested MultilingualClustering component, backed by the same attribute map as the current builder.
STCClusteringAlgorithmDescriptor.AttributeBuilder	optimalPhraseLength(int value) Optimal label length.
STCClusteringAlgorithmDescriptor.AttributeBuilder	optimalPhraseLength(org.carrot2.util.attribute.IObjectFactory<? extends Integer> value) Optimal label length.
STCClusteringAlgorithmDescriptor.AttributeBuilder	optimalPhraseLengthDev(double value) Phrase length tolerance.
STCClusteringAlgorithmDescriptor.AttributeBuilder	optimalPhraseLengthDev(org.carrot2.util.attribute.IObjectFactory<? extends Double> value) Phrase length tolerance.
STCClusteringAlgorithmDescriptor.AttributeBuilder	preprocessingPipeline(Class<?> clazz) Common preprocessing tasks handler.
STCClusteringAlgorithmDescriptor.AttributeBuilder	preprocessingPipeline(org.carrot2.util.attribute.IObjectFactory<? extends IPreprocessingPipeline> value) Common preprocessing tasks handler.
STCClusteringAlgorithmDescriptor.AttributeBuilder	preprocessingPipeline(IPreprocessingPipeline value) Common preprocessing tasks handler.
STCClusteringAlgorithmDescriptor.AttributeBuilder	query(org.carrot2.util.attribute.IObjectFactory<? extends String> value) Query that produced the documents.
STCClusteringAlgorithmDescriptor.AttributeBuilder	query(String value) Query that produced the documents.
STCClusteringAlgorithmDescriptor.AttributeBuilder	scoreWeight(double value) Balance between cluster score and size during cluster sorting.
STCClusteringAlgorithmDescriptor.AttributeBuilder	scoreWeight(org.carrot2.util.attribute.IObjectFactory<? extends Double> value) Balance between cluster score and size during cluster sorting.
STCClusteringAlgorithmDescriptor.AttributeBuilder	singleTermBoost(double value) Single term boost.
STCClusteringAlgorithmDescriptor.AttributeBuilder	singleTermBoost(org.carrot2.util.attribute.IObjectFactory<? extends Double> value) Single term boost.

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

STCClusteringAlgorithmDescriptor.AttributeBuilder

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

Creates a builder backed by the provided map.

Method Detail

query

public STCClusteringAlgorithmDescriptor.AttributeBuilder query(String value)

Query that produced the documents. The query will help the algorithm to create better clusters. Therefore, providing the query is optional but desirable.

See Also:

STCClusteringAlgorithm.query

query

public STCClusteringAlgorithmDescriptor.AttributeBuilder query(org.carrot2.util.attribute.IObjectFactory<? extends String> value)

Query that produced the documents. The query will help the algorithm to create better clusters. Therefore, providing the query is optional but desirable.

See Also:

STCClusteringAlgorithm.query

documents

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

Documents to cluster.

See Also:

STCClusteringAlgorithm.documents

documents

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

Documents to cluster.

See Also:

STCClusteringAlgorithm.documents

clusters

public List<Cluster> clusters()

Clusters created by the algorithm.

See Also:

STCClusteringAlgorithm.clusters

ignoreWordIfInFewerDocs

public STCClusteringAlgorithmDescriptor.AttributeBuilder ignoreWordIfInFewerDocs(int value)

Minimum word-document recurrences.

See Also:

STCClusteringAlgorithm.ignoreWordIfInFewerDocs

ignoreWordIfInFewerDocs

public STCClusteringAlgorithmDescriptor.AttributeBuilder ignoreWordIfInFewerDocs(org.carrot2.util.attribute.IObjectFactory<? extends Integer> value)

Minimum word-document recurrences.

See Also:

STCClusteringAlgorithm.ignoreWordIfInFewerDocs

ignoreWordIfInHigherDocsPercent

public STCClusteringAlgorithmDescriptor.AttributeBuilder ignoreWordIfInHigherDocsPercent(double value)

Maximum word-document ratio. A number between 0 and 1, if a word exists in more snippets than this ratio, it is ignored.

See Also:

STCClusteringAlgorithm.ignoreWordIfInHigherDocsPercent

ignoreWordIfInHigherDocsPercent

public STCClusteringAlgorithmDescriptor.AttributeBuilder ignoreWordIfInHigherDocsPercent(org.carrot2.util.attribute.IObjectFactory<? extends Double> value)

Maximum word-document ratio. A number between 0 and 1, if a word exists in more snippets than this ratio, it is ignored.

See Also:

STCClusteringAlgorithm.ignoreWordIfInHigherDocsPercent

minBaseClusterScore

public STCClusteringAlgorithmDescriptor.AttributeBuilder minBaseClusterScore(double value)

Minimum base cluster score.

See Also:

STCClusteringAlgorithm.minBaseClusterScore

minBaseClusterScore

public STCClusteringAlgorithmDescriptor.AttributeBuilder minBaseClusterScore(org.carrot2.util.attribute.IObjectFactory<? extends Double> value)

Minimum base cluster score.

See Also:

STCClusteringAlgorithm.minBaseClusterScore

maxBaseClusters

public STCClusteringAlgorithmDescriptor.AttributeBuilder maxBaseClusters(int value)

Maximum base clusters count. Trims the base cluster array after N-th position for the merging phase.

See Also:

STCClusteringAlgorithm.maxBaseClusters

maxBaseClusters

public STCClusteringAlgorithmDescriptor.AttributeBuilder maxBaseClusters(org.carrot2.util.attribute.IObjectFactory<? extends Integer> value)

Maximum base clusters count. Trims the base cluster array after N-th position for the merging phase.

See Also:

STCClusteringAlgorithm.maxBaseClusters

minBaseClusterSize

public STCClusteringAlgorithmDescriptor.AttributeBuilder minBaseClusterSize(int value)

Minimum documents per base cluster.

See Also:

STCClusteringAlgorithm.minBaseClusterSize

minBaseClusterSize

public STCClusteringAlgorithmDescriptor.AttributeBuilder minBaseClusterSize(org.carrot2.util.attribute.IObjectFactory<? extends Integer> value)

Minimum documents per base cluster.

See Also:

STCClusteringAlgorithm.minBaseClusterSize

maxClusters

public STCClusteringAlgorithmDescriptor.AttributeBuilder maxClusters(int value)

Maximum final clusters.

See Also:

STCClusteringAlgorithm.maxClusters

maxClusters

public STCClusteringAlgorithmDescriptor.AttributeBuilder maxClusters(org.carrot2.util.attribute.IObjectFactory<? extends Integer> value)

Maximum final clusters.

See Also:

STCClusteringAlgorithm.maxClusters

mergeThreshold

public STCClusteringAlgorithmDescriptor.AttributeBuilder mergeThreshold(double value)

Base cluster merge threshold.

See Also:

STCClusteringAlgorithm.mergeThreshold

mergeThreshold

public STCClusteringAlgorithmDescriptor.AttributeBuilder mergeThreshold(org.carrot2.util.attribute.IObjectFactory<? extends Double> value)

Base cluster merge threshold.

See Also:

STCClusteringAlgorithm.mergeThreshold

maxPhraseOverlap

public STCClusteringAlgorithmDescriptor.AttributeBuilder maxPhraseOverlap(double value)

Maximum cluster phrase overlap.

See Also:

STCClusteringAlgorithm.maxPhraseOverlap

maxPhraseOverlap

public STCClusteringAlgorithmDescriptor.AttributeBuilder maxPhraseOverlap(org.carrot2.util.attribute.IObjectFactory<? extends Double> value)

Maximum cluster phrase overlap.

See Also:

STCClusteringAlgorithm.maxPhraseOverlap

mostGeneralPhraseCoverage

public STCClusteringAlgorithmDescriptor.AttributeBuilder mostGeneralPhraseCoverage(double value)

Minimum general phrase coverage. Minimum phrase coverage to appear in cluster description.

See Also:

STCClusteringAlgorithm.mostGeneralPhraseCoverage

mostGeneralPhraseCoverage

public STCClusteringAlgorithmDescriptor.AttributeBuilder mostGeneralPhraseCoverage(org.carrot2.util.attribute.IObjectFactory<? extends Double> value)

Minimum general phrase coverage. Minimum phrase coverage to appear in cluster description.

See Also:

STCClusteringAlgorithm.mostGeneralPhraseCoverage

maxDescPhraseLength

public STCClusteringAlgorithmDescriptor.AttributeBuilder maxDescPhraseLength(int value)

Maximum words per label. Base clusters formed by phrases with more words than this ratio are trimmed.

See Also:

STCClusteringAlgorithm.maxDescPhraseLength

maxDescPhraseLength

public STCClusteringAlgorithmDescriptor.AttributeBuilder maxDescPhraseLength(org.carrot2.util.attribute.IObjectFactory<? extends Integer> value)

Maximum words per label. Base clusters formed by phrases with more words than this ratio are trimmed.

See Also:

STCClusteringAlgorithm.maxDescPhraseLength

maxPhrases

public STCClusteringAlgorithmDescriptor.AttributeBuilder maxPhrases(int value)

Maximum phrases per label. Maximum number of phrases from base clusters promoted to the cluster's label.

See Also:

STCClusteringAlgorithm.maxPhrases

maxPhrases

public STCClusteringAlgorithmDescriptor.AttributeBuilder maxPhrases(org.carrot2.util.attribute.IObjectFactory<? extends Integer> value)

Maximum phrases per label. Maximum number of phrases from base clusters promoted to the cluster's label.

See Also:

STCClusteringAlgorithm.maxPhrases

singleTermBoost

public STCClusteringAlgorithmDescriptor.AttributeBuilder singleTermBoost(double value)

Single term boost. A factor in calculation of the base cluster score. If greater then zero, single-term base clusters are assigned this value regardless of the penalty function.

See Also:

STCClusteringAlgorithm.singleTermBoost

singleTermBoost

public STCClusteringAlgorithmDescriptor.AttributeBuilder singleTermBoost(org.carrot2.util.attribute.IObjectFactory<? extends Double> value)

Single term boost. A factor in calculation of the base cluster score. If greater then zero, single-term base clusters are assigned this value regardless of the penalty function.

See Also:

STCClusteringAlgorithm.singleTermBoost

optimalPhraseLength

public STCClusteringAlgorithmDescriptor.AttributeBuilder optimalPhraseLength(int value)

Optimal label length. A factor in calculation of the base cluster score.

See Also:

STCClusteringAlgorithm.optimalPhraseLength

optimalPhraseLength

public STCClusteringAlgorithmDescriptor.AttributeBuilder optimalPhraseLength(org.carrot2.util.attribute.IObjectFactory<? extends Integer> value)

Optimal label length. A factor in calculation of the base cluster score.

See Also:

STCClusteringAlgorithm.optimalPhraseLength

optimalPhraseLengthDev

public STCClusteringAlgorithmDescriptor.AttributeBuilder optimalPhraseLengthDev(double value)

Phrase length tolerance. A factor in calculation of the base cluster score.

See Also:

STCClusteringAlgorithm.optimalPhraseLengthDev

optimalPhraseLengthDev

public STCClusteringAlgorithmDescriptor.AttributeBuilder optimalPhraseLengthDev(org.carrot2.util.attribute.IObjectFactory<? extends Double> value)

Phrase length tolerance. A factor in calculation of the base cluster score.

See Also:

STCClusteringAlgorithm.optimalPhraseLengthDev

documentCountBoost

public STCClusteringAlgorithmDescriptor.AttributeBuilder documentCountBoost(double value)

Document count boost. A factor in calculation of the base cluster score, boosting the score depending on the number of documents found in the base cluster.

See Also:

STCClusteringAlgorithm.documentCountBoost

documentCountBoost

public STCClusteringAlgorithmDescriptor.AttributeBuilder documentCountBoost(org.carrot2.util.attribute.IObjectFactory<? extends Double> value)

Document count boost. A factor in calculation of the base cluster score, boosting the score depending on the number of documents found in the base cluster.

See Also:

STCClusteringAlgorithm.documentCountBoost

preprocessingPipeline

public STCClusteringAlgorithmDescriptor.AttributeBuilder preprocessingPipeline(IPreprocessingPipeline value)

Common preprocessing tasks handler.

See Also:

STCClusteringAlgorithm.preprocessingPipeline

preprocessingPipeline

public STCClusteringAlgorithmDescriptor.AttributeBuilder preprocessingPipeline(Class<?> clazz)

Common preprocessing tasks handler. A class that extends org.carrot2.text.preprocessing.pipeline.IPreprocessingPipeline or appropriate IObjectFactory.

See Also:

STCClusteringAlgorithm.preprocessingPipeline

preprocessingPipeline

public STCClusteringAlgorithmDescriptor.AttributeBuilder preprocessingPipeline(org.carrot2.util.attribute.IObjectFactory<? extends IPreprocessingPipeline> value)

Common preprocessing tasks handler.

See Also:

STCClusteringAlgorithm.preprocessingPipeline

scoreWeight

public STCClusteringAlgorithmDescriptor.AttributeBuilder scoreWeight(double value)

Balance between cluster score and size during cluster sorting. Value equal to 0.0 will sort clusters based only on cluster size. Value equal to 1.0 will sort clusters based only on cluster score.

See Also:

STCClusteringAlgorithm.scoreWeight

scoreWeight

public STCClusteringAlgorithmDescriptor.AttributeBuilder scoreWeight(org.carrot2.util.attribute.IObjectFactory<? extends Double> value)

Balance between cluster score and size during cluster sorting. Value equal to 0.0 will sort clusters based only on cluster size. Value equal to 1.0 will sort clusters based only on cluster score.

See Also:

STCClusteringAlgorithm.scoreWeight

mergeStemEquivalentBaseClusters

public STCClusteringAlgorithmDescriptor.AttributeBuilder mergeStemEquivalentBaseClusters(boolean value)

Merge all stem-equivalent base clusters before running the merge phase.

See Also:

STCClusteringAlgorithm.mergeStemEquivalentBaseClusters

mergeStemEquivalentBaseClusters

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

Merge all stem-equivalent base clusters before running the merge phase.

See Also:

STCClusteringAlgorithm.mergeStemEquivalentBaseClusters

multilingualClustering

public MultilingualClusteringDescriptor.AttributeBuilder multilingualClustering()

Returns an attribute builder for the nested MultilingualClustering component, backed by the same attribute map as the current builder.