com.exalead.mercury.mami.learning.v10

Class UnSupervisedLearningConfig

java.lang.Object

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

All Implemented Interfaces:

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

Direct Known Subclasses:

ClusteringConfig, SupervisedLearningConfig

public abstract class UnSupervisedLearningConfig
extends java.lang.Object
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	UnSupervisedLearningConfig.Conditions
static class	UnSupervisedLearningConfig.Descriptors
static class	UnSupervisedLearningConfig.SkippedAnnotations

Field Summary

Fields

Modifier and Type	Field and Description
protected UnSupervisedLearningConfig.Conditions	conditions
static int	DEFAULT_MAX_DOCUMENT_THRESHOLD
static int	DEFAULT_MIN_DOCUMENT_REQUIRED
protected UnSupervisedLearningConfig.Descriptors	descriptors
java.lang.String	instance
java.lang.String	managedResourceGroup
int	maxDocumentThreshold
int	minDocumentRequired
protected UnSupervisedLearningConfig.SkippedAnnotations	skippedAnnotations

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this UnSupervisedLearningConfig.
static UnSupervisedLearningConfig	fromString(java.lang.String s) String representation of this UnSupervisedLearningConfig.
UnSupervisedLearningConfig.Conditions	getConditions()
UnSupervisedLearningConfig.Descriptors	getDescriptors()
java.lang.String	getInstance() The instance name. Each learning processor must have an unique name, this name will be part of the process name.
java.lang.String	getManagedResourceGroup() The name of the resource group as defined in the ResourceManager This ResourceGroup must have a Resource type="raw" name=instance
int	getMaxDocumentThreshold() The maximum number of documents used in the processing. This parameter allows you to limit the memory impact of clustering.
int	getMinDocumentRequired() The minimum number of documents present in cache to process. No learning will occur until this number of documents has been processed.
UnSupervisedLearningConfig.SkippedAnnotations	getSkippedAnnotations()
UnSupervisedLearningConfig	makeCopy()
static UnSupervisedLearningConfig	readFrom(java.io.InputStream is) Read this UnSupervisedLearningConfig from an XML fragment.
void	setConditions(UnSupervisedLearningConfig.Conditions __value)
void	setDescriptors(UnSupervisedLearningConfig.Descriptors __value)
void	setInstance(java.lang.String instance) The instance name. Each learning processor must have an unique name, this name will be part of the process name.
void	setManagedResourceGroup(java.lang.String managedResourceGroup) The name of the resource group as defined in the ResourceManager This ResourceGroup must have a Resource type="raw" name=instance
void	setMaxDocumentThreshold(int maxDocumentThreshold) The maximum number of documents used in the processing. This parameter allows you to limit the memory impact of clustering.
void	setMinDocumentRequired(int minDocumentRequired) The minimum number of documents present in cache to process. No learning will occur until this number of documents has been processed.
void	setSkippedAnnotations(UnSupervisedLearningConfig.SkippedAnnotations __value)
java.lang.String	toString() String representation of this UnSupervisedLearningConfig.
UnSupervisedLearningConfig	withConditions(java.util.Collection<LearningTriggerCondition> __values)
UnSupervisedLearningConfig	withConditions(LearningTriggerCondition... __values)
UnSupervisedLearningConfig	withConditions(UnSupervisedLearningConfig.Conditions __value)
UnSupervisedLearningConfig	withDescriptors(java.util.Collection<Descriptor> __values)
UnSupervisedLearningConfig	withDescriptors(Descriptor... __values)
UnSupervisedLearningConfig	withDescriptors(UnSupervisedLearningConfig.Descriptors __value)
UnSupervisedLearningConfig	withInstance(java.lang.String instance)
UnSupervisedLearningConfig	withManagedResourceGroup(java.lang.String managedResourceGroup)
UnSupervisedLearningConfig	withMaxDocumentThreshold(int maxDocumentThreshold)
UnSupervisedLearningConfig	withMaxDocumentThreshold(java.lang.Integer maxDocumentThreshold)
UnSupervisedLearningConfig	withMinDocumentRequired(int minDocumentRequired)
UnSupervisedLearningConfig	withMinDocumentRequired(java.lang.Integer minDocumentRequired)
UnSupervisedLearningConfig	withSkippedAnnotations(java.util.Collection<StringValue> __values)
UnSupervisedLearningConfig	withSkippedAnnotations(StringValue... __values)
UnSupervisedLearningConfig	withSkippedAnnotations(UnSupervisedLearningConfig.SkippedAnnotations __value)
void	writeTo(java.io.OutputStream os)

Methods inherited from class java.lang.Object

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

Field Detail

instance

public java.lang.String instance

minDocumentRequired

public int minDocumentRequired

DEFAULT_MIN_DOCUMENT_REQUIRED

public static final int DEFAULT_MIN_DOCUMENT_REQUIRED

