com.exalead.mercury.mami.learning.v10

Class SupervisedLearningConfig

java.lang.Object

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

com.exalead.mercury.mami.learning.v10.SupervisedLearningConfig

All Implemented Interfaces:

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

Direct Known Subclasses:

ClassifierConfig

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

No documentation for this element.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SupervisedLearningConfig.Categories

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
protected SupervisedLearningConfig.Categories	categories
java.lang.String	meta

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
SupervisedLearningConfig()
SupervisedLearningConfig(SupervisedLearningConfig o) Copy constructor

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this SupervisedLearningConfig.
static SupervisedLearningConfig	fromString(java.lang.String s) String representation of this SupervisedLearningConfig.
SupervisedLearningConfig.Categories	getCategories()
java.lang.String	getMeta() Name of the meta storing the pre-classified document category name.
SupervisedLearningConfig	makeCopy()
static SupervisedLearningConfig	readFrom(java.io.InputStream is) Read this SupervisedLearningConfig from an XML fragment.
void	setCategories(SupervisedLearningConfig.Categories __value)
void	setMeta(java.lang.String meta) Name of the meta storing the pre-classified document category name.
java.lang.String	toString() String representation of this SupervisedLearningConfig.
SupervisedLearningConfig	withCategories(Category... __values)
SupervisedLearningConfig	withCategories(java.util.Collection<Category> __values)
SupervisedLearningConfig	withCategories(SupervisedLearningConfig.Categories __value)
SupervisedLearningConfig	withConditions(java.util.Collection<LearningTriggerCondition> __values)
SupervisedLearningConfig	withConditions(LearningTriggerCondition... __values) The list of triggering conditions. This learning job is triggered as soon as any of this condition is fulfilled.
SupervisedLearningConfig	withDescriptors(java.util.Collection<Descriptor> __values)
SupervisedLearningConfig	withDescriptors(Descriptor... __values) The list of MOT annotation used to extract descriptors (if empty, words are used).
SupervisedLearningConfig	withInstance(java.lang.String instance)
SupervisedLearningConfig	withManagedResourceGroup(java.lang.String managedResourceGroup)
SupervisedLearningConfig	withMaxDocumentThreshold(int maxDocumentThreshold)
SupervisedLearningConfig	withMaxDocumentThreshold(java.lang.Integer maxDocumentThreshold)
SupervisedLearningConfig	withMeta(java.lang.String meta)
SupervisedLearningConfig	withMinDocumentRequired(int minDocumentRequired)
SupervisedLearningConfig	withMinDocumentRequired(java.lang.Integer minDocumentRequired)
SupervisedLearningConfig	withSkippedAnnotations(java.util.Collection<StringValue> __values)
SupervisedLearningConfig	withSkippedAnnotations(StringValue... __values) The list of MOT annotation used to ignore tokens.
void	writeTo(java.io.OutputStream os)

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

meta

public java.lang.String meta

categories

protected SupervisedLearningConfig.Categories categories

Constructor Detail

SupervisedLearningConfig

public SupervisedLearningConfig()

SupervisedLearningConfig

public SupervisedLearningConfig(SupervisedLearningConfig o)

Copy constructor

Method Detail

withInstance

public SupervisedLearningConfig withInstance(java.lang.String instance)

Overrides:

withInstance in class UnSupervisedLearningConfig

withMinDocumentRequired

public SupervisedLearningConfig withMinDocumentRequired(int minDocumentRequired)

Overrides:

withMinDocumentRequired in class UnSupervisedLearningConfig

withMinDocumentRequired

public SupervisedLearningConfig withMinDocumentRequired(java.lang.Integer minDocumentRequired)

Overrides:

withMinDocumentRequired in class UnSupervisedLearningConfig

withMaxDocumentThreshold

public SupervisedLearningConfig withMaxDocumentThreshold(int maxDocumentThreshold)

Overrides:

withMaxDocumentThreshold in class UnSupervisedLearningConfig

withMaxDocumentThreshold

public SupervisedLearningConfig withMaxDocumentThreshold(java.lang.Integer maxDocumentThreshold)

Overrides:

withMaxDocumentThreshold in class UnSupervisedLearningConfig

withDescriptors

public SupervisedLearningConfig withDescriptors(Descriptor... __values)

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

Overrides:

withDescriptors in class UnSupervisedLearningConfig

withDescriptors

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

Overrides:

withDescriptors in class UnSupervisedLearningConfig

withSkippedAnnotations

public SupervisedLearningConfig withSkippedAnnotations(StringValue... __values)

The list of MOT annotation used to ignore tokens.

Overrides:

withSkippedAnnotations in class UnSupervisedLearningConfig

withSkippedAnnotations

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

Overrides:

withSkippedAnnotations in class UnSupervisedLearningConfig

withConditions

public SupervisedLearningConfig 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 SupervisedLearningConfig withConditions(java.util.Collection<LearningTriggerCondition> __values)

Overrides:

withConditions in class UnSupervisedLearningConfig

withManagedResourceGroup

public SupervisedLearningConfig withManagedResourceGroup(java.lang.String managedResourceGroup)

Overrides:

withManagedResourceGroup in class UnSupervisedLearningConfig

setMeta

public void setMeta(java.lang.String meta)

Name of the meta storing the pre-classified document category name.

getMeta

public java.lang.String getMeta()

Name of the meta storing the pre-classified document category name.

withMeta

public SupervisedLearningConfig withMeta(java.lang.String meta)

getCategories

public SupervisedLearningConfig.Categories getCategories()

setCategories

public void setCategories(SupervisedLearningConfig.Categories __value)

withCategories

public SupervisedLearningConfig withCategories(Category... __values)

withCategories

public SupervisedLearningConfig withCategories(java.util.Collection<Category> __values)

withCategories

public SupervisedLearningConfig withCategories(SupervisedLearningConfig.Categories __value)

makeCopy

public SupervisedLearningConfig makeCopy()

Overrides:

makeCopy in class UnSupervisedLearningConfig

readFrom

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

Read this SupervisedLearningConfig 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

Overrides:

writeTo in class UnSupervisedLearningConfig

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this SupervisedLearningConfig.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this SupervisedLearningConfig.

Overrides:

toString in class UnSupervisedLearningConfig

check

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

Checks this SupervisedLearningConfig.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class UnSupervisedLearningConfig

Throws:

com.exalead.util.TypedException