|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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 |
getInput()
Similar to isInput() : Gets the input/output property,
but returns a String . |
int |
getMaxArg()
Gets the maxArg. |
java.lang.Integer |
getMaximumNumberOfArrayFields()
This method makes sense only if isArray() returns TRUE.
|
int |
getMinArg()
Gets the minArg. |
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()
|
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 |
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 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 |
Method Detail |
public boolean isInput()
public java.lang.String getInput()
isInput()
: Gets the input/output property,
but returns a String
.
String
indicating if the parameter is
an input or output.public int getMaxArg()
public int getMinArg()
public short getType()
public java.lang.String getTypeS() throws ParameterError
String
representation.
ParameterError
getType()
public void setInput(java.lang.String ioType) throws M4Exception
ioType
- Either "IN" for input parameters, or "OUT".
M4Exception
public void setMaxArg(int maxArg)
maxArg
- The maxArg to setpublic void setMinArg(int minArg)
minArg
- The minArg to setpublic void setType(java.lang.String typeString) throws M4Exception
M4Exception
public Operator getTheOperator()
public void setTheOperator(Operator operator) throws M4Exception
operator
- The Operator to set
M4Exception
public java.util.Collection getApplicableConstraints() throws M4Exception
M4Exception
public boolean isLoopable() throws M4Exception
M4Exception
public boolean isCoordinated() throws M4Exception
getCoordinatedParameterArrays()
in the class Operator
.
M4Exception
public boolean isOneOf() throws M4Exception
getOneOfList()
.
M4Exception
public boolean isOptional() throws M4Exception
M4Exception
public boolean isArray() throws M4Exception
M4Exception
public boolean isConceptParameter() throws M4Exception
getType()
and getTypeS()
.
M4Exception
public boolean isValueParameter() throws M4Exception
getType()
and getTypeS()
.
M4Exception
public java.lang.String getConceptualDatatypeForValue() throws M4Exception
M4Exception
public Value createValueObject() throws M4Exception
isValueParameter()
returns FALSE.
M4Exception
- is thrown if this is no Value parameterpublic boolean isRelationParameter() throws M4Exception
getType()
and getTypeS()
.
M4Exception
public boolean isFeatureParameter() throws M4Exception
getType()
and getTypeS()
.
M4Exception
public boolean isBaseAttribParameter() throws M4Exception
getType()
and getTypeS()
.
M4Exception
public boolean isMcfParameter() throws M4Exception
getType()
and getTypeS()
.
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.
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()
).
M4Exception
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |