|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectedu.udo.cs.miningmart.m4.core.ParamDict
A class to store the parameters of an operator (step).
Constructor Summary | |
ParamDict()
|
Method Summary | |
boolean |
containsKey(java.lang.String paramName)
Checks whether for the given parameter name an entry is stored. |
boolean |
containsKey(java.lang.String paramName,
int loopNr)
Checks whether for the given parameter name and a specific loop nr. |
boolean |
containsParamArray(ParameterArray paramArray)
Checks whether the given object exists as a value in the dictionary. |
ParameterArray |
get(java.lang.String paramName)
|
ParameterArray |
get(java.lang.String paramName,
int loopNr)
|
boolean |
isLooped(java.lang.String paramName)
|
void |
put(java.lang.String paramName,
int loopNr,
ParameterArray theParameter)
|
void |
put(java.lang.String paramName,
ParameterArray theParameter)
Add a parameter to the dictionary. |
boolean |
removeParamArray(ParameterArray paramArray)
If the given object exists as a value in the dictionary, then this method removes it. |
void |
replace(java.lang.String paramName,
int loopNr,
ParameterArray theParameter)
replaces the parameter of referenced by a specific name for a specific loop nr |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public ParamDict()
Method Detail |
public void put(java.lang.String paramName, ParameterArray theParameter) throws M4Exception
put
in interface ParamDict
paramName
- the name of the parameter as found in table OP_PARAM_TtheParameter
- a ParameterArray object representing a parameter to be stored.
M4Exception
public void put(java.lang.String paramName, int loopNr, ParameterArray theParameter) throws M4Exception
put
in interface ParamDict
M4Exception
put(String, Object), just with the loop nr as an additional parameter
public void replace(java.lang.String paramName, int loopNr, ParameterArray theParameter) throws M4Exception
replace
in interface ParamDict
paramName
- the name of the key - the parameter nameloopNr
- the loop nrtheParameter
- the new parameter value
M4Exception
public boolean containsKey(java.lang.String paramName)
containsKey
in interface ParamDict
paramName
- the name of the parameterpublic boolean containsKey(java.lang.String paramName, int loopNr)
containsKey
in interface ParamDict
public boolean containsParamArray(ParameterArray paramArray)
containsParamArray
in interface ParamDict
paramArray
- the object to check for
true
iff the object was foundpublic boolean removeParamArray(ParameterArray paramArray)
removeParamArray
in interface ParamDict
paramArray
- the object to remove
true
iff the object could be removedpublic ParameterArray get(java.lang.String paramName) throws M4Exception
get
in interface ParamDict
paramName
- the name of the parameter to be looked up
null
otherwise.
in case of loopsteps use the method get(String, int)
instead.
M4Exception
public ParameterArray get(java.lang.String paramName, int loopNr)
get
in interface ParamDict
paramName
- the name of the parameter to be looked uploopNr
- the loop nr. for which to look up the parameter.
Note that the first loopNr is "0", no matter if we have a looped
parameter or not.
null
otherwise.public boolean isLooped(java.lang.String paramName)
isLooped
in interface ParamDict
paramName
- name of a parameter
true
iff the specified parameter is looped in the current step.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |