com.exalead.mercury.mami.learning.v10

Class LearningConfig

java.lang.Object

com.exalead.mercury.mami.learning.v10.LearningConfig

All Implemented Interfaces:

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

public class LearningConfig
extends java.lang.Object
implements com.exalead.util.Checkable, java.io.Serializable

A LearningConfig defines how a learning job is applied on a flow of documents().
A learning job is bound to a build group and processes documents sent to the PushServer.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	buildGroup
java.util.List<ClassifierConfig>	classifierConfig
ClusteringConfig	clusteringConfig
java.lang.String	contexts
static java.lang.String	DEFAULT_CONTEXTS
java.lang.String	pipelineConfig
StorageConfig	storageConfig

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this LearningConfig.
static LearningConfig	fromString(java.lang.String s) String representation of this LearningConfig.
java.lang.String	getBuildGroup() The associated buildGroup name.
java.util.List<ClassifierConfig>	getClassifierConfig()
ClusteringConfig	getClusteringConfig()
java.lang.String	getContexts() Comma-separated list of contexts used by the learning.
java.lang.String	getPipelineConfig() Reference to the document pipeline to use in order to generate the annotations.
StorageConfig	getStorageConfig()
LearningConfig	makeCopy() Creates and returns a deep copy of this LearningConfig.
static LearningConfig	readFrom(java.io.InputStream is) Read this LearningConfig from an XML fragment.
void	setBuildGroup(java.lang.String buildGroup) The associated buildGroup name.
void	setClusteringConfig(ClusteringConfig clusteringConfig)
void	setContexts(java.lang.String contexts) Comma-separated list of contexts used by the learning.
void	setPipelineConfig(java.lang.String pipelineConfig) Reference to the document pipeline to use in order to generate the annotations.
void	setStorageConfig(StorageConfig storageConfig)
java.lang.String	toString() String representation of this LearningConfig.
LearningConfig	withBuildGroup(java.lang.String buildGroup)
LearningConfig	withClassifierConfig(ClassifierConfig... __values)
LearningConfig	withClassifierConfig(java.util.Collection<ClassifierConfig> __values)
LearningConfig	withClusteringConfig(ClusteringConfig clusteringConfig)
LearningConfig	withContexts(java.lang.String contexts)
LearningConfig	withPipelineConfig(java.lang.String pipelineConfig)
LearningConfig	withStorageConfig(StorageConfig storageConfig)
void	writeTo(java.io.OutputStream os) Write this LearningConfig as an XML fragment

Methods inherited from class java.lang.Object

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

Field Detail

storageConfig

public StorageConfig storageConfig

classifierConfig

public java.util.List<ClassifierConfig> classifierConfig

clusteringConfig

public ClusteringConfig clusteringConfig

buildGroup

public java.lang.String buildGroup

pipelineConfig

public java.lang.String pipelineConfig

contexts

public java.lang.String contexts

DEFAULT_CONTEXTS

public static final java.lang.String DEFAULT_CONTEXTS

See Also:

Constant Field Values

Constructor Detail

LearningConfig

public LearningConfig()

LearningConfig

public LearningConfig(LearningConfig o)

Copy constructor

Method Detail

setStorageConfig

public void setStorageConfig(StorageConfig storageConfig)

getStorageConfig

public StorageConfig getStorageConfig()

withStorageConfig

public LearningConfig withStorageConfig(StorageConfig storageConfig)

getClassifierConfig

public java.util.List<ClassifierConfig> getClassifierConfig()

withClassifierConfig

public LearningConfig withClassifierConfig(ClassifierConfig... __values)

withClassifierConfig

public LearningConfig withClassifierConfig(java.util.Collection<ClassifierConfig> __values)

setClusteringConfig

public void setClusteringConfig(ClusteringConfig clusteringConfig)

getClusteringConfig

public ClusteringConfig getClusteringConfig()

withClusteringConfig

public LearningConfig withClusteringConfig(ClusteringConfig clusteringConfig)

setBuildGroup

public void setBuildGroup(java.lang.String buildGroup)

The associated buildGroup name.

getBuildGroup

public java.lang.String getBuildGroup()

The associated buildGroup name.

withBuildGroup

public LearningConfig withBuildGroup(java.lang.String buildGroup)

setPipelineConfig

public void setPipelineConfig(java.lang.String pipelineConfig)

Reference to the document pipeline to use in order to generate the annotations.

getPipelineConfig

public java.lang.String getPipelineConfig()

Reference to the document pipeline to use in order to generate the annotations.

withPipelineConfig

public LearningConfig withPipelineConfig(java.lang.String pipelineConfig)

setContexts

public void setContexts(java.lang.String contexts)

Comma-separated list of contexts used by the learning.

getContexts

public java.lang.String getContexts()

Comma-separated list of contexts used by the learning.

withContexts

public LearningConfig withContexts(java.lang.String contexts)

makeCopy

public LearningConfig makeCopy()

Creates and returns a deep copy of this LearningConfig.

readFrom

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

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

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this LearningConfig.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this LearningConfig.

Overrides:

toString in class java.lang.Object

check

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

Checks this LearningConfig.

Specified by:

check in interface com.exalead.util.Checkable

Throws:

com.exalead.util.TypedException