|
||||||||||
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.Operator
This is the class representing the OPERATOR_T table of the M4 schema.
Operator constraints are also accessible from Operator objects.
The top class of the executable operators of the compiler is
ExecutableOperator
.
Field Summary | |
static java.lang.String |
ATTRIB_OPERATOR_ID
db level: name of the operator id attribute |
static java.lang.String |
ATTRIB_OPERATOR_IS_LOOPABLE
db level: name of the attribute indicating if it is a loopable operator |
static java.lang.String |
ATTRIB_OPERATOR_IS_MANUAL
db level: name of the attribute indicating if it is a manual operator |
static java.lang.String |
ATTRIB_OPERATOR_IS_MULTISTEPABLE
db level: name of the attribute indicating if it is a multi-stepable operator |
static java.lang.String |
ATTRIB_OPERATOR_NAME
db level: name of the operator name attribute |
static java.lang.String |
ATTRIB_OPERATOR_REALIZED
db level: name of the attribute for operator realization |
protected boolean |
loopable
|
static java.lang.String |
M4_TABLE_NAME
The name of the corresponding M4 table. |
static M4Info |
m4Info
Cache for getM4Info() |
protected boolean |
manual
|
protected java.lang.String |
realize
|
protected boolean |
stepable
|
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 | |
Operator(DB db)
Constructor. |
Method Summary | |
void |
addAssertion(Assertion assertion)
|
void |
addCondition(Condition condition)
|
void |
addConstraint(Constraint constraint)
|
void |
addOpParam(OpParam opParam)
Add an OpParam object to this operator's specification. |
Assertion |
createAssertion(java.lang.String type,
java.lang.String object1,
java.lang.String object2,
java.lang.String text)
Creates a new Assertion for this Operator. |
Condition |
createCondition(java.lang.String type,
java.lang.String object1,
java.lang.String object2,
java.lang.String text)
Creates a new Condition for this Operator. |
Constraint |
createConstraint(java.lang.String type,
java.lang.String object1,
java.lang.String object2,
java.lang.String text)
Creates a new Constraint for this Operator. |
OpParam |
createOperatorParameter(java.lang.String name,
int minNrOfArgs,
int maxNrOfArgs,
java.lang.String ioType,
java.lang.String parameterType,
java.lang.String text)
Creates a new OperatorParameter for this Operator. |
java.util.Collection |
getAllInputOperatorParameters()
Returns all OperatorParameters of type INPUT. |
java.util.Collection |
getAllOperatorParameters()
|
java.util.Collection |
getAllOutputOperatorParameters()
Returns all OperatorParameters of type OUTPUT. |
java.util.Collection |
getAssertions()
|
java.util.Collection |
getConditions()
|
java.util.Collection |
getConstraints()
|
java.util.Collection |
getCoordinatedParameterArrays()
An operator can have parameter arrays whose values must be coordinated positionwise. |
java.util.Collection |
getDependentObjects()
This method is part of the XML-serialization and needs to be implemented by all M4Data sub-classes that need to be serialized. |
java.lang.String |
getIdAttributeName()
|
java.lang.String |
getLoopable()
"Getter" method. |
M4Info |
getM4Info()
|
java.lang.String |
getM4TableName()
|
java.lang.String |
getManual()
"Getter" method. |
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. |
OpParam |
getOperatorParameter(java.lang.String name)
|
java.util.Collection |
getOperatorParametersByType(java.lang.String type)
|
OpParam |
getOpParam(java.lang.String name)
Returns the OpParam with the given name, if it exists, and NULL otherwise. |
java.util.Collection |
getOpParams()
Active getter for this operator's OpParam's. |
java.util.Iterator |
getOpParamsIterator()
Get an iterator. |
java.lang.String |
getRealize()
Getter method. |
java.lang.String |
getStepable()
"Getter" method. |
M4Info |
getXmlInfo()
|
boolean |
isLoopable()
"Getter" method. |
boolean |
isManual()
"Getter" method. |
boolean |
isStepable()
"Getter" method. |
void |
print()
Method to print data about this M4Object. |
protected void |
removeAllM4References()
This method needs to be implemented by all M4Data
objects. |
void |
removeAllOperatorParameters()
Removes all OperatorParameters of this Operator. |
boolean |
removeAssertion(Assertion assertion)
|
boolean |
removeCondition(Condition condition)
|
boolean |
removeConstraint(Constraint constraint)
|
void |
removeOperatorParameter(java.lang.String name)
Remove the specified OperatorParameter for this Operator. |
void |
removeOperatorParameterByType(java.lang.String type)
Removes all OperatorParameters of this Operator of the specified type. |
boolean |
removeOpParam(OpParam opParam)
Remove an OpParam object from this operator's specification. |
void |
setLoopable(boolean l)
Setter method. |
void |
setLoopable(java.lang.String loopable)
Setter method. |
void |
setManual(boolean m)
Setter method. |
void |
setManual(java.lang.String manual)
Setter method. |
void |
setRealize(java.lang.String r)
Setter method. |
void |
setStepable(boolean s)
Setter method. |
void |
setStepable(java.lang.String stepable)
Setter method. |
Methods inherited from class edu.udo.cs.miningmart.m4.core.M4Data |
deleteLocal, deleteSoon, exportLocal, genericGetter, genericSetter, 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, 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_OPERATOR_ID
public static final java.lang.String ATTRIB_OPERATOR_NAME
public static final java.lang.String ATTRIB_OPERATOR_IS_MANUAL
public static final java.lang.String ATTRIB_OPERATOR_IS_LOOPABLE
public static final java.lang.String ATTRIB_OPERATOR_IS_MULTISTEPABLE
public static final java.lang.String ATTRIB_OPERATOR_REALIZED
public static M4Info m4Info
protected boolean loopable
protected boolean stepable
protected boolean manual
protected java.lang.String realize
Constructor Detail |
public Operator(DB db)
db
- the reference to the Case's DB object.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 java.util.Iterator getOpParamsIterator() throws M4Exception
getOpParamsIterator
in interface Operator
Iterator
for the parameters stored in table OP_PARAM_T,
represented as objects of type OpParam
.
M4Exception
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 setRealize(java.lang.String r)
setRealize
in interface Operator
r
- the new valuepublic java.lang.String getRealize()
getRealize
in interface Operator
public void setLoopable(boolean l)
setLoopable
in interface Operator
l
- the new valuepublic void setLoopable(java.lang.String loopable)
setLoopable
in interface Operator
loopable
- the new value in the database String
representationpublic boolean isLoopable()
isLoopable
in interface Operator
public java.lang.String getLoopable()
getLoopable
in interface Operator
String
representationpublic void setManual(boolean m)
setManual
in interface Operator
m
- the new valuepublic void setManual(java.lang.String manual)
setManual
in interface Operator
manual
- the new value in the database String
representationpublic boolean isManual()
isManual
in interface Operator
public java.lang.String getManual()
getManual
in interface Operator
String
representationpublic void setStepable(boolean s)
setStepable
in interface Operator
s
- the new valuepublic void setStepable(java.lang.String stepable)
setStepable
in interface Operator
stepable
- the new value in the database String
representationpublic boolean isStepable()
isStepable
in interface Operator
public java.lang.String getStepable()
getStepable
in interface Operator
String
representationpublic java.util.Collection getOpParams() throws M4Exception
getOpParams
in interface Operator
Collection
of OpParam
s for this operator
M4Exception
public void addOpParam(OpParam opParam) throws M4Exception
OpParam
object to this operator's specification.
addOpParam
in interface Operator
opParam
- the OpParam
to be added
M4Exception
public boolean removeOpParam(OpParam opParam) throws M4Exception
OpParam
object from this operator's specification.
removeOpParam
in interface Operator
opParam
- the OpParam
to be removed
true
iff the object was part of this Operator
's
specification and could be removed.
M4Exception
public java.util.Collection getAssertions() throws M4Exception
getAssertions
in interface Operator
M4Exception
public java.util.Collection getConditions() throws M4Exception
getConditions
in interface Operator
M4Exception
public java.util.Collection getConstraints() throws M4Exception
getConstraints
in interface Operator
M4Exception
public void addAssertion(Assertion assertion) throws M4Exception
addAssertion
in interface Operator
assertion
- an Assertion
to be added
M4Exception
public void addCondition(Condition condition) throws M4Exception
addCondition
in interface Operator
condition
- a Condition
to be added
M4Exception
public void addConstraint(Constraint constraint) throws M4Exception
addConstraint
in interface Operator
constraint
- a Constraint
to be added
M4Exception
public boolean removeAssertion(Assertion assertion) throws M4Exception
removeAssertion
in interface Operator
assertion
- an Assertion
to be removed
M4Exception
public boolean removeCondition(Condition condition) throws M4Exception
removeCondition
in interface Operator
condition
- a Condition
to be removed
M4Exception
public boolean removeConstraint(Constraint constraint) throws M4Exception
removeConstraint
in interface Operator
constraint
- a Constraint
to be removed
M4Exception
public Assertion createAssertion(java.lang.String type, java.lang.String object1, java.lang.String object2, java.lang.String text) throws M4Exception
Operator
createAssertion
in interface Operator
M4Exception
createAssertion(String, String, String, String)
public Constraint createConstraint(java.lang.String type, java.lang.String object1, java.lang.String object2, java.lang.String text) throws M4Exception
Operator
createConstraint
in interface Operator
M4Exception
createConstraint(String, String, String, String)
public Condition createCondition(java.lang.String type, java.lang.String object1, java.lang.String object2, java.lang.String text) throws M4Exception
Operator
createCondition
in interface Operator
M4Exception
createCondition(String, String, String, String)
public OpParam createOperatorParameter(java.lang.String name, int minNrOfArgs, int maxNrOfArgs, java.lang.String ioType, java.lang.String parameterType, java.lang.String text) throws M4Exception
Operator
createOperatorParameter
in interface Operator
M4Exception
createOperatorParameter(String, int, int, String, String, String)
public OpParam getOperatorParameter(java.lang.String name) throws M4Exception
M4Exception
getOperatorParameter(String)
public void removeOperatorParameter(java.lang.String name) throws M4Exception
Operator
removeOperatorParameter
in interface Operator
M4Exception
removeOperatorParameter(String)
public void removeAllOperatorParameters() throws M4Exception
Operator
removeAllOperatorParameters
in interface Operator
M4Exception
removeAllOperatorParameters()
public void removeOperatorParameterByType(java.lang.String type) throws M4Exception
Operator
removeOperatorParameterByType
in interface Operator
M4Exception
removeOperatorParameterByType(String)
public java.util.Collection getAllOperatorParameters() throws M4Exception
M4Exception
getAllOperatorParameters()
public java.util.Collection getOperatorParametersByType(java.lang.String type) throws M4Exception
getOperatorParametersByType
in interface Operator
M4Exception
getOperatorParametersByType(String)
public java.util.Collection getAllInputOperatorParameters() throws M4Exception
Operator
getAllInputOperatorParameters
in interface Operator
M4Exception
getAllInputOperatorParameters()
public java.util.Collection getAllOutputOperatorParameters() throws M4Exception
Operator
getAllOutputOperatorParameters
in interface Operator
M4Exception
getAllOutputOperatorParameters()
public OpParam getOpParam(java.lang.String name) throws M4Exception
Operator
getOpParam
in interface Operator
name
- the name
M4Exception
public java.util.Collection getCoordinatedParameterArrays() throws M4Exception
Operator
Collection
of Collection
s of OpParam
objects. Each of the OpParam
objects represents a parameter
array that belongs to this operator. All parameter arrays within one of
the returned Collection
s must be
coordinated positionwise. If no coordinated parameter arrays exist,
an empty collection is returned.
getCoordinatedParameterArrays
in interface Operator
M4Exception
Operator.getCoordinatedParameterArrays()
public void print()
M4Object
print
in interface M4Object
print
in class M4Object
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.util.Collection getDependentObjects() throws M4Exception
M4Data
M4Data
sub-classes that need to be serialized.
getDependentObjects
in interface XmlInfo
getDependentObjects
in class M4Data
Collection
of all M4Data
Java objects
holding a foreign key reference to this
object.
This method must never return null
.
M4Exception
M4Data.getDependentObjects()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |