org.kepler.provenance

Class RecordingParameters

java.lang.Object

org.kepler.provenance.RecordingParameters

Direct Known Subclasses:

SQLRecordingParameters, TextFileRecording.TextFileRecordingParameters, XMLRecording.XMLRecordingParameters

public class RecordingParameters
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<java.lang.String,Parameter>	_params A mapping of parameter name to Parameter.

Constructor Summary

Constructors

Constructor and Description
RecordingParameters(NamedObj no) Create a new set of parameters.

Method Summary

Modifier and Type	Method and Description
protected void	addBooleanParameter(java.lang.String name, boolean value) Add a boolean parameter with a default value.
protected void	addFileParameter(java.lang.String name, java.lang.String value) Add a file parameter with default value.
protected void	addIntParameter(java.lang.String name, int value) Add an integer parameter.
protected void	addStringParameter(java.lang.String name) Add a string parameter.
protected void	addStringParameter(java.lang.String name, java.lang.String value) Add a string parameter with default value.
protected void	addStringParameterChoice(java.lang.String name, java.lang.String choice) Add a choice to a string parameter.
boolean	containsName(java.lang.String name) Check if the set contains a specific name.
boolean	containsParameter(Attribute attribute) See if set contains a specific parameter.
protected java.lang.Boolean	getBooleanValue(java.lang.String name) Get the value of a boolean parameter.
java.util.Map<java.lang.String,java.lang.String>	getNamesValues() Get all the parameter name-value pairs.
java.lang.String	getStringValue(java.lang.String name) Get the value of a string parameter.
java.util.Collection<java.lang.String>	names() Get all the names as a Collection.
void	replaceContainer(java.lang.String name, NamedObj no) Replace a specific Parameter's container.
void	replaceParameter(java.lang.String name, Parameter parameter) Replace a specific Parameter.
void	setPersistent(boolean persistent) Set the persistency of all parameters.

Methods inherited from class java.lang.Object

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

Field Detail

_params

protected java.util.Map<java.lang.String,Parameter> _params

A mapping of parameter name to Parameter.

Constructor Detail

RecordingParameters

public RecordingParameters(NamedObj no)

Create a new set of parameters. New Parameters will use no for their container.

Method Detail

containsName

public boolean containsName(java.lang.String name)

Check if the set contains a specific name.

containsParameter

public boolean containsParameter(Attribute attribute)

See if set contains a specific parameter.

getNamesValues

public java.util.Map<java.lang.String,java.lang.String> getNamesValues()

Get all the parameter name-value pairs.

names

public java.util.Collection<java.lang.String> names()

Get all the names as a Collection.

replaceContainer

public void replaceContainer(java.lang.String name,
                             NamedObj no)
                      throws IllegalActionException,
                             NameDuplicationException

Replace a specific Parameter's container.

Throws:

IllegalActionException

NameDuplicationException

replaceParameter

public void replaceParameter(java.lang.String name,
                             Parameter parameter)
                      throws IllegalActionException

Replace a specific Parameter.

Throws:

IllegalActionException

setPersistent

public void setPersistent(boolean persistent)

Set the persistency of all parameters.

addIntParameter

protected void addIntParameter(java.lang.String name,
                               int value)
                        throws IllegalActionException,
                               NameDuplicationException

Add an integer parameter.

Throws:

IllegalActionException

NameDuplicationException

addStringParameter

protected void addStringParameter(java.lang.String name)
                           throws IllegalActionException,
                                  NameDuplicationException

Add a string parameter.

Throws:

IllegalActionException

NameDuplicationException

addStringParameter

protected void addStringParameter(java.lang.String name,
                                  java.lang.String value)
                           throws IllegalActionException,
                                  NameDuplicationException

Add a string parameter with default value.

Throws:

IllegalActionException

NameDuplicationException

addStringParameterChoice

protected void addStringParameterChoice(java.lang.String name,
                                        java.lang.String choice)
                                 throws IllegalActionException

Add a choice to a string parameter.

Throws:

IllegalActionException

addBooleanParameter

protected void addBooleanParameter(java.lang.String name,
                                   boolean value)
                            throws IllegalActionException,
                                   NameDuplicationException

Add a boolean parameter with a default value.

Throws:

IllegalActionException

NameDuplicationException

addFileParameter

protected void addFileParameter(java.lang.String name,
                                java.lang.String value)
                         throws IllegalActionException,
                                NameDuplicationException

Add a file parameter with default value.

Throws:

IllegalActionException

NameDuplicationException

getStringValue

public java.lang.String getStringValue(java.lang.String name)
                                throws IllegalActionException

Get the value of a string parameter.

Throws:

IllegalActionException

getBooleanValue

protected java.lang.Boolean getBooleanValue(java.lang.String name)
                                     throws IllegalActionException

Get the value of a boolean parameter.

Throws:

IllegalActionException