|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Method Summary | |
void |
addDatabaseObjectToTrash(java.lang.String objectName,
java.lang.String schemaName,
java.lang.String objectType)
Helper method to store the information about a database object in the trash index |
void |
addParameterTuple(Parameter par)
Adds a parameter to this step's parameter list on tuple level. |
void |
addPredecessor(Step step)
|
void |
addSuccessor(Step step)
This method should only be called from the method Case.addStepDependency(Step, Step) !
|
void |
addToTrash(M4Data m4data)
This method should only be called by the compiler after a new M4 object has been created by calling a constructor. |
boolean |
belongsToChainOrSubChain(Chain theChain)
This method returns TRUE if this Step belongs to the given Chain, or to a direct or indirect subchain of the given Chain. |
boolean |
checkInputParameterEntries()
This method checks, for the current set of values of input parameters in this step, whether they fulfill all parameter contraints. |
boolean |
checkOutputParameterEntries()
This method checks, for the current set of values of output parameters in this step, whether they fulfill all parameter contraints. |
Step |
copy(Case newCase,
Chain newChain)
|
void |
createOutput(OpParam theOpParam,
java.util.Collection theNames)
This method must only be called if no output objects existed for this Step before! |
Parameter |
createParameterTuple(java.lang.String name,
ParameterObject object,
long number,
int loopNumber,
java.lang.String type)
Creates a Parameter that will be connected to this Step. |
Parameter |
createValueParameterTuple(java.lang.String value,
java.lang.String datatype,
java.lang.String name,
long number,
int loopNumber,
java.lang.String type)
Creates a Parameter and a Value that will be connected to this Step. |
void |
deleteDbTrash()
This method takes care of deleting trash objects from the business data schema. |
void |
deleteM4Trash()
This method realizes the M4Compiler's garbage collection on the objects created during compilation of this Step . |
boolean |
dependencyExists(Chain toChain)
Checks if this step has a successor among any of the steps in the given chain, including steps in any direct or indirect subchain of the given chain. |
java.util.Collection |
getAllInputConcepts()
This method returns all concepts that are input concept to this step's operator, even those that are attached to an input relation but not modelled by an input parameter. |
java.util.Collection |
getAllInputRelations()
Returns all relations that are a parameter object of an input parameter of this Step. |
java.util.Collection |
getAllPredecessors()
|
long |
getCaseId()
Getter method. |
java.util.Collection |
getCrossReferences()
|
java.util.Collection |
getInputConceptsThatAreParameters()
This method returns all concepts that are input concept to this step's operator. |
BaseAttribute[][] |
getKeysOfRelationshipAssertion()
This method checks if this Step creates a relationship from or to its output concept. |
int |
getLoopCount()
Getter method. |
java.util.Collection |
getM4Trash()
Active getter for the compiler's M4 Trash information. |
java.lang.String |
getMultiStepCondition()
Getter method. |
long |
getNumber()
Getter method. |
Concept |
getOutputConcept()
Returns the output concept of this step, if it exists, and NULL otherwise. |
java.util.Collection |
getParameter(OpParam theOpParam,
int loopNr)
Returns the instance of the given OpParam that is currently set
in this Step. |
ParamDict |
getParameterDictionary(boolean expectingAllParamsToExist)
Returns the parameter dictionary of the step. |
Parameter |
getParameterTuple(java.lang.String name,
int loopNr)
Return the parameter (tuple) of this step with the given name and loop number. |
java.util.Collection |
getParameterTuples()
Active getter for the parameters of this Step
in tuple-wise form (not aggregated by OpParam
arrays!). |
java.util.Collection |
getPossibleConceptsForParam(OpParam opParam)
Whenever an input of type BaseAttribute or MultiColumnFeature is expected the possible Concepts the Features may come from are explicitly given by constraints. |
java.util.Collection |
getPossibleInputConcepts()
This method finds all Concepts that are either of type DB or are created as an output concept by a Step that precedes this Step in the chain. |
java.util.Collection |
getResultingDataModel()
Returns a collection of concepts; these concepts represent the data model that the current Case produced up to this Step. |
java.util.Collection |
getSuccessors()
Active getter for this Step 's successors. |
Case |
getTheCase()
Getter method. |
Chain |
getTheChain()
Getter method. |
Operator |
getTheOperator()
Active getter method. |
boolean |
hasPredecessorOutsideChain()
This method returns TRUE if this Step has a direct predecessor that does not belong to the same chain, nor one of its subchains. |
boolean |
hasSuccessorOutsideChain()
This method returns TRUE if this Step has a direct successor that does not belong to the same chain, nor one of its subchains. |
boolean |
inputChangeCanAffectOutput(OpParam theOpParam)
Returns TRUE iff a change to the given input OpParam can have any effect on the output parameters of this Step. |
boolean |
isCompiled()
After a Step has been successfully compiled a flag in the
M4 database is set, which is removed by the next garbage collection.
|
boolean |
isContainedInInputConcept(OpParam outputFeature)
This method must only be called for an output feature. |
boolean |
isRelationallyValid()
|
boolean |
isVisible(Feature theFeature)
This method returns TRUE iff the given Feature may be displayed in the input concept, or in a list of Features to choose from for a parameter. |
void |
removeAllParameterTuples()
|
void |
removeParameter(java.lang.String parName)
|
boolean |
removeParameterTuple(Parameter par)
Removes a parameter from this step's parameter list on tuple level. |
void |
removePredecessor()
Removes the link to the specified Predecessor. |
boolean |
removeSuccessor(Step step)
Removes a Step from this Step 's Collection
of dependent Step s. |
boolean |
removeSuccessor(java.lang.String name)
Removes a Step from this Step 's Collection
of dependent Step s. |
void |
renameOutput(OpParam theOpParam,
java.util.Collection theNames)
This method changes the names of the output parameter objects; the latter are assumed to exist. |
void |
setCompiled()
This method may only be called by the control structure! |
void |
setLoopCount(int lc)
Setter method. |
void |
setMultiStepCondition(java.lang.String msc)
Setter method. |
void |
setNumber(long nr)
Setter method. |
void |
setParameter(OpParam theOpParam,
java.util.Collection theParameterObjects,
int loopNr)
Sets the parameter specified by the given OpParam . |
void |
setTheCase(Case myCase)
Setter method. |
void |
setTheChain(Chain chain)
Setter method. |
void |
setTheOperator(Operator theOp)
Setter method. |
void |
updateOutput(OpParam theOpParam)
This method must only be called if any input parameter of this Step was changed. |
boolean |
usesLoopsForCoordination()
This method returns TRUE if the coordinated parameters in this step (ab)use the loop mechanism for their coordination. |
Methods inherited from interface edu.udo.cs.miningmart.m4.GraphicalM4Object |
getPoint, setPoint |
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 Operator getTheOperator()
Step
public void setTheOperator(Operator theOp)
Operator
, so we do
not need another primitive setter.
theOp
- The new operatorpublic Chain getTheChain()
Chain
of this Step
public void setTheChain(Chain chain) throws M4Exception
chain
- The new chain
M4Exception
public long getCaseId()
public long getNumber()
public void setTheCase(Case myCase) throws M4Exception
myCase
- The new case
M4Exception
public void setNumber(long nr)
nr
- the new step numberpublic int getLoopCount()
public java.lang.String getMultiStepCondition()
public void addParameterTuple(Parameter par) throws M4Exception
par
- the Parameter
object representing the parameter tuple
M4Exception
public boolean removeParameterTuple(Parameter par) throws M4Exception
par
- the Parameter
object representing the parameter tuple
true
iff the object was part of the parameter list and
could be removed
M4Exception
public void removeAllParameterTuples() throws M4Exception
M4Exception
public void removeParameter(java.lang.String parName) throws M4Exception
M4Exception
public boolean dependencyExists(Chain toChain) throws M4Exception
toChain
- the given chain
M4Exception
public void setLoopCount(int lc) throws M4Exception
lc
- the new loop count
M4Exception
public void setMultiStepCondition(java.lang.String msc)
msc
- The new multistep conditionpublic java.util.Collection getAllInputConcepts() throws M4Exception
M4Exception
public java.util.Collection getInputConceptsThatAreParameters() throws M4Exception
M4Exception
public java.util.Collection getAllInputRelations() throws M4Exception
M4Exception
public BaseAttribute[][] getKeysOfRelationshipAssertion() throws M4Exception
M4Exception
public Concept getOutputConcept() throws M4Exception
M4Exception
public Case getTheCase()
public java.util.Collection getParameterTuples() throws M4Exception
Step
in tuple-wise form (not aggregated by OpParam
arrays!).
Parameter
objects
M4Exception
public java.util.Collection getSuccessors() throws M4Exception
Step
's successors.
Collection
of dependent Step
objects
M4Exception
public void addSuccessor(Step step) throws M4Exception
Case.addStepDependency(Step, Step)
!
Please use that method instead of this one, because
it also efficiently reorders the steps!
Adds a Step
to this Step
's Collection
of dependent Step
s.
step
- the Step
to add
M4Exception
public boolean removeSuccessor(Step step) throws M4Exception
Step
from this Step
's Collection
of dependent Step
s.
step
- the Step
to remove
true
iff the Step
was found in the
Collection
and could be successfully removed
M4Exception
public boolean removeSuccessor(java.lang.String name) throws M4Exception
Step
from this Step
's Collection
of dependent Step
s.
name
- the name of the step to remove
true
iff the Step
was found in the
Collection
and could be successfully removed
M4Exception
public ParamDict getParameterDictionary(boolean expectingAllParamsToExist) throws M4Exception
expectingAllParamsToExist
- If true, the caller expects the step to
be fully parameterised.
M4Exception
public java.util.Collection getCrossReferences() throws M4Exception
Collection
of Step
to Step
dependencies for sequentializing all Step
s before writing updates
to the database.
M4Exception
public java.util.Collection getM4Trash() throws M4Exception
Collection
of M4Data
objects created by the M4 compiler that have to be removed
before this Step
can be compiled anew.
M4Exception
public void addToTrash(M4Data m4data) throws M4Exception
m4data
- the M4Data
object to be added to the table
M4TRASH_T
for being garbage collected before compiling
this Step
or any of its predecessors.
M4Exception
public void deleteM4Trash() throws M4Exception
Step
.
M4Exception
public void addDatabaseObjectToTrash(java.lang.String objectName, java.lang.String schemaName, java.lang.String objectType) throws M4Exception
M4Exception
public void deleteDbTrash() throws M4Exception
M4Exception
public boolean isCompiled() throws M4Exception
Step
has been successfully compiled a flag in the
M4 database is set, which is removed by the next garbage collection.
This method checks, if this flag is set.
true
iff this Step
has been
successfully compiled and no garbage collection involving this
Step
has been run afterwards.
M4Exception
public void setCompiled() throws M4Exception
Step
as successfully compiled.
This information is used when it is checked for succeeding
Step
s, if all of the dependent resources are
already available.
M4Exception
public boolean usesLoopsForCoordination() throws M4Exception
M4Exception
public boolean isRelationallyValid()
public Step copy(Case newCase, Chain newChain) throws M4Exception
M4Exception
public void addPredecessor(Step step) throws M4Exception
M4Exception
public java.util.Collection getAllPredecessors() throws M4Exception
M4Exception
public java.util.Collection getResultingDataModel() throws M4Exception
M4Exception
public boolean belongsToChainOrSubChain(Chain theChain) throws M4Exception
theChain
- the given Chain
M4Exception
public boolean hasPredecessorOutsideChain() throws M4Exception
M4Exception
public boolean hasSuccessorOutsideChain() throws M4Exception
M4Exception
public Parameter getParameterTuple(java.lang.String name, int loopNr) throws M4Exception
name
- the NameloopNr
- the loop number as in M4
M4Exception
public java.util.Collection getParameter(OpParam theOpParam, int loopNr) throws M4Exception
OpParam
that is currently set
in this Step. The returned Collection
contains instances
of ParameterObject
s. For single parameters, only one
object is contained in the collection; for array parameters, there can
be more; for optional parameters, the collection can be empty.
theOpParam
- an OpParam object specifying the parameter to be returnedloopNr
- the loop index for this parameter (ignored for non-loopable parameters)
M4Exception
public void setParameter(OpParam theOpParam, java.util.Collection theParameterObjects, int loopNr) throws M4Exception
OpParam
. Depending
on the type of parameter, the given Collection
can contain
exactly one (for a single parameter), or several (for an array parameter),
ParameterObject
s.
theOpParam
- an OpParam object specifying the parameter to be settheParameterObjects
- a Collection of ParameterObjectsloopNr
- the loop index for this parameter (ignored for non-loopable parameters)
M4Exception
public boolean checkInputParameterEntries() throws M4Exception
M4Exception
- An exception carrying a meaningful error message,
intended to direct the user to improve the parameter settings.public boolean checkOutputParameterEntries() throws M4Exception
M4Exception
- An exception carrying a meaningful error message,
intended to direct the user to improve the parameter settings.public boolean isVisible(Feature theFeature) throws M4Exception
theFeature
- The feature for which visibility is tested
M4Exception
public void createOutput(OpParam theOpParam, java.util.Collection theNames) throws M4Exception
theOpParam
- the OpParam object specifying which output parameter is meanttheNames
- a Collection of Strings giving the name(s) for the new object(s)
M4Exception
public void renameOutput(OpParam theOpParam, java.util.Collection theNames) throws M4Exception
updateOutput
before this one.
theOpParam
- the OpParam object specifying which output parameter is meanttheNames
- a Collection of Strings giving the new name(s)
M4Exception
public void updateOutput(OpParam theOpParam) throws M4Exception
renameOutput
afterwards.
theOpParam
- the OpParam object specifying which output parameter is meant
M4Exception
public boolean inputChangeCanAffectOutput(OpParam theOpParam) throws M4Exception
theOpParam
- an input OpParam of the operator of this step
M4Exception
public java.util.Collection getPossibleConceptsForParam(OpParam opParam) throws M4Exception
opParam
- the OpParam
parameter referring to an
input feature.
Collection
consisting of the OpParam
names (Strings) of the Concept
s this feature is
allowed to be selected from (due to an 'IN' constraint).
M4Exception
public java.util.Collection getPossibleInputConcepts() throws M4Exception
M4Exception
public boolean isContainedInInputConcept(OpParam outputFeature) throws M4Exception
outputFeature
- the OpParam representing the output feature
M4Exception
public void removePredecessor() throws M4Exception
M4Exception
public Parameter createParameterTuple(java.lang.String name, ParameterObject object, long number, int loopNumber, java.lang.String type) throws M4Exception
name
- The name for the new Parameter.object
- The parameter object. It must be a Concept, Relationship
, BaseAttribute, MultiColumnFeature or Valuenumber
- the parameter numberloopNumber
- the loop numbertype
- the parameter type. Possible values are
Parameter.TYPE_INPUT or Parameter.TYPE_OUTPUT
M4Exception
public Parameter createValueParameterTuple(java.lang.String value, java.lang.String datatype, java.lang.String name, long number, int loopNumber, java.lang.String type) throws M4Exception
value
- The value for the Value Object.datatype
- The datatype for the value. Use one of the predefined types
available for @link DomainDatatypename
- The name for the new Parameter.number
- the parameter numberloopNumber
- the loop numbertype
- the parameter type. Possible values are
Parameter.TYPE_INPUT or Parameter.TYPE_OUTPUT
M4Exception
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |