|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectedu.udo.cs.miningmart.m4.core.ParameterArray
This class serves as the container to store a single or multiple
Parameter
s in the parameter dictionary in class Step
.
The aggregation of Parameter
s by this class is according to the
operators access by name, where arrays of Parameter
objects and
optional parameters are possible.
Please note, that the name is not stored in this object, but the object is
stored in the ParamDict
dictionary with the parameter name used
by the operator as the key.
Constructor Summary | |
ParameterArray(short parameterType)
|
|
ParameterArray(java.lang.String parameterType)
|
Method Summary | |
void |
addParameter(Parameter par)
Extends the array of ParameterObjects by the specified Parameter. |
ParameterObject[] |
getParameterObjectArray()
Active getter of the parameterObjectArray . |
java.util.Collection |
getParameters()
|
short |
getParameterType()
Gets the parameterType. |
java.lang.String |
getParameterTypeS()
Gets the parameterType as the String constant used in class DB. |
boolean |
hasParameter(Parameter par)
|
boolean |
removeParameter(Parameter par)
Inverts the addParameter(Parameter) functionality.
|
int |
size()
|
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public ParameterArray(short parameterType) throws ParameterError
public ParameterArray(java.lang.String parameterType) throws ParameterError
Method Detail |
public void addParameter(Parameter par) throws M4Exception
Parameter
will also have a reference to this object
after it has been added by this method.
After each invokation the array of ParameterObjects is invalidated and
the active getter of this field will set it anew.
addParameter
in interface ParameterArray
par
- the Parameter
to be added
M4Exception
public boolean removeParameter(Parameter par) throws M4Exception
addParameter(Parameter)
functionality.
The object specified is removed from the internal list of embedded
Paramter
s. The reference of the Parameter
to
this object is also deleted.
removeParameter
in interface ParameterArray
par
- the Parameter
to be deleted
true
if the object could be deleted
M4Exception
public boolean hasParameter(Parameter par) throws M4Exception
hasParameter
in interface ParameterArray
par
- a Parameter
true
if a Parameter
with the same ID is
found in this ParameterArray
M4Exception
public short getParameterType()
getParameterType
in interface ParameterArray
public java.lang.String getParameterTypeS()
getParameterTypeS
in interface ParameterArray
public int size()
size
in interface ParameterArray
Parameter
s this
ParameterArray
contains.public java.util.Collection getParameters()
getParameters
in interface ParameterArray
Collection
of embedded Parameter
objects.public ParameterObject[] getParameterObjectArray() throws M4Exception
parameterObjectArray
.
getParameterObjectArray
in interface ParameterArray
ParameterObject[]
M4Exception
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |