marf.Storage
Class ModuleParams

java.lang.Object
  marf.Storage.ModuleParams

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class ModuleParams
extends java.lang.Object
implements java.lang.Cloneable, java.io.Serializable

Class ModuleParams provides ability to pass module-specific parameters from an application. The specific module should know in which order and how to downcast those params. ModuleParams is Cloneable and starting 0.3.0.6 Serializable.

$Id: ModuleParams.java,v 1.19 2007/12/23 06:29:46 mokhov Exp $

Since:

0.0.1

Version:

$Revision: 1.19 $

Author:

Serguei Mokhov

See Also:

Serialized Form

Field Summary

protected static int	CLASSIFICATION Indicates that we manipulate on the Classification Vector.
protected static int	FEATURE_EXTRACTION Indicates that we manipulate on the Feature Extraction Vector.
protected java.util.Vector	oClassificationParams A Vector of classification parameters.
protected java.util.Vector	oFeatureExtractionParams A Vector of feature extraction parameters.
protected java.util.Vector	oPreprocessingParams A Vector of preprocessing parameters.
protected static int	PREPROCESSING Indicates that we manipulate on the Preprocessing Vector.

Constructor Summary

ModuleParams()
Default Constructor.

ModuleParams(ModuleParams poModuleParams)
Copy-constructor.

Method Summary

void	addClassificationParam(java.lang.Object poParam) Adds (appends) a single classification parameter object.
void	addClassificationParams(java.util.Vector poParams) Adds (appends) classification parameters vector.
void	addFeatureExtractionParam(java.lang.Object poParam) Adds (appends) a single feature extraction parameter object.
void	addFeatureExtractionParams(java.util.Vector poParams) Adds (appends) feature extraction parameters vector.
void	addPreprocessingParam(java.lang.Object poParam) Adds (appends) a single preprocessing parameter object.
void	addPreprocessingParams(java.util.Vector poParams) Adds (appends) preprocessing parameters vector.
java.lang.Object	clone() Implements Cloneable interface for ModuleParams.
java.util.Vector	getClassificationParams() Retrieves Classification module's parameters.
java.util.Vector	getFeatureExtractionParams() Retrieves Feature Extraction module's parameters.
static java.lang.String	getMARFSourceCodeRevision() Returns source code revision information.
java.util.Vector	getPreprocessingParams() Retrieves Preprocessing module's parameters.
void	setClassificationParams(java.util.Vector poParams) Sets classification parameters vector.
void	setFeatureExtractionParams(java.util.Vector poParams) Sets feature extraction parameters vector.
void	setPreprocessingParams(java.util.Vector poParams) Sets preprocessing parameters vector.
int	size() Returns the size of this set of module parameters as a sum of sizes of preprocessing, feature extraction, and classification module parameters.
java.lang.String	toString() Retrieves string version of all three types of parameters.

Methods inherited from class java.lang.Object

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

Field Detail

oPreprocessingParams

protected java.util.Vector oPreprocessingParams

A Vector of preprocessing parameters.

oFeatureExtractionParams

protected java.util.Vector oFeatureExtractionParams

A Vector of feature extraction parameters.

oClassificationParams

protected java.util.Vector oClassificationParams

A Vector of classification parameters.

PREPROCESSING

protected static final int PREPROCESSING

Indicates that we manipulate on the Preprocessing Vector.

See Also:

Constant Field Values

FEATURE_EXTRACTION

protected static final int FEATURE_EXTRACTION

Indicates that we manipulate on the Feature Extraction Vector.

See Also:

Constant Field Values

CLASSIFICATION

protected static final int CLASSIFICATION

Indicates that we manipulate on the Classification Vector.

See Also:

Constant Field Values

Constructor Detail

ModuleParams

public ModuleParams()

Default Constructor. Does nothing extra.

ModuleParams

public ModuleParams(ModuleParams poModuleParams)

Copy-constructor.

Parameters:

poModuleParams - object to make a copy of

Since:

0.3.0.5

Method Detail

getPreprocessingParams

public final java.util.Vector getPreprocessingParams()

Retrieves Preprocessing module's parameters.

Returns:

preprocessing parameters vector

setPreprocessingParams

public final void setPreprocessingParams(java.util.Vector poParams)

Sets preprocessing parameters vector.

Parameters:

poParams - parameters vector

addPreprocessingParams

public final void addPreprocessingParams(java.util.Vector poParams)

Adds (appends) preprocessing parameters vector.

Parameters:

poParams - parameters vector to append

addPreprocessingParam

public final void addPreprocessingParam(java.lang.Object poParam)

Adds (appends) a single preprocessing parameter object.

Parameters:

poParam - object to append

getFeatureExtractionParams

public final java.util.Vector getFeatureExtractionParams()

Retrieves Feature Extraction module's parameters.

Returns:

feature extraction parameters vector

setFeatureExtractionParams

public final void setFeatureExtractionParams(java.util.Vector poParams)

Sets feature extraction parameters vector.

Parameters:

poParams - parameters vector

addFeatureExtractionParams

public final void addFeatureExtractionParams(java.util.Vector poParams)

Adds (appends) feature extraction parameters vector.

Parameters:

poParams - parameters vector to append

addFeatureExtractionParam

public final void addFeatureExtractionParam(java.lang.Object poParam)

Adds (appends) a single feature extraction parameter object.

Parameters:

poParam - object to append

getClassificationParams

public final java.util.Vector getClassificationParams()

Retrieves Classification module's parameters.

Returns:

classification parameters vector

setClassificationParams

public final void setClassificationParams(java.util.Vector poParams)

Sets classification parameters vector.

Parameters:

poParams - parameters vector

addClassificationParams

public final void addClassificationParams(java.util.Vector poParams)

Adds (appends) classification parameters vector.

Parameters:

poParams - parameters vector to append

addClassificationParam

public final void addClassificationParam(java.lang.Object poParam)

Adds (appends) a single classification parameter object.

Parameters:

poParam - object to append

toString

public java.lang.String toString()

Retrieves string version of all three types of parameters.

Overrides:

toString in class java.lang.Object

Returns:

String representation of this ModuleParams object

Since:

0.3.0.5

See Also:

Object.toString()

size

public int size()

Returns the size of this set of module parameters as a sum of sizes of preprocessing, feature extraction, and classification module parameters.

Returns:

the total number of parameters

Since:

0.3.0.5

clone

public java.lang.Object clone()

Implements Cloneable interface for ModuleParams.

Overrides:

clone in class java.lang.Object

Since:

0.3.0.5

See Also:

Object.clone()

getMARFSourceCodeRevision

public static java.lang.String getMARFSourceCodeRevision()

Returns source code revision information.

Returns:

revision string

Since:

0.3.0.2