com.carrotsearch.lingo3g
Class Lingo3GAttributes.ClusterScoringFields

java.lang.Object
  com.carrotsearch.lingo3g.Lingo3GAttributes.ClusterScoringFields

Enclosing class:

Lingo3GAttributes

public static final class Lingo3GAttributes.ClusterScoringFields
extends Object

Specifies the set of fields used for scoring clusters.

See Also:

Lingo3GAttributes.clusterScoringFields

Nested Class Summary

static class	Lingo3GAttributes.ClusterScoringFields.ClusterScoringField
static class	Lingo3GAttributes.ClusterScoringFields.NominalClusterScoringField
static class	Lingo3GAttributes.ClusterScoringFields.NominalScoring Available types of scoring based on nominal fields.
static class	Lingo3GAttributes.ClusterScoringFields.NumericClusterScoringField
static class	Lingo3GAttributes.ClusterScoringFields.NumericScoring Available types of scoring based on numeric fields.

Method Summary

Lingo3GAttributes.ClusterScoringFields	addNominalField(String fieldName, Lingo3GAttributes.ClusterScoringFields.NominalScoring scoring, double weight) Adds a nominal field to the set of cluster scoring fields.
Lingo3GAttributes.ClusterScoringFields	addNumericField(String fieldName, Lingo3GAttributes.ClusterScoringFields.NumericScoring scoring, double weight) Adds a numeric field to the set of cluster scoring fields.
static Lingo3GAttributes.ClusterScoringFields	create() Creates an empty set of cluster scoring field definitions.
List<Lingo3GAttributes.ClusterScoringFields.NominalClusterScoringField>	getNominalFields()
List<Lingo3GAttributes.ClusterScoringFields.NumericClusterScoringField>	getNumericFields()
static Lingo3GAttributes.ClusterScoringFields	valueOf(String text)

Methods inherited from class java.lang.Object

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

Method Detail

create

public static Lingo3GAttributes.ClusterScoringFields create()

Creates an empty set of cluster scoring field definitions.

See Also:

addNominalField(String, NominalScoring, double), addNumericField(String, NumericScoring, double)

valueOf

public static Lingo3GAttributes.ClusterScoringFields valueOf(String text)

addNominalField

public Lingo3GAttributes.ClusterScoringFields addNominalField(String fieldName,
                                                              Lingo3GAttributes.ClusterScoringFields.NominalScoring scoring,
                                                              double weight)

Adds a nominal field to the set of cluster scoring fields.

Parameters:

fieldName - name of the Document field to use

scoring - type of scoring to use

weight - weight of this field's score, relative to other nominal fields. Must be between 0.0 and 1.0.

Returns:

cluster scoring field set for chaining of invocations

addNumericField

public Lingo3GAttributes.ClusterScoringFields addNumericField(String fieldName,
                                                              Lingo3GAttributes.ClusterScoringFields.NumericScoring scoring,
                                                              double weight)

Adds a numeric field to the set of cluster scoring fields.

Parameters:

fieldName - name of the Document field to use

scoring - type of scoring to use

weight - weight of this field's score, relative to other nominal fields. Must be between 0.0 and 1.0.

Returns:

cluster scoring field set for chaining of invocations

getNominalFields

public List<Lingo3GAttributes.ClusterScoringFields.NominalClusterScoringField> getNominalFields()

getNumericFields

public List<Lingo3GAttributes.ClusterScoringFields.NumericClusterScoringField> getNumericFields()