gov.sandia.cognition.framework.learning

Class EvaluatorBasedCognitiveModuleFactory<InputType,OutputType>

java.lang.Object

gov.sandia.cognition.util.AbstractCloneableSerializable

gov.sandia.cognition.framework.learning.EvaluatorBasedCognitiveModuleFactory<InputType,OutputType>

Type Parameters:

InputType - Input type of the embedded Evaluator

OutputType - Output type of the embedded Evaluator

All Implemented Interfaces:

CognitiveModuleFactory, CloneableSerializable, java.io.Serializable, java.lang.Cloneable

public class EvaluatorBasedCognitiveModuleFactory<InputType,OutputType>
extends AbstractCloneableSerializable
implements CognitiveModuleFactory

The EvaluatorBasedCognitiveModuleFactory class implements a factory for the EvaluatorBasedCognitiveModule. When a module is created the factory checks to see if the underlying evaluator is a StatefulEvaluator to determine if a normal EvaluatorBasedCognitiveModule should be created (non-stateful) or a StatefulEvaluatorBasedCognitiveModule should be created (stateful).

Since:

2.0

Author:

Justin Basilico, Kevin R. Dixon

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
EvaluatorBasedCognitiveModuleFactory() Creates a new instance of EvaluatorBasedCognitiveModuleFactory.
EvaluatorBasedCognitiveModuleFactory(EvaluatorBasedCognitiveModuleFactory<InputType,OutputType> other) Creates a new copy of a EvaluatorBasedCognitiveModuleFactory.
EvaluatorBasedCognitiveModuleFactory(EvaluatorBasedCognitiveModuleSettings<InputType,OutputType> settings, java.lang.String name) Creates a new instance of EvaluatorBasedCognitiveModuleFactory.

Method Summary

Modifier and Type	Method and Description
EvaluatorBasedCognitiveModuleFactory<InputType,OutputType>	clone() Creates a clone of this EvaluatorBasedCognitiveModuleFactory.
CognitiveModule	createModule(CognitiveModel model) Creates a new CognitiveModule for the given CognitiveModel.
java.lang.String	getName() Getter for name
EvaluatorBasedCognitiveModuleSettings<InputType,OutputType>	getSettings() Gets the settings of the module created by the factory.
void	setName(java.lang.String name) Setter for name
void	setSettings(EvaluatorBasedCognitiveModuleSettings<InputType,OutputType> settings) Sets the settings of the module created by the factory.

Methods inherited from class java.lang.Object

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

Constructor Detail

EvaluatorBasedCognitiveModuleFactory

public EvaluatorBasedCognitiveModuleFactory()

Creates a new instance of EvaluatorBasedCognitiveModuleFactory.

EvaluatorBasedCognitiveModuleFactory

public EvaluatorBasedCognitiveModuleFactory(EvaluatorBasedCognitiveModuleSettings<InputType,OutputType> settings,
                                            java.lang.String name)

Creates a new instance of EvaluatorBasedCognitiveModuleFactory.

Parameters:

name - Human-readable name of the module

settings - The settings for the module.

EvaluatorBasedCognitiveModuleFactory

public EvaluatorBasedCognitiveModuleFactory(EvaluatorBasedCognitiveModuleFactory<InputType,OutputType> other)

Creates a new copy of a EvaluatorBasedCognitiveModuleFactory.

Parameters:

other - The other EvaluatorBasedCognitiveModuleFactory to copy.

Method Detail

clone

public EvaluatorBasedCognitiveModuleFactory<InputType,OutputType> clone()

Creates a clone of this EvaluatorBasedCognitiveModuleFactory.

Specified by:

clone in interface CloneableSerializable

Overrides:

clone in class AbstractCloneableSerializable

Returns:

A clone of this object.

createModule

public CognitiveModule createModule(CognitiveModel model)

Creates a new CognitiveModule for the given CognitiveModel.

Specified by:

createModule in interface CognitiveModuleFactory

Parameters:

model - The model to create a new module for

Returns:

A new CognitiveModule for the given model

getSettings

public EvaluatorBasedCognitiveModuleSettings<InputType,OutputType> getSettings()

Gets the settings of the module created by the factory.

Returns:

The settings of the module created by the factory.

setSettings

public void setSettings(EvaluatorBasedCognitiveModuleSettings<InputType,OutputType> settings)

Sets the settings of the module created by the factory.

Parameters:

settings - The settings of the module created by the factory.

getName

public java.lang.String getName()

Getter for name

Returns:

Human-readable name of the module

setName

public void setName(java.lang.String name)

Setter for name

Parameters:

name - Human-readable name of the module