|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Field Summary | |
static short |
TYPE_BASEATTRIBUTE
|
static short |
TYPE_CONCEPT
|
static short |
TYPE_FEATURE
|
static java.lang.String |
TYPE_INPUT
Constant to specify Parameters of type INPUT. |
static short |
TYPE_MULTICOLUMNFEATURE
|
static java.lang.String |
TYPE_OUTPUT
Constant to specify Parameters of type OUTPUT. |
static short |
TYPE_PARAMETER_OBJECT
|
static short |
TYPE_RELATION
|
static short |
TYPE_VALUE
|
Method Summary | |
Parameter |
copy(Step newStep)
|
java.lang.String |
getInputParam()
Same as isInputParam , but returns the database String
representation for the flag. |
int |
getLoopNr()
|
java.lang.String |
getParameterName()
|
java.lang.String |
getParameterType()
|
long |
getParamNr()
Returns the parameter number. |
java.lang.Long |
getParObjectId()
|
java.lang.String |
getParObjectType()
|
Operator |
getTheOperator()
Getter method for this Parameter 's Operator |
ParameterObject |
getTheParameterObject()
|
Step |
getTheStep()
|
Value |
getValue()
Returns the corresponding Value object for this Parameter or null if it does not exist. |
boolean |
isInputParam()
|
void |
removeParameterObject()
|
void |
removeValue()
Removes the Value from this Parameter and deletes it. |
void |
setInputParam(java.lang.String inputString)
Each parameter is an input or an output parameter. |
void |
setIsInputParam(boolean is)
|
void |
setLoopNr(int nr)
|
void |
setParameterName(java.lang.String parameterName)
|
void |
setParameterType(java.lang.String parameterType)
|
void |
setParamNr(long paramNr)
Sets the number of this parameter within its embedding parameter array |
void |
setTheOperator(Operator op)
This method is based on a redundant attribute in the database! |
void |
setTheParameterObject(ParameterObject parameterObject)
Sets the parameterObject. |
void |
setTheStep(Step step)
|
Methods inherited from interface edu.udo.cs.miningmart.m4.M4Data |
deleteSoon, getDocumentation, getValidName, isDirty, isWaitingForDelete, setDocumentation |
Methods inherited from interface edu.udo.cs.miningmart.m4.M4Object |
doPrint, doPrint, equals, executeBusinessSingleValueSqlRead, executeBusinessSingleValueSqlReadL, executeBusinessSqlRead, executeBusinessSqlWrite, executeM4SingleValueSqlRead, executeM4SingleValueSqlReadL, executeM4SqlRead, executeM4SqlWrite, getCasePrintObject, getId, getM4Db, getM4ObjectFromCache, getName, getNextM4SequenceValue, isNew, load, print, putM4ObjectToCache, replaceSpacesInName, setId, setName |
Field Detail |
public static final java.lang.String TYPE_INPUT
public static final java.lang.String TYPE_OUTPUT
public static final short TYPE_VALUE
public static final short TYPE_CONCEPT
public static final short TYPE_RELATION
public static final short TYPE_BASEATTRIBUTE
public static final short TYPE_MULTICOLUMNFEATURE
public static final short TYPE_FEATURE
public static final short TYPE_PARAMETER_OBJECT
Method Detail |
public void setTheOperator(Operator op)
Step
. Thus the getter method for the
Operator
and its ID will return the result
based on the Operator
of the associated
Step
object.
As a result of being redundant this method does not do
anything!
op
- The new operator.public Operator getTheOperator() throws M4Exception
Parameter
's Operator
Operator
this parameter belongs to.
If no embedding Step
can be found or the Step
does not return its Operator
then null
is
returned.
M4Exception
public void setTheStep(Step step) throws M4Exception
step
- The new Step
for this Parameter
M4Exception
public Step getTheStep() throws M4Exception
M4Exception
public boolean isInputParam()
public java.lang.String getInputParam()
isInputParam
, but returns the database String
representation for the flag.
String
DB.c_yes
public void setIsInputParam(boolean is)
is
- Set to TRUE if this parameter is an Input parameter, FALSE otherwise.public void setInputParam(java.lang.String inputString)
String
representation of
this flag.
DB.c_yes
public void setLoopNr(int nr)
nr
- the number of the loop for which this parameter is to be usedpublic int getLoopNr()
public java.lang.String getParObjectType() throws ParameterError, M4Exception
null
if the ParameterObject
is
not set.
ParameterError
M4Exception
public java.lang.Long getParObjectId() throws M4Exception
ParameterObject
as a Long
object, or null
if there is no ParameterObject
stored.
M4Exception
public ParameterObject getTheParameterObject() throws M4Exception
M4Data
object
constituting the parameter. A value of null
indicates an error.
M4Exception
public void setTheParameterObject(ParameterObject parameterObject) throws M4Exception
parameterObject
- The parameterObject to set
M4Exception
public long getParamNr()
public void setParamNr(long paramNr)
paramNr
- The parameter number to setpublic java.lang.String getParameterName()
public void setParameterName(java.lang.String parameterName) throws M4Exception
M4Exception
public java.lang.String getParameterType()
public void setParameterType(java.lang.String parameterType) throws M4Exception
M4Exception
public void removeParameterObject() throws M4Exception
M4Exception
public Parameter copy(Step newStep) throws M4Exception
M4Exception
public Value getValue() throws M4Exception
M4Exception
public void removeValue() throws M4Exception
M4Exception
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |