com.exalead.mercury.mami.learning.v10

Class ClusteringConfig

java.lang.Object

com.exalead.mercury.mami.learning.v10.UnSupervisedLearningConfig

com.exalead.mercury.mami.learning.v10.ClusteringConfig

All Implemented Interfaces:

com.exalead.util.Checkable, java.io.Serializable

Direct Known Subclasses:

NewsClusteringConfig

public class ClusteringConfig
extends UnSupervisedLearningConfig
implements com.exalead.util.Checkable, java.io.Serializable

Specify a clustering job to be performed in this learning job. Clustering creates 'clusters' out of documents sharing the same extracted attributes. The main output of clustering is a 'clusterid' assigned to each document
The clustering job updates the index with this clusterid. This can be then be used for instance to show to the user all documents similar to a given document.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.exalead.mercury.mami.learning.v10.UnSupervisedLearningConfig

UnSupervisedLearningConfig.Conditions, UnSupervisedLearningConfig.Descriptors, UnSupervisedLearningConfig.SkippedAnnotations

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	classField
static int	DEFAULT_MAX_BEST_DESCRIPTORS
static int	DEFAULT_MAX_DESCRIPTORS_USED
java.lang.String	descriptorsField
java.lang.String	headField
int	maxBestDescriptors
int	maxDescriptorsUsed
int	maxFreq
int	minFreq
double	minScore
int	minWordMatched
java.lang.String	nbDocsField
double	similarityThreshold

Fields inherited from class com.exalead.mercury.mami.learning.v10.UnSupervisedLearningConfig

conditions, DEFAULT_MAX_DOCUMENT_THRESHOLD, DEFAULT_MIN_DOCUMENT_REQUIRED, descriptors, instance, managedResourceGroup, maxDocumentThreshold, minDocumentRequired, skippedAnnotations

Constructor Summary

Constructors

Constructor and Description
ClusteringConfig()
ClusteringConfig(ClusteringConfig o) Copy constructor

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this ClusteringConfig.
static ClusteringConfig	fromString(java.lang.String s) String representation of this ClusteringConfig.
java.lang.String	getClassField() The index unsigned field name where the classID is going to be imported.
java.lang.String	getDescriptorsField() The optional index text field name storing the best n descriptors for each cluster (tabulation separated), usable as human-readable cluster title.
java.lang.String	getHeadField() The index unsigned field name specifying if the document whether a cluster is a head.
int	getMaxBestDescriptors() Maximum amount of descriptors in descriptors field.
int	getMaxDescriptorsUsed() The maximum number of descriptors used (optional).
int	getMaxFreq() The maximum frequency a descriptor must have to be relevant.
int	getMinFreq() The minimum frequency a descriptor must have to be relevant.
double	getMinScore() The minimum score a descriptor must have to be relevant.
int	getMinWordMatched() The minimum number of matched word required to build a cluster.
java.lang.String	getNbDocsField() The index text field name specifying the number of documents in the cluster (only set on heads).
double	getSimilarityThreshold() The clustering similarity threshold.
ClusteringConfig	makeCopy() Creates and returns a deep copy of this ClusteringConfig.
static ClusteringConfig	readFrom(java.io.InputStream is) Read this ClusteringConfig from an XML fragment.
void	setClassField(java.lang.String classField) The index unsigned field name where the classID is going to be imported.
void	setDescriptorsField(java.lang.String descriptorsField) The optional index text field name storing the best n descriptors for each cluster (tabulation separated), usable as human-readable cluster title.
void	setHeadField(java.lang.String headField) The index unsigned field name specifying if the document whether a cluster is a head.
void	setMaxBestDescriptors(int maxBestDescriptors) Maximum amount of descriptors in descriptors field.
void	setMaxDescriptorsUsed(int maxDescriptorsUsed) The maximum number of descriptors used (optional).
void	setMaxFreq(int maxFreq) The maximum frequency a descriptor must have to be relevant.
void	setMinFreq(int minFreq) The minimum frequency a descriptor must have to be relevant.
void	setMinScore(double minScore) The minimum score a descriptor must have to be relevant.
void	setMinWordMatched(int minWordMatched) The minimum number of matched word required to build a cluster.
void	setNbDocsField(java.lang.String nbDocsField) The index text field name specifying the number of documents in the cluster (only set on heads).
void	setSimilarityThreshold(double similarityThreshold) The clustering similarity threshold.
java.lang.String	toString() String representation of this ClusteringConfig.
ClusteringConfig	withClassField(java.lang.String classField)
ClusteringConfig	withConditions(java.util.Collection<LearningTriggerCondition> __values)
ClusteringConfig	withConditions(LearningTriggerCondition... __values) The list of triggering conditions. This learning job is triggered as soon as any of this condition is fulfilled.
ClusteringConfig	withDescriptors(java.util.Collection<Descriptor> __values)
ClusteringConfig	withDescriptors(Descriptor... __values) The list of MOT annotation used to extract descriptors (if empty, words are used).
ClusteringConfig	withDescriptorsField(java.lang.String descriptorsField)
ClusteringConfig	withHeadField(java.lang.String headField)
ClusteringConfig	withInstance(java.lang.String instance)
ClusteringConfig	withManagedResourceGroup(java.lang.String managedResourceGroup)
ClusteringConfig	withMaxBestDescriptors(int maxBestDescriptors)
ClusteringConfig	withMaxBestDescriptors(java.lang.Integer maxBestDescriptors)
ClusteringConfig	withMaxDescriptorsUsed(int maxDescriptorsUsed)
ClusteringConfig	withMaxDescriptorsUsed(java.lang.Integer maxDescriptorsUsed)
ClusteringConfig	withMaxDocumentThreshold(int maxDocumentThreshold)
ClusteringConfig	withMaxDocumentThreshold(java.lang.Integer maxDocumentThreshold)
ClusteringConfig	withMaxFreq(int maxFreq)
ClusteringConfig	withMaxFreq(java.lang.Integer maxFreq)
ClusteringConfig	withMinDocumentRequired(int minDocumentRequired)
ClusteringConfig	withMinDocumentRequired(java.lang.Integer minDocumentRequired)
ClusteringConfig	withMinFreq(int minFreq)
ClusteringConfig	withMinFreq(java.lang.Integer minFreq)
ClusteringConfig	withMinScore(double minScore)
ClusteringConfig	withMinWordMatched(int minWordMatched)
ClusteringConfig	withMinWordMatched(java.lang.Integer minWordMatched)
ClusteringConfig	withNbDocsField(java.lang.String nbDocsField)
ClusteringConfig	withSimilarityThreshold(double similarityThreshold)
ClusteringConfig	withSkippedAnnotations(java.util.Collection<StringValue> __values)
ClusteringConfig	withSkippedAnnotations(StringValue... __values) The list of MOT annotation used to ignore tokens.
void	writeTo(java.io.OutputStream os) Write this ClusteringConfig as an XML fragment

Methods inherited from class com.exalead.mercury.mami.learning.v10.UnSupervisedLearningConfig

getConditions, getDescriptors, getInstance, getManagedResourceGroup, getMaxDocumentThreshold, getMinDocumentRequired, getSkippedAnnotations, setConditions, setDescriptors, setInstance, setManagedResourceGroup, setMaxDocumentThreshold, setMinDocumentRequired, setSkippedAnnotations, withConditions, withDescriptors, withSkippedAnnotations

Methods inherited from class java.lang.Object

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

Field Detail

similarityThreshold

public double similarityThreshold

minScore

public double minScore

minWordMatched

public int minWordMatched

minFreq

public int minFreq

maxFreq

public int maxFreq

classField

public java.lang.String classField

headField

public java.lang.String headField

nbDocsField

public java.lang.String nbDocsField

maxDescriptorsUsed

public int maxDescriptorsUsed

DEFAULT_MAX_DESCRIPTORS_USED

public static final int DEFAULT_MAX_DESCRIPTORS_USED

See Also:

Constant Field Values

descriptorsField

public java.lang.String descriptorsField

maxBestDescriptors

public int maxBestDescriptors

DEFAULT_MAX_BEST_DESCRIPTORS

public static final int DEFAULT_MAX_BEST_DESCRIPTORS

See Also:

Constant Field Values

Constructor Detail

ClusteringConfig

public ClusteringConfig()

ClusteringConfig

public ClusteringConfig(ClusteringConfig o)

Copy constructor

Method Detail

withInstance

public ClusteringConfig withInstance(java.lang.String instance)

Overrides:

withInstance in class UnSupervisedLearningConfig

withMinDocumentRequired

public ClusteringConfig withMinDocumentRequired(int minDocumentRequired)

Overrides:

withMinDocumentRequired in class UnSupervisedLearningConfig

withMinDocumentRequired

public ClusteringConfig withMinDocumentRequired(java.lang.Integer minDocumentRequired)

Overrides:

withMinDocumentRequired in class UnSupervisedLearningConfig

withMaxDocumentThreshold

public ClusteringConfig withMaxDocumentThreshold(int maxDocumentThreshold)

Overrides:

withMaxDocumentThreshold in class UnSupervisedLearningConfig

withMaxDocumentThreshold

public ClusteringConfig withMaxDocumentThreshold(java.lang.Integer maxDocumentThreshold)

Overrides:

withMaxDocumentThreshold in class UnSupervisedLearningConfig

withDescriptors

public ClusteringConfig withDescriptors(Descriptor... __values)

The list of MOT annotation used to extract descriptors (if empty, words are used).

Overrides:

withDescriptors in class UnSupervisedLearningConfig

withDescriptors

public ClusteringConfig withDescriptors(java.util.Collection<Descriptor> __values)

Overrides:

withDescriptors in class UnSupervisedLearningConfig

withSkippedAnnotations

public ClusteringConfig withSkippedAnnotations(StringValue... __values)

The list of MOT annotation used to ignore tokens.

Overrides:

withSkippedAnnotations in class UnSupervisedLearningConfig

withSkippedAnnotations

public ClusteringConfig withSkippedAnnotations(java.util.Collection<StringValue> __values)

Overrides:

withSkippedAnnotations in class UnSupervisedLearningConfig

withConditions

public ClusteringConfig withConditions(LearningTriggerCondition... __values)

The list of triggering conditions.
This learning job is triggered as soon as any of this condition is fulfilled.

Overrides:

withConditions in class UnSupervisedLearningConfig

withConditions

public ClusteringConfig withConditions(java.util.Collection<LearningTriggerCondition> __values)

Overrides:

withConditions in class UnSupervisedLearningConfig

withManagedResourceGroup

public ClusteringConfig withManagedResourceGroup(java.lang.String managedResourceGroup)

Overrides:

withManagedResourceGroup in class UnSupervisedLearningConfig

setSimilarityThreshold

public void setSimilarityThreshold(double similarityThreshold)

The clustering similarity threshold.

getSimilarityThreshold

public double getSimilarityThreshold()

The clustering similarity threshold.

withSimilarityThreshold

public ClusteringConfig withSimilarityThreshold(double similarityThreshold)

setMinScore

public void setMinScore(double minScore)

The minimum score a descriptor must have to be relevant.

getMinScore

public double getMinScore()

The minimum score a descriptor must have to be relevant.

withMinScore

public ClusteringConfig withMinScore(double minScore)

setMinWordMatched

public void setMinWordMatched(int minWordMatched)

The minimum number of matched word required to build a cluster.

getMinWordMatched

public int getMinWordMatched()

The minimum number of matched word required to build a cluster.

withMinWordMatched

public ClusteringConfig withMinWordMatched(int minWordMatched)

withMinWordMatched

public ClusteringConfig withMinWordMatched(java.lang.Integer minWordMatched)

setMinFreq

public void setMinFreq(int minFreq)

The minimum frequency a descriptor must have to be relevant.

getMinFreq

public int getMinFreq()

The minimum frequency a descriptor must have to be relevant.

withMinFreq

public ClusteringConfig withMinFreq(int minFreq)

withMinFreq

public ClusteringConfig withMinFreq(java.lang.Integer minFreq)

