|
||||||||||
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.OpParam
Objects of this class reflect static properties of an operator found in the OP_PARAMS_T table.
Field Summary | |
static java.lang.String |
ATTRIB_IO_TYPE
db level: name of the OpParam input/output type attribute |
static java.lang.String |
ATTRIB_MAX_ARG
db level: name of the OpParam maximum number of parameters attribute |
static java.lang.String |
ATTRIB_MIN_ARG
db level: name of the OpParam minimum number of parameters attribute |
static java.lang.String |
ATTRIB_OP_PARAM_ID
db level: name of the OpParam id attribute |
static java.lang.String |
ATTRIB_OP_PARAM_NAME
db level: name of the OpParam name attribute |
static java.lang.String |
ATTRIB_OP_PARAM_OPID
db level: name of the OpParam id attribute |
static java.lang.String |
ATTRIB_PAR_TYPE
db level: name of the OpParam parameter type attribute |
static java.lang.String |
M4_TABLE_NAME
The 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.utils.M4Table |
NOT_NULL |
Constructor Summary | |
OpParam(DB m4Db)
|
Method Summary | |
Value |
createValueObject()
Convenience method to create a Value object of the right datatype for this parameter. |
java.util.Collection |
getApplicableConstraints()
Returns all Constraint objects that constrain this operator parameter. |
java.lang.String |
getConceptualDatatypeForValue()
Returns a conceptual data type that can be used for a Value Parameter Object of this OpParam, or null if this OpParam does not represent a Value Parameter. |
java.lang.String |
getIdAttributeName()
|
java.lang.String |
getInput()
Similar to isInput() : Gets the input/output property,
but returns a String . |
M4Info |
getM4Info()
|
java.lang.String |
getM4TableName()
|
int |
getMaxArg()
Gets the maxArg. |
java.lang.Integer |
getMaximumNumberOfArrayFields()
This method makes sense only if isArray() returns TRUE.
|
int |
getMinArg()
Gets the minArg. |
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.util.Collection |
getOneOfList()
This method makes sense only if isOneOf() returns TRUE. |
Operator |
getTheOperator()
Gets the Operator. |
short |
getType()
Gets the type. |
java.lang.String |
getTypeS()
|
M4Info |
getXmlInfo()
|
boolean |
isArray()
|
boolean |
isBaseAttribParameter()
Convenience method to getType() and getTypeS() . |
boolean |
isConceptParameter()
Convenience method to getType() and getTypeS() . |
boolean |
isCoordinated()
|
boolean |
isFeatureParameter()
Convenience method to getType() and getTypeS() . |
boolean |
isInput()
Gets the input/output property. |
boolean |
isLoopable()
|
boolean |
isMcfParameter()
Convenience method to getType() and getTypeS() . |
boolean |
isOneOf()
|
boolean |
isOptional()
|
boolean |
isRelationParameter()
Convenience method to getType() and getTypeS() . |
boolean |
isValueParameter()
Convenience method to getType() and getTypeS() . |
void |
primitiveSetOperator(Operator operator)
Primitive setter for the Operator. |
void |
print()
Method to print data about this M4Object. |
protected void |
removeAllM4References()
This method needs to be implemented by all M4Data
objects. |
void |
setInput(java.lang.String ioType)
Sets the input/output property. |
void |
setMaxArg(int maxArg)
Sets the maxArg. |
void |
setMinArg(int minArg)
Sets the minArg. |
void |
setTheOperator(Operator operator)
Sets the Operator. |
void |
setType(java.lang.String typeString)
Sets the type. |
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_OP_PARAM_ID
public static final java.lang.String ATTRIB_OP_PARAM_OPID
public static final java.lang.String ATTRIB_OP_PARAM_NAME
public static final java.lang.String ATTRIB_MIN_ARG
public static final java.lang.String ATTRIB_MAX_ARG
public static final java.lang.String ATTRIB_IO_TYPE
public static final java.lang.String ATTRIB_PAR_TYPE
public static M4Info m4Info
Constructor Detail |
public OpParam(DB m4Db)
m4Db
- the DB
object to be usedMethod 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.M4Table.getM4Info()
public void print()
M4Object
print
in interface M4Object
print
in class M4Object
M4Object.print()
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 boolean isInput()
isInput
in interface OpParam
public java.lang.String getInput()
isInput()
: Gets the input/output property,
but returns a String
.
getInput
in interface OpParam
String
indicating if the parameter is
an input or output.public int getMaxArg()
getMaxArg
in interface OpParam
public int getMinArg()
getMinArg
in interface OpParam
public short getType()
getType
in interface OpParam
public java.lang.String getTypeS() throws ParameterError
getTypeS
in interface OpParam
String
representation.
ParameterError
getType()
public void setInput(java.lang.String ioType) throws M4Exception
setInput
in interface OpParam
ioType
- Either "IN" for input parameters, or "OUT".
M4Exception
public void setMaxArg(int maxArg)
setMaxArg
in interface OpParam
maxArg
- The maxArg to setpublic void setMinArg(int minArg)
setMinArg
in interface OpParam
minArg
- The minArg to setpublic void setType(java.lang.String typeString) throws M4Exception
setType
in interface OpParam
M4Exception
public Operator getTheOperator()
getTheOperator
in interface OpParam
public void setTheOperator(Operator operator) throws M4Exception
setTheOperator
in interface OpParam
operator
- The Operator to set
M4Exception
public void primitiveSetOperator(Operator operator)
operator
- The Operator to setprotected 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.util.Collection getApplicableConstraints() throws M4Exception
getApplicableConstraints
in interface OpParam
M4Exception
public boolean isLoopable() throws M4Exception
isLoopable
in interface OpParam
M4Exception
public boolean isCoordinated() throws M4Exception
isCoordinated
in interface OpParam
getCoordinatedParameterArrays()
in the class Operator
.
M4Exception
OpParam.isCoordinated()
public boolean isOneOf() throws M4Exception
isOneOf
in interface OpParam
getOneOfList()
.
M4Exception
public boolean isOptional() throws M4Exception
isOptional
in interface OpParam
M4Exception
public boolean isArray() throws M4Exception
isArray
in interface OpParam
M4Exception
public boolean isConceptParameter() throws M4Exception
getType()
and getTypeS()
.
isConceptParameter
in interface OpParam
M4Exception
public boolean isValueParameter() throws M4Exception
getType()
and getTypeS()
.
isValueParameter
in interface OpParam
M4Exception
public Value createValueObject() throws M4Exception
OpParam
isValueParameter()
returns FALSE.
createValueObject
in interface OpParam
M4Exception
- is thrown if this is no Value parameterOpParam.createValueObject()
public java.lang.String getConceptualDatatypeForValue() throws M4Exception
OpParam
getConceptualDatatypeForValue
in interface OpParam
M4Exception
OpParam.getConceptualDatatypeForValue()
public boolean isRelationParameter() throws M4Exception
getType()
and getTypeS()
.
isRelationParameter
in interface OpParam
M4Exception
public boolean isFeatureParameter() throws M4Exception
getType()
and getTypeS()
.
isFeatureParameter
in interface OpParam
M4Exception
public boolean isBaseAttribParameter() throws M4Exception
getType()
and getTypeS()
.
isBaseAttribParameter
in interface OpParam
M4Exception
public boolean isMcfParameter() throws M4Exception
getType()
and getTypeS()
.
isMcfParameter
in interface OpParam
M4Exception
public java.util.Collection getOneOfList() throws M4Exception
isOneOf()
returns TRUE. In that
case this method returns the list of possible values that this parameter can
take. A collection of Strings is returned. Otherwise an empty collection is
returned.
getOneOfList
in interface OpParam
M4Exception
public java.lang.Integer getMaximumNumberOfArrayFields() throws M4Exception
isArray()
returns TRUE.
In that case this method returns the maximum number of positions of the
array, if such a maximum exists; otherwise this method returns NULL.
The minimum number of array positions can be taken to be 1 if this
parameter is not optional (see method isArray()
).
getMaximumNumberOfArrayFields
in interface OpParam
M4Exception
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |