com.exalead.mercury.mami.learning.v10

Class NewsClusteringConfig

java.lang.Object

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

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

com.exalead.mercury.mami.learning.v10.NewsClusteringConfig

All Implemented Interfaces:

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

public class NewsClusteringConfig
extends ClusteringConfig
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
int	maxSD

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

classField, DEFAULT_MAX_BEST_DESCRIPTORS, DEFAULT_MAX_DESCRIPTORS_USED, descriptorsField, headField, maxBestDescriptors, maxDescriptorsUsed, maxFreq, minFreq, minScore, minWordMatched, nbDocsField, 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
NewsClusteringConfig()
NewsClusteringConfig(NewsClusteringConfig o) Copy constructor

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this NewsClusteringConfig.
static NewsClusteringConfig	fromString(java.lang.String s) String representation of this NewsClusteringConfig.
int	getMaxSD() The maximum distance in days between 2 documents of a same cluster.
NewsClusteringConfig	makeCopy() Creates and returns a deep copy of this NewsClusteringConfig.
static NewsClusteringConfig	readFrom(java.io.InputStream is) Read this NewsClusteringConfig from an XML fragment.
void	setMaxSD(int maxSD) The maximum distance in days between 2 documents of a same cluster.
java.lang.String	toString() String representation of this NewsClusteringConfig.
NewsClusteringConfig	withClassField(java.lang.String classField)
NewsClusteringConfig	withConditions(java.util.Collection<LearningTriggerCondition> __values)
NewsClusteringConfig	withConditions(LearningTriggerCondition... __values) The list of triggering conditions. This learning job is triggered as soon as any of this condition is fulfilled.
NewsClusteringConfig	withDescriptors(java.util.Collection<Descriptor> __values)
NewsClusteringConfig	withDescriptors(Descriptor... __values) The list of MOT annotation used to extract descriptors (if empty, words are used).
NewsClusteringConfig	withDescriptorsField(java.lang.String descriptorsField)
NewsClusteringConfig	withHeadField(java.lang.String headField)
NewsClusteringConfig	withInstance(java.lang.String instance)
NewsClusteringConfig	withManagedResourceGroup(java.lang.String managedResourceGroup)
NewsClusteringConfig	withMaxBestDescriptors(int maxBestDescriptors)
NewsClusteringConfig	withMaxBestDescriptors(java.lang.Integer maxBestDescriptors)
NewsClusteringConfig	withMaxDescriptorsUsed(int maxDescriptorsUsed)
NewsClusteringConfig	withMaxDescriptorsUsed(java.lang.Integer maxDescriptorsUsed)
NewsClusteringConfig	withMaxDocumentThreshold(int maxDocumentThreshold)
NewsClusteringConfig	withMaxDocumentThreshold(java.lang.Integer maxDocumentThreshold)
NewsClusteringConfig	withMaxFreq(int maxFreq)
NewsClusteringConfig	withMaxFreq(java.lang.Integer maxFreq)
NewsClusteringConfig	withMaxSD(int maxSD)
NewsClusteringConfig	withMaxSD(java.lang.Integer maxSD)
NewsClusteringConfig	withMinDocumentRequired(int minDocumentRequired)
NewsClusteringConfig	withMinDocumentRequired(java.lang.Integer minDocumentRequired)
NewsClusteringConfig	withMinFreq(int minFreq)
NewsClusteringConfig	withMinFreq(java.lang.Integer minFreq)
NewsClusteringConfig	withMinScore(double minScore)
NewsClusteringConfig	withMinWordMatched(int minWordMatched)
NewsClusteringConfig	withMinWordMatched(java.lang.Integer minWordMatched)
NewsClusteringConfig	withNbDocsField(java.lang.String nbDocsField)
NewsClusteringConfig	withSimilarityThreshold(double similarityThreshold)
NewsClusteringConfig	withSkippedAnnotations(java.util.Collection<StringValue> __values)
NewsClusteringConfig	withSkippedAnnotations(StringValue... __values) The list of MOT annotation used to ignore tokens.
void	writeTo(java.io.OutputStream os) Write this NewsClusteringConfig as an XML fragment

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

getClassField, getDescriptorsField, getHeadField, getMaxBestDescriptors, getMaxDescriptorsUsed, getMaxFreq, getMinFreq, getMinScore, getMinWordMatched, getNbDocsField, getSimilarityThreshold, setClassField, setDescriptorsField, setHeadField, setMaxBestDescriptors, setMaxDescriptorsUsed, setMaxFreq, setMinFreq, setMinScore, setMinWordMatched, setNbDocsField, setSimilarityThreshold

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

maxSD

public int maxSD

Constructor Detail

NewsClusteringConfig

public NewsClusteringConfig()

NewsClusteringConfig

public NewsClusteringConfig(NewsClusteringConfig o)

Copy constructor

Method Detail

withSimilarityThreshold

public NewsClusteringConfig withSimilarityThreshold(double similarityThreshold)

Overrides:

withSimilarityThreshold in class ClusteringConfig

withMinScore

public NewsClusteringConfig withMinScore(double minScore)

Overrides:

withMinScore in class ClusteringConfig

withMinWordMatched

public NewsClusteringConfig withMinWordMatched(int minWordMatched)

Overrides:

withMinWordMatched in class ClusteringConfig

withMinWordMatched

public NewsClusteringConfig withMinWordMatched(java.lang.Integer minWordMatched)

Overrides:

withMinWordMatched in class ClusteringConfig

withMinFreq

public NewsClusteringConfig withMinFreq(int minFreq)

Overrides:

withMinFreq in class ClusteringConfig

withMinFreq

public NewsClusteringConfig withMinFreq(java.lang.Integer minFreq)

Overrides:

withMinFreq in class ClusteringConfig

withMaxFreq

public NewsClusteringConfig withMaxFreq(int maxFreq)

Overrides:

withMaxFreq in class ClusteringConfig

withMaxFreq

public NewsClusteringConfig withMaxFreq(java.lang.Integer maxFreq)

Overrides:

withMaxFreq in class ClusteringConfig

withClassField

public NewsClusteringConfig withClassField(java.lang.String classField)

Overrides:

withClassField in class ClusteringConfig

withHeadField

public NewsClusteringConfig withHeadField(java.lang.String headField)

Overrides:

withHeadField in class ClusteringConfig

withNbDocsField

public NewsClusteringConfig withNbDocsField(java.lang.String nbDocsField)

Overrides:

withNbDocsField in class ClusteringConfig

withMaxDescriptorsUsed

public NewsClusteringConfig withMaxDescriptorsUsed(int maxDescriptorsUsed)

Overrides:

withMaxDescriptorsUsed in class ClusteringConfig

withMaxDescriptorsUsed

public NewsClusteringConfig withMaxDescriptorsUsed(java.lang.Integer maxDescriptorsUsed)

Overrides:

withMaxDescriptorsUsed in class ClusteringConfig

withDescriptorsField

public NewsClusteringConfig withDescriptorsField(java.lang.String descriptorsField)

Overrides:

withDescriptorsField in class ClusteringConfig

withMaxBestDescriptors

public NewsClusteringConfig withMaxBestDescriptors(int maxBestDescriptors)

Overrides:

withMaxBestDescriptors in class ClusteringConfig

withMaxBestDescriptors

public NewsClusteringConfig withMaxBestDescriptors(java.lang.Integer maxBestDescriptors)

Overrides:

withMaxBestDescriptors in class ClusteringConfig

withInstance

public NewsClusteringConfig withInstance(java.lang.String instance)

Overrides:

withInstance in class ClusteringConfig

withMinDocumentRequired

public NewsClusteringConfig withMinDocumentRequired(int minDocumentRequired)

Overrides:

withMinDocumentRequired in class ClusteringConfig

withMinDocumentRequired

public NewsClusteringConfig withMinDocumentRequired(java.lang.Integer minDocumentRequired)

Overrides:

withMinDocumentRequired in class ClusteringConfig

withMaxDocumentThreshold

public NewsClusteringConfig withMaxDocumentThreshold(int maxDocumentThreshold)

Overrides:

withMaxDocumentThreshold in class ClusteringConfig

withMaxDocumentThreshold

public NewsClusteringConfig withMaxDocumentThreshold(java.lang.Integer maxDocumentThreshold)

Overrides:

withMaxDocumentThreshold in class ClusteringConfig

withDescriptors

public NewsClusteringConfig withDescriptors(Descriptor... __values)

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

Overrides:

withDescriptors in class ClusteringConfig

withDescriptors

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

Overrides:

withDescriptors in class ClusteringConfig

withSkippedAnnotations

public NewsClusteringConfig withSkippedAnnotations(StringValue... __values)

The list of MOT annotation used to ignore tokens.

Overrides:

withSkippedAnnotations in class ClusteringConfig

withSkippedAnnotations

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

Overrides:

withSkippedAnnotations in class ClusteringConfig

withConditions

public NewsClusteringConfig 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 ClusteringConfig

withConditions

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

Overrides:

withConditions in class ClusteringConfig

withManagedResourceGroup

public NewsClusteringConfig withManagedResourceGroup(java.lang.String managedResourceGroup)

Overrides:

withManagedResourceGroup in class ClusteringConfig

setMaxSD

public void setMaxSD(int maxSD)

The maximum distance in days between 2 documents of a same cluster.

getMaxSD

public int getMaxSD()

The maximum distance in days between 2 documents of a same cluster.

withMaxSD

public NewsClusteringConfig withMaxSD(int maxSD)

withMaxSD

public NewsClusteringConfig withMaxSD(java.lang.Integer maxSD)

makeCopy

public NewsClusteringConfig makeCopy()

Creates and returns a deep copy of this NewsClusteringConfig.

Overrides:

makeCopy in class ClusteringConfig

readFrom

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

Read this NewsClusteringConfig 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 NewsClusteringConfig as an XML fragment

Overrides:

writeTo in class ClusteringConfig

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this NewsClusteringConfig.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this NewsClusteringConfig.

Overrides:

toString in class ClusteringConfig

check

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

Checks this NewsClusteringConfig.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class ClusteringConfig

Throws:

com.exalead.util.TypedException