setMaxFreq

public void setMaxFreq(int maxFreq)

The maximum frequency a descriptor must have to be relevant.

getMaxFreq

public int getMaxFreq()

The maximum frequency a descriptor must have to be relevant.

withMaxFreq

public ClusteringConfig withMaxFreq(int maxFreq)

withMaxFreq

public ClusteringConfig withMaxFreq(java.lang.Integer maxFreq)

setClassField

public void setClassField(java.lang.String classField)

The index unsigned field name where the classID is going to be imported.

getClassField

public java.lang.String getClassField()

The index unsigned field name where the classID is going to be imported.

withClassField

public ClusteringConfig withClassField(java.lang.String classField)

setHeadField

public void setHeadField(java.lang.String headField)

The index unsigned field name specifying if the document whether a cluster is a head.

getHeadField

public java.lang.String getHeadField()

The index unsigned field name specifying if the document whether a cluster is a head.

withHeadField

public ClusteringConfig withHeadField(java.lang.String headField)

setNbDocsField

public void setNbDocsField(java.lang.String nbDocsField)

The index text field name specifying the number of documents in the cluster (only set on heads).

getNbDocsField

public java.lang.String getNbDocsField()

The index text field name specifying the number of documents in the cluster (only set on heads).

withNbDocsField

public ClusteringConfig withNbDocsField(java.lang.String nbDocsField)

setMaxDescriptorsUsed

public void setMaxDescriptorsUsed(int maxDescriptorsUsed)

The maximum number of descriptors used (optional).

getMaxDescriptorsUsed

public int getMaxDescriptorsUsed()

The maximum number of descriptors used (optional).

withMaxDescriptorsUsed

public ClusteringConfig withMaxDescriptorsUsed(int maxDescriptorsUsed)

withMaxDescriptorsUsed

public ClusteringConfig withMaxDescriptorsUsed(java.lang.Integer maxDescriptorsUsed)

setDescriptorsField

public void setDescriptorsField(java.lang.String descriptorsField)

The optional index text field name storing the best n descriptors for each cluster (tabulation separated), usable as human-readable cluster title.

getDescriptorsField

public java.lang.String getDescriptorsField()

The optional index text field name storing the best n descriptors for each cluster (tabulation separated), usable as human-readable cluster title.

withDescriptorsField

public ClusteringConfig withDescriptorsField(java.lang.String descriptorsField)

setMaxBestDescriptors

public void setMaxBestDescriptors(int maxBestDescriptors)

Maximum amount of descriptors in descriptors field.

getMaxBestDescriptors

public int getMaxBestDescriptors()

Maximum amount of descriptors in descriptors field.

withMaxBestDescriptors

public ClusteringConfig withMaxBestDescriptors(int maxBestDescriptors)

withMaxBestDescriptors

public ClusteringConfig withMaxBestDescriptors(java.lang.Integer maxBestDescriptors)

makeCopy

public ClusteringConfig makeCopy()

Creates and returns a deep copy of this ClusteringConfig.

Overrides:

makeCopy in class UnSupervisedLearningConfig

readFrom

public static ClusteringConfig readFrom(java.io.InputStream is)
                                 throws javax.xml.bind.JAXBException

Read this ClusteringConfig from an XML fragment.

Throws:

javax.xml.bind.JAXBException

writeTo

public void writeTo(java.io.OutputStream os)
             throws javax.xml.bind.JAXBException,
                    java.io.IOException

Write this ClusteringConfig as an XML fragment

Overrides:

writeTo in class UnSupervisedLearningConfig

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

public static ClusteringConfig fromString(java.lang.String s)
                                   throws javax.xml.bind.JAXBException,
                                          java.io.UnsupportedEncodingException

String representation of this ClusteringConfig.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this ClusteringConfig.

Overrides:

toString in class UnSupervisedLearningConfig

check

public void check(boolean deep,
                  java.lang.String errorContext)
           throws com.exalead.util.TypedException

Checks this ClusteringConfig.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class UnSupervisedLearningConfig

Throws:

com.exalead.util.TypedException