CFEngine API

org.recommender.algorithms
Class ParameterSet

java.lang.Object
  |
  +--org.recommender.algorithms.ParameterSet
Direct Known Subclasses:
SimpleParameterSet

public abstract class ParameterSet
extends java.lang.Object

A ParameterSet represents all parameters necessary to specify an algorithm. Parameters are algorithm-dependent. The abstract class ParameterSet provides utility methods for retrieving parameters as integers, floats, or booleans. Implementing classes must provide a method for getting the original string value of a parameter.

Author:
Daniel Lowd

Constructor Summary
ParameterSet()
           
 
Method Summary
abstract  java.lang.String getAllParams()
          Child classes are responsible for implementing this method, as well as some way to construct a ParameterSet.
 boolean getBoolean(java.lang.String paramName, boolean defaultVal)
          Get parameter's boolean value, if not defined, return default value
 float getFloat(java.lang.String paramName, float defaultVal)
          Get parameter's float value, if not defined, return default value
 int getInt(java.lang.String paramName, int defaultVal)
          Get parameter's int value, if not defined, return default value
abstract  java.lang.String getString(java.lang.String paramName)
          Child classes are responsible for implementing this method, as well as some way to construct a ParameterSet.
abstract  java.lang.String getString(java.lang.String paramName, java.lang.String defaultVal)
          Child classes are responsible for implementing this method, as well as some way to construct a ParameterSet.
abstract  void setString(java.lang.String paramName, java.lang.String value)
          Child classes are responsible for implementing this method, as well as some way to construct a ParameterSet.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ParameterSet

public ParameterSet()
Method Detail

getString

public abstract java.lang.String getString(java.lang.String paramName)
Child classes are responsible for implementing this method, as well as some way to construct a ParameterSet.


getString

public abstract java.lang.String getString(java.lang.String paramName,
                                           java.lang.String defaultVal)
Child classes are responsible for implementing this method, as well as some way to construct a ParameterSet.


setString

public abstract void setString(java.lang.String paramName,
                               java.lang.String value)
Child classes are responsible for implementing this method, as well as some way to construct a ParameterSet.


getAllParams

public abstract java.lang.String getAllParams()
Child classes are responsible for implementing this method, as well as some way to construct a ParameterSet.


getInt

public int getInt(java.lang.String paramName,
                  int defaultVal)
Get parameter's int value, if not defined, return default value

Parameters:
paramName -
defaultVal -
Returns:
int value of the parameter

getFloat

public float getFloat(java.lang.String paramName,
                      float defaultVal)
Get parameter's float value, if not defined, return default value

Parameters:
paramName -
defaultVal -
Returns:
float value of the parameter

getBoolean

public boolean getBoolean(java.lang.String paramName,
                          boolean defaultVal)
Get parameter's boolean value, if not defined, return default value

Parameters:
paramName -
defaultVal -
Returns:
boolean value of the parameter

CFEngine API

Copyright © 2003 - Oregon State University www.orst.edu