See Also:

Constant Field Values

maxDocumentThreshold

public int maxDocumentThreshold

DEFAULT_MAX_DOCUMENT_THRESHOLD

public static final int DEFAULT_MAX_DOCUMENT_THRESHOLD

See Also:

Constant Field Values

descriptors

protected UnSupervisedLearningConfig.Descriptors descriptors

skippedAnnotations

protected UnSupervisedLearningConfig.SkippedAnnotations skippedAnnotations

conditions

protected UnSupervisedLearningConfig.Conditions conditions

managedResourceGroup

public java.lang.String managedResourceGroup

Constructor Detail

UnSupervisedLearningConfig

public UnSupervisedLearningConfig()

UnSupervisedLearningConfig

public UnSupervisedLearningConfig(UnSupervisedLearningConfig o)

Copy constructor

Method Detail

setInstance

public void setInstance(java.lang.String instance)

The instance name.
Each learning processor must have an unique name, this name will
be part of the process name. In a ClassifierConfig, this instance name
will also be used to find the prediction processor.

getInstance

public java.lang.String getInstance()

The instance name.
Each learning processor must have an unique name, this name will
be part of the process name. In a ClassifierConfig, this instance name
will also be used to find the prediction processor.

withInstance

public UnSupervisedLearningConfig withInstance(java.lang.String instance)

setMinDocumentRequired

public void setMinDocumentRequired(int minDocumentRequired)

The minimum number of documents present in cache to process.
No learning will occur until this number of documents has been processed.

getMinDocumentRequired

public int getMinDocumentRequired()

The minimum number of documents present in cache to process.
No learning will occur until this number of documents has been processed.

withMinDocumentRequired

public UnSupervisedLearningConfig withMinDocumentRequired(int minDocumentRequired)

withMinDocumentRequired

public UnSupervisedLearningConfig withMinDocumentRequired(java.lang.Integer minDocumentRequired)

setMaxDocumentThreshold

public void setMaxDocumentThreshold(int maxDocumentThreshold)

The maximum number of documents used in the processing.
This parameter allows you to limit the memory impact of clustering.

getMaxDocumentThreshold

public int getMaxDocumentThreshold()

The maximum number of documents used in the processing.
This parameter allows you to limit the memory impact of clustering.

withMaxDocumentThreshold

public UnSupervisedLearningConfig withMaxDocumentThreshold(int maxDocumentThreshold)

withMaxDocumentThreshold

public UnSupervisedLearningConfig withMaxDocumentThreshold(java.lang.Integer maxDocumentThreshold)

getDescriptors

public UnSupervisedLearningConfig.Descriptors getDescriptors()

setDescriptors

public void setDescriptors(UnSupervisedLearningConfig.Descriptors __value)

withDescriptors

public UnSupervisedLearningConfig withDescriptors(Descriptor... __values)

withDescriptors

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

withDescriptors

public UnSupervisedLearningConfig withDescriptors(UnSupervisedLearningConfig.Descriptors __value)

getSkippedAnnotations

public UnSupervisedLearningConfig.SkippedAnnotations getSkippedAnnotations()

setSkippedAnnotations

public void setSkippedAnnotations(UnSupervisedLearningConfig.SkippedAnnotations __value)

withSkippedAnnotations

public UnSupervisedLearningConfig withSkippedAnnotations(StringValue... __values)

withSkippedAnnotations

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

withSkippedAnnotations

public UnSupervisedLearningConfig withSkippedAnnotations(UnSupervisedLearningConfig.SkippedAnnotations __value)

getConditions

public UnSupervisedLearningConfig.Conditions getConditions()

setConditions

public void setConditions(UnSupervisedLearningConfig.Conditions __value)

withConditions

public UnSupervisedLearningConfig withConditions(LearningTriggerCondition... __values)

withConditions

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

withConditions

public UnSupervisedLearningConfig withConditions(UnSupervisedLearningConfig.Conditions __value)

setManagedResourceGroup

public void setManagedResourceGroup(java.lang.String managedResourceGroup)

The name of the resource group as defined in the ResourceManager
This ResourceGroup must have a Resource type="raw" name=instance

getManagedResourceGroup

public java.lang.String getManagedResourceGroup()

The name of the resource group as defined in the ResourceManager
This ResourceGroup must have a Resource type="raw" name=instance

withManagedResourceGroup

public UnSupervisedLearningConfig withManagedResourceGroup(java.lang.String managedResourceGroup)

makeCopy

public UnSupervisedLearningConfig makeCopy()

readFrom

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

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

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this UnSupervisedLearningConfig.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this UnSupervisedLearningConfig.

Overrides:

toString in class java.lang.Object

check

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

Checks this UnSupervisedLearningConfig.

Specified by:

check in interface com.exalead.util.Checkable

Throws:

com.exalead.util.TypedException