|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectedu.udo.cs.miningmart.m4.core.M4Object
edu.udo.cs.miningmart.m4.core.M4Data
edu.udo.cs.miningmart.m4.core.Parameter
Field Summary | |
static java.lang.String |
ATTRIB_OBJECT_ID
db level tuple id of the corresponding object tuple |
static java.lang.String |
ATTRIB_OBJECT_TYPE
db level type (table) of the corresponding object tuple |
static java.lang.String |
ATTRIB_PAR_IO_TYPE
db level type of parameter: input or output |
static java.lang.String |
ATTRIB_PAR_LOOP_NR
db level: loop number this parameter belongs to |
static java.lang.String |
ATTRIB_PAR_OPERATOR_ID
db level: id of the corresponding operator |
static java.lang.String |
ATTRIB_PAR_STEP_ID
db level: id of the corresponding step |
static java.lang.String |
ATTRIB_PARAMETER_ID
db level tuple id of this parameter tuple |
static java.lang.String |
ATTRIB_PARAMETER_NAME
db level name of this parameter tuple |
static java.lang.String |
ATTRIB_PARAMETER_NR
db level: number of this parameter within its embedding array |
static java.lang.String |
M4_TABLE_NAME
name of the corresponding m4 table |
static M4Info |
m4Info
Cache for getM4Info() |
Fields inherited from class edu.udo.cs.miningmart.m4.core.M4Data |
myDocumentation |
Fields inherited from class edu.udo.cs.miningmart.m4.core.M4Object |
myId, myName |
Fields inherited from interface edu.udo.cs.miningmart.m4.utils.XmlInfo |
M4_XML_VERSION, TAG_COLLECTION, TAG_DOUBLE, TAG_INTEGER, TAG_LONG, TAG_M4_ID, TAG_SHORT, TAG_STRING, TAG_XML_ID |
Fields inherited from interface edu.udo.cs.miningmart.m4.Parameter |
TYPE_BASEATTRIBUTE, TYPE_CONCEPT, TYPE_FEATURE, TYPE_INPUT, TYPE_MULTICOLUMNFEATURE, TYPE_OUTPUT, TYPE_PARAMETER_OBJECT, TYPE_RELATION, TYPE_VALUE |
Fields inherited from interface edu.udo.cs.miningmart.m4.utils.M4Table |
NOT_NULL |
Constructor Summary | |
Parameter(DB db)
|
Method Summary | |
Parameter |
copy(Step newStep)
|
static java.lang.Class |
getClassForParameterType(short parameterType)
|
java.lang.String |
getIdAttributeName()
|
java.lang.String |
getInputParam()
Same as isInputParam , but returns the database String
representation for the flag. |
int |
getLoopNr()
|
M4Info |
getM4Info()
|
java.lang.String |
getM4TableName()
|
protected java.util.Collection |
getObjectsInNamespace(java.lang.Class typeOfObjects)
This method returns the objects of the specified type that form a namespace in the scope of this M4Data object. |
java.lang.String |
getParameterName()
|
java.lang.String |
getParameterType()
This is the IO_TYPE !! |
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()
|
static java.lang.String |
getTypeStringForParObject(ParameterObject parameterObject)
|
Value |
getValue()
Returns the corresponding Value object for this Parameter or null if it does not exist. |
M4Info |
getXmlInfo()
|
boolean |
isInputParam()
|
void |
primitiveSetParameterObject(ParameterObject paramObj)
Primitive setter method for internal ParameterObject field.
|
void |
primitiveSetStep(Step step)
Primitive setter, do not use it! |
void |
print()
Method to be used and extended by subclasses. |
protected void |
privateSetParType(java.lang.String parType)
This method is just used when a Parameter object is
loaded from the database and it needs to store the type information
for loading the ParameterObject . |
protected void |
readParObjFromDb(java.lang.Long idL)
This method is just used during autoLoad! |
protected void |
removeAllM4References()
This method needs to be implemented by all M4Data
objects. |
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)
|
static short |
typeConstForTypeString(java.lang.String parameterType)
|
static java.lang.String |
typeStringForTypeConst(short parameterType)
|
Methods inherited from class edu.udo.cs.miningmart.m4.core.M4Data |
deleteLocal, deleteSoon, exportLocal, genericGetter, genericSetter, getDependentObjects, getDocumentation, getObjectsReferencingMe, getObjectsReferencingMe, getObjectTag, getValidName, getXmlIdTag, getXmlVersion, hasDeleteStatus, importLocal, isDirty, isWaitingForDelete, primitiveGetDocObject, primitiveSetDocObject, readFromDb, readFromDbLocal, removeDocObject, removeFromDb, removeSetFromDb, setDirty, setDocumentation, setId, setName, storeLocal, updateObjectsFromTable |
Methods inherited from class edu.udo.cs.miningmart.m4.core.M4Object |
compareTo, doPrint, doPrint, equals, executeBusinessSingleValueSqlRead, executeBusinessSingleValueSqlReadL, executeBusinessSqlRead, executeBusinessSqlWrite, executeM4SingleValueSqlRead, executeM4SingleValueSqlReadL, executeM4SqlRead, executeM4SqlWrite, getCasePrintObject, getId, getM4Db, getM4ObjectFromCache, getName, getNextM4SequenceValue, isNew, load, putM4ObjectToCache, replaceSpacesInName |
Methods inherited from class java.lang.Object |
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface edu.udo.cs.miningmart.m4.utils.XmlInfo |
doPrint, doPrint, exportLocal, genericGetter, genericSetter, getDependentObjects, getObjectTag, getXmlIdTag, getXmlVersion, importLocal |
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, putM4ObjectToCache, replaceSpacesInName, setId, setName |
Field Detail |
public static final java.lang.String M4_TABLE_NAME
public static final java.lang.String ATTRIB_PARAMETER_ID
public static final java.lang.String ATTRIB_PARAMETER_NAME
public static final java.lang.String ATTRIB_OBJECT_ID
public static final java.lang.String ATTRIB_OBJECT_TYPE
public static final java.lang.String ATTRIB_PAR_IO_TYPE
public static final java.lang.String ATTRIB_PAR_LOOP_NR
public static final java.lang.String ATTRIB_PAR_OPERATOR_ID
public static final java.lang.String ATTRIB_PAR_STEP_ID
public static final java.lang.String ATTRIB_PARAMETER_NR
public static M4Info m4Info
Constructor Detail |
public Parameter(DB db)
Method Detail |
public java.lang.String getM4TableName()
getM4TableName
in interface M4Table
M4Table.getM4TableName()
public java.lang.String getIdAttributeName()
getIdAttributeName
in interface M4Table
M4Table.getIdAttributeName()
public M4Info getM4Info()
getM4Info
in interface M4Table
M4Table.getM4Info()
public M4Info getXmlInfo()
getXmlInfo
in interface XmlInfo
M4Info
object with the information
of all XML fields of this
object.XmlInfo.getXmlInfo()
public static short typeConstForTypeString(java.lang.String parameterType) throws ParameterError
ParameterError
public static java.lang.String typeStringForTypeConst(short parameterType) throws ParameterError
ParameterError
public static java.lang.Class getClassForParameterType(short parameterType) throws ParameterError
Class
(subclass of ParameterObject
)
representing the parameter
ParameterError
- if the parameter is out of bounds.
ParameterError
public static java.lang.String getTypeStringForParObject(ParameterObject parameterObject) throws ParameterError
parameterObject
- a ParameterObject
String
representing parameter objects of this type
in the database, or null
if the parameterObject
is null
ParameterError
- if the parameter type is unknown
ParameterError
protected java.util.Collection getObjectsInNamespace(java.lang.Class typeOfObjects) throws M4Exception
M4Data
null
. If a namespace could
exist but doesn't, an empty Collection is returned.
getObjectsInNamespace
in class M4Data
typeOfObjects
- the type of objects that form the namespace
typeOfObjects
,
or null
.
M4Exception
M4Data.getObjectsInNamespace(Class)
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!
setTheOperator
in interface Parameter
op
- The new operator.public Operator getTheOperator() throws M4Exception
Parameter
's Operator
getTheOperator
in interface Parameter
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
setTheStep
in interface Parameter
step
- The new Step
for this Parameter
M4Exception
public void primitiveSetStep(Step step)
step
- the Step
to be setpublic Step getTheStep() throws M4Exception
getTheStep
in interface Parameter
M4Exception
public boolean isInputParam()
isInputParam
in interface Parameter
public java.lang.String getInputParam()
isInputParam
, but returns the database String
representation for the flag.
getInputParam
in interface Parameter
String
DB.c_yes
public void setIsInputParam(boolean is)
setIsInputParam
in interface Parameter
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.
setInputParam
in interface Parameter
DB.c_yes
public void setLoopNr(int nr)
setLoopNr
in interface Parameter
nr
- the number of the loop for which this parameter is to be usedpublic int getLoopNr()
getLoopNr
in interface Parameter
public java.lang.String getParObjectType() throws ParameterError, M4Exception
getParObjectType
in interface Parameter
null
if the ParameterObject
is
not set.
ParameterError
M4Exception
public java.lang.Long getParObjectId() throws M4Exception
getParObjectId
in interface Parameter
ParameterObject
as a Long
object, or null
if there is no ParameterObject
stored.
M4Exception
public ParameterObject getTheParameterObject() throws M4Exception
getTheParameterObject
in interface Parameter
M4Data
object
constituting the parameter. A value of null
indicates an error.
M4Exception
public void setTheParameterObject(ParameterObject parameterObject) throws M4Exception
setTheParameterObject
in interface Parameter
parameterObject
- The parameterObject to set
M4Exception
public long getParamNr()
getParamNr
in interface Parameter
public void setParamNr(long paramNr)
setParamNr
in interface Parameter
paramNr
- The parameter number to setpublic void primitiveSetParameterObject(ParameterObject paramObj)
ParameterObject
field.
Do not use it!
paramObj
- the ParameterObject
to be setprotected void privateSetParType(java.lang.String parType)
Parameter
object is
loaded from the database and it needs to store the type information
for loading the ParameterObject
. Using this setter does
not have any effect in any other case!
parType
- the type of the ParameterObject
in the
database String
representation.public void print()
print
in interface M4Object
print
in class M4Object
M4Object.print()
protected void readParObjFromDb(java.lang.Long idL) throws M4Exception
idL
- the id of the ParameterObject
or null
M4Exception
protected void removeAllM4References() throws M4Exception
M4Data
M4Data
objects. It has to remove all references to other
M4Object
s.
removeAllM4References
in class M4Data
M4Exception
M4Data.removeAllM4References()
public java.lang.String getParameterName()
getParameterName
in interface Parameter
getParameterName()
public void setParameterName(java.lang.String parameterName) throws M4Exception
setParameterName
in interface Parameter
M4Exception
setParameterName(String)
public java.lang.String getParameterType()
getParameterType
in interface Parameter
getParameterType()
public void setParameterType(java.lang.String parameterType) throws M4Exception
setParameterType
in interface Parameter
M4Exception
setParameterType(String)
public void removeParameterObject() throws M4Exception
removeParameterObject
in interface Parameter
M4Exception
removeParameterObject()
public Parameter copy(Step newStep) throws M4Exception
copy
in interface Parameter
M4Exception
copy(Step)
public Value getValue() throws M4Exception
Parameter
getValue
in interface Parameter
M4Exception
getValue()
public void removeValue() throws M4Exception
Parameter
removeValue
in interface Parameter
M4Exception
removeValue()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |