edu.udo.cs.miningmart.m4
Interface Operator

All Superinterfaces:
M4Data, M4Object
All Known Implementing Classes:
Operator

public interface Operator
extends M4Data

Version:
$Id: Operator.java,v 1.4 2006/04/11 14:10:12 euler Exp $
Author:
Timm Euler, Daniel Hakenjos

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 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.lang.String getLoopable()
          "Getter" method.
 java.lang.String getManual()
          "Getter" method.
 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.
 boolean isLoopable()
          "Getter" method.
 boolean isManual()
          "Getter" method.
 boolean isStepable()
          "Getter" method.
 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 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

getOpParamsIterator

public java.util.Iterator getOpParamsIterator()
                                       throws M4Exception
Get an iterator.

Returns:
an Iterator for the parameters stored in table OP_PARAM_T, represented as objects of type OpParam.
Throws:
M4Exception

setRealize

public void setRealize(java.lang.String r)
Setter method.

Parameters:
r - the new value

getRealize

public java.lang.String getRealize()
Getter method.

Returns:
the value

setLoopable

public void setLoopable(boolean l)
Setter method.

Parameters:
l - the new value

setLoopable

public void setLoopable(java.lang.String loopable)
Setter method.

Parameters:
loopable - the new value in the database String representation

isLoopable

public boolean isLoopable()
"Getter" method.

Returns:
the value

getLoopable

public java.lang.String getLoopable()
"Getter" method.

Returns:
the value in database String representation

setManual

public void setManual(boolean m)
Setter method.

Parameters:
m - the new value

setManual

public void setManual(java.lang.String manual)
Setter method.

Parameters:
manual - the new value in the database String representation

isManual

public boolean isManual()
"Getter" method.

Returns:
the value

getManual

public java.lang.String getManual()
"Getter" method.

Returns:
the value in database String representation

setStepable

public void setStepable(boolean s)
Setter method.

Parameters:
s - the new value

setStepable

public void setStepable(java.lang.String stepable)
Setter method.

Parameters:
stepable - the new value in the database String representation

isStepable

public boolean isStepable()
"Getter" method.

Returns:
the value

getStepable

public java.lang.String getStepable()
"Getter" method.

Returns:
the value in database String representation

getOpParams

public java.util.Collection getOpParams()
                                 throws M4Exception
Active getter for this operator's OpParam's.

Returns:
the Collection of OpParams for this operator
Throws:
M4Exception

addOpParam

public void addOpParam(OpParam opParam)
                throws M4Exception
Add an OpParam object to this operator's specification.

Parameters:
opParam - the OpParam to be added
Throws:
M4Exception

removeOpParam

public boolean removeOpParam(OpParam opParam)
                      throws M4Exception
Remove an OpParam object from this operator's specification.

Parameters:
opParam - the OpParam to be removed
Returns:
true iff the object was part of this Operator's specification and could be removed.
Throws:
M4Exception

getAssertions

public java.util.Collection getAssertions()
                                   throws M4Exception
Throws:
M4Exception

getConditions

public java.util.Collection getConditions()
                                   throws M4Exception
Throws:
M4Exception

getConstraints

public java.util.Collection getConstraints()
                                    throws M4Exception
Throws:
M4Exception

addAssertion

public void addAssertion(Assertion assertion)
                  throws M4Exception
Parameters:
assertion - an Assertion to be added
Throws:
M4Exception

addCondition

public void addCondition(Condition condition)
                  throws M4Exception
Parameters:
condition - a Condition to be added
Throws:
M4Exception

addConstraint

public void addConstraint(Constraint constraint)
                   throws M4Exception
Parameters:
constraint - a Constraint to be added
Throws:
M4Exception

removeAssertion

public boolean removeAssertion(Assertion assertion)
                        throws M4Exception
Parameters:
assertion - an Assertion to be removed
Throws:
M4Exception

removeCondition

public boolean removeCondition(Condition condition)
                        throws M4Exception
Parameters:
condition - a Condition to be removed
Throws:
M4Exception

removeConstraint

public boolean removeConstraint(Constraint constraint)
                         throws M4Exception
Parameters:
constraint - a Constraint to be removed
Throws:
M4Exception

createAssertion

public Assertion createAssertion(java.lang.String type,
                                 java.lang.String object1,
                                 java.lang.String object2,
                                 java.lang.String text)
                          throws M4Exception
Creates a new Assertion for this Operator.

Throws:
CreateException - when an error occurs during creation of the object.
M4Exception

createCondition

public Condition createCondition(java.lang.String type,
                                 java.lang.String object1,
                                 java.lang.String object2,
                                 java.lang.String text)
                          throws M4Exception
Creates a new Condition for this Operator.

Throws:
CreateException - when an error occurs during creation of the object.
M4Exception

createConstraint

public Constraint createConstraint(java.lang.String type,
                                   java.lang.String object1,
                                   java.lang.String object2,
                                   java.lang.String text)
                            throws M4Exception
Creates a new Constraint for this Operator.

Throws:
CreateException - when an error occurs during creation of the object.
M4Exception

createOperatorParameter

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
Creates a new OperatorParameter for this Operator.

Throws:
CreateException - when an error occurs during creation of the object.
M4Exception

getAllInputOperatorParameters

public java.util.Collection getAllInputOperatorParameters()
                                                   throws M4Exception
Returns all OperatorParameters of type INPUT.

Throws:
M4Exception

getAllOutputOperatorParameters

public java.util.Collection getAllOutputOperatorParameters()
                                                    throws M4Exception
Returns all OperatorParameters of type OUTPUT.

Throws:
M4Exception

getOperatorParametersByType

public java.util.Collection getOperatorParametersByType(java.lang.String type)
                                                 throws M4Exception
Throws:
M4Exception

getOpParam

public OpParam getOpParam(java.lang.String name)
                   throws M4Exception
Returns the OpParam with the given name, if it exists, and NULL otherwise.

Parameters:
name - the name
Returns:
an OpParam or null
Throws:
M4Exception

getCoordinatedParameterArrays

public java.util.Collection getCoordinatedParameterArrays()
                                                   throws M4Exception
An operator can have parameter arrays whose values must be coordinated positionwise. This method returns all collections of such arrays. That is, it returns a Collection of Collections 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 Collections must be coordinated positionwise. If no coordinated parameter arrays exist, an empty collection is returned.

Returns:
a Collection of Collections of OpParam objects
Throws:
M4Exception

removeOperatorParameter

public void removeOperatorParameter(java.lang.String name)
                             throws M4Exception
Remove the specified OperatorParameter for this Operator.

Throws:
M4Exception

removeAllOperatorParameters

public void removeAllOperatorParameters()
                                 throws M4Exception
Removes all OperatorParameters of this Operator. They are also removed from the M4 Schema.

Throws:
M4Exception

removeOperatorParameterByType

public void removeOperatorParameterByType(java.lang.String type)
                                   throws M4Exception
Removes all OperatorParameters of this Operator of the specified type. They are also removed from the M4 Schema.

Throws:
M4Exception


Copyright © 2001-2005