|
||||||||||
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.GraphicalM4Object
edu.udo.cs.miningmart.m4.core.Step
This class represents an M4 Step.
Apart from the tuple-based load mechanism there is a second one,
loading and aggregating tuples as specified by the entries in the
OP_PARAM_T
table.
The first mechanism uses the methods getParameters()
,
addParameterTuple(Parameter)
, and
removeParameterTuple(Parameter)
.
The latter uses the methods getParameterDictionary()
,
getParameterFromDict(String, int)
,
getSingleParameter(String)
,
getSingleParameter(String, int)
,
getTheParameter(String)
, and
getTheParameter(String, int)
.
Adding or removing parameters is not possible with the second mechanism,
for it is a support for compiler access to aggregated parameter arrays
only.
Field Summary | |
static java.lang.String |
ATTRIB_CASE_ID
db level reference to the embedding case by this attribute |
static java.lang.String |
ATTRIB_CHAIN_ID
db level reference to the embedding chain by this attribute |
static java.lang.String |
ATTRIB_DBT_OBJNAME
|
static java.lang.String |
ATTRIB_DBT_OBJTYPE
|
static java.lang.String |
ATTRIB_DBT_SCHEMA
|
static java.lang.String |
ATTRIB_DBT_STEPID
|
static java.lang.String |
ATTRIB_MULTISTEP_COND
db level: operator name attribute |
static java.lang.String |
ATTRIB_NUM_OF_LOOPS
db level: number of loops attribute |
static java.lang.String |
ATTRIB_OPERATOR_ID
db level reference to the step's operator |
static java.lang.String |
ATTRIB_STEP_ID
db level id of this object is realized by this attribute |
static java.lang.String |
ATTRIB_STEP_NAME
db level name of this object is realized by this attribute |
static java.lang.String |
ATTRIB_STEP_NR
db level: step number attribute |
static java.lang.String |
ATTRIB_STEPSEQ_DEPENDENCY_ID
db level: name of the attribute holding the step dependency's id |
static java.lang.String |
ATTRIB_STEPSEQ_FROM_STEP
db level: name of the attribute holding the from step's id |
static java.lang.String |
ATTRIB_STEPSEQ_TO_STEP
db level: name of the attribute holding the dependent step's id |
static java.lang.String |
DB_TRASH_TABLENAME
|
static java.lang.String |
DBT_TYPE_FUNCTION
|
static java.lang.String |
DBT_TYPE_INDEX
|
static java.lang.String |
DBT_TYPE_TABLE
|
static java.lang.String |
DBT_TYPE_VIEW
|
static java.lang.String |
M4_TABLE_NAME
name of the corresponding m4 table |
static java.lang.String |
M4_TABLE_NAME_STEPSEQ
The name of the corresponding M4 table. |
static java.lang.String |
M4_TRASH_ID
The M4 trash table's primary key attribute name. |
static java.lang.String |
M4_TRASH_OBJ_TABLE
The M4 trash table's attribute holding the referenced object's M4 table name. |
static java.lang.String |
M4_TRASH_STEP_ID
The M4 trash table's attribute holding the object's creating Step ID. |
static java.lang.String |
M4_TRASH_TABLE
The name of the M4 table holding the compiler's garbage collection information of M4 objects. |
static M4Info |
m4Info
Cache for getM4Info() |
static InterM4Communicator |
step2par
Helper classes instance for inter M4 communication |
Fields inherited from class edu.udo.cs.miningmart.m4.core.GraphicalM4Object |
graph2coord |
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 | |
Step(DB m4Db)
|
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)
Make and return a copy of this Step that is attached to the given Chain in the given Case. |
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 ioType)
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. |
protected void |
deleteLocal()
Overwrites the superclass method to ensure that the cross table entries are deleted first |
void |
deleteM4Trash()
This method realizes the M4Compiler's garbage collection on the objects created during compilation of this Step . |
void |
deleteSoon()
Overwrites the superclass method because the output that this step creates must be deleted, too. |
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. |
EstimatedStatistics |
estimateStatisticsForOutputConcept()
|
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()
Returns only the DIRECT predecessors! |
long |
getCaseId()
Getter method. |
java.util.Collection |
getCrossReferences()
|
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.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. |
M4Info |
getM4Info()
|
java.lang.String |
getM4TableName()
|
java.util.Collection |
getM4Trash()
Active getter for the compiler's M4 Trash information. |
java.lang.String |
getMultiStepCondition()
Getter method. |
long |
getNumber()
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. |
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)
Active getter for the parameters of this Step
in aggregated form. |
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. |
Step |
getPredecessor()
Returns the direct predecessor. |
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. |
M4Info |
getXmlInfo()
|
protected boolean |
hasCoordinates()
Step s have coordinates. |
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 |
primitiveAddSuccessor(Step step)
Same as addSuccessor(Step) but without setting any of
the dirty flags. |
void |
primitiveSetCase(Case myCase)
Primitive setter method. |
void |
primitiveSetChain(Chain chain)
Primitive setter method. |
void |
print()
Method to print data about this M4Object. |
ParamDict |
readParametersFromDB(boolean paramsMustExist)
Reads all of this step's parameters specified in table OP_PARAM_T for the current Step and stores them in a parameter dictionary.
|
protected void |
removeAllM4References()
This method is to be written in a way that it can still be called during updateDatabase()! |
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)
An empty Collection for theParameterObjects
makes this method remove the parameter (as otherwise the type would be
unclear, anyway). |
protected void |
setSuccessors(java.util.Collection newSuccessors)
This method is mainly to be used by the XML deserialization mechanism, but it robust enough not to crash if the Case is not yet set, and it maintains the Steps' order within the Case by using the Case's addStepDependency(Step, Step) method. |
void |
setTheCase(Case myCase)
Setter method. |
void |
setTheChain(Chain chain)
Setter method. |
void |
setTheOperator(Operator theOp)
Setter method. |
protected void |
storeLocal()
This method stores the Collection of dependent
Step s to the database (table STEPSEQUENCE_T)
if there were any updates to that Collection . |
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 class edu.udo.cs.miningmart.m4.core.GraphicalM4Object |
getCoordinates, getPoint, primitiveSetCoordinates, setCoordinatesDirty, setName, setPoint |
Methods inherited from class edu.udo.cs.miningmart.m4.core.M4Data |
exportLocal, genericGetter, genericSetter, getDocumentation, getObjectsReferencingMe, getObjectsReferencingMe, getObjectTag, getValidName, getXmlIdTag, getXmlVersion, hasDeleteStatus, importLocal, isDirty, isWaitingForDelete, primitiveGetDocObject, primitiveSetDocObject, readFromDb, readFromDbLocal, removeDocObject, removeFromDb, removeSetFromDb, setDirty, setDocumentation, setId, 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.GraphicalM4Object |
getPoint, setPoint |
Methods inherited from interface edu.udo.cs.miningmart.m4.M4Data |
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 |
Methods inherited from interface edu.udo.cs.miningmart.m4.utils.XmlInfo |
doPrint, doPrint, exportLocal, genericGetter, genericSetter, getObjectTag, getXmlIdTag, getXmlVersion, importLocal |
Field Detail |
public static final java.lang.String M4_TABLE_NAME
public static final java.lang.String ATTRIB_STEP_ID
public static final java.lang.String ATTRIB_STEP_NAME
public static final java.lang.String ATTRIB_CHAIN_ID
public static final java.lang.String ATTRIB_CASE_ID
public static final java.lang.String ATTRIB_OPERATOR_ID
public static final java.lang.String ATTRIB_NUM_OF_LOOPS
public static final java.lang.String ATTRIB_STEP_NR
public static final java.lang.String ATTRIB_MULTISTEP_COND
public static InterM4Communicator step2par
public static M4Info m4Info
public static final java.lang.String M4_TABLE_NAME_STEPSEQ
public static final java.lang.String ATTRIB_STEPSEQ_DEPENDENCY_ID
public static final java.lang.String ATTRIB_STEPSEQ_FROM_STEP
public static final java.lang.String ATTRIB_STEPSEQ_TO_STEP
public static final java.lang.String DB_TRASH_TABLENAME
public static final java.lang.String ATTRIB_DBT_OBJTYPE
public static final java.lang.String ATTRIB_DBT_OBJNAME
public static final java.lang.String ATTRIB_DBT_SCHEMA
public static final java.lang.String ATTRIB_DBT_STEPID
public static final java.lang.String DBT_TYPE_FUNCTION
public static final java.lang.String DBT_TYPE_VIEW
public static final java.lang.String DBT_TYPE_TABLE
public static final java.lang.String DBT_TYPE_INDEX
public static final java.lang.String M4_TRASH_TABLE
public static final java.lang.String M4_TRASH_ID
public static final java.lang.String M4_TRASH_OBJ_TABLE
public static final java.lang.String M4_TRASH_STEP_ID
Constructor Detail |
public Step(DB m4Db)
edu.udo.cs.miningmart.m4.core.M4Data#Constructor
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 void print()
M4Object
print
in interface M4Object
print
in class GraphicalM4Object
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 Operator getTheOperator()
getTheOperator
in interface Step
Step
public void setTheOperator(Operator theOp)
Operator
, so we do
not need another primitive setter.
setTheOperator
in interface Step
theOp
- The new operatorpublic Chain getTheChain()
getTheChain
in interface Step
Chain
of this Step
public void setTheChain(Chain chain) throws M4Exception
setTheChain
in interface Step
chain
- The new chain
M4Exception
public void primitiveSetChain(Chain chain)
public long getCaseId()
getCaseId
in interface Step
public long getNumber()
getNumber
in interface Step
public void setTheCase(Case myCase) throws M4Exception
setTheCase
in interface Step
myCase
- The new case
M4Exception
public void primitiveSetCase(Case myCase)
myCase
- The Case
to be set.public void setNumber(long nr)
setNumber
in interface Step
nr
- the new step numberpublic int getLoopCount()
getLoopCount
in interface Step
public java.lang.String getMultiStepCondition()
getMultiStepCondition
in interface Step
public void addParameterTuple(Parameter par) throws M4Exception
addParameterTuple
in interface Step
par
- the Parameter
object representing the parameter tuple
M4Exception
public boolean removeParameterTuple(Parameter par) throws M4Exception
removeParameterTuple
in interface Step
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
removeAllParameterTuples
in interface Step
M4Exception
public void removeParameter(java.lang.String parName) throws M4Exception
removeParameter
in interface Step
M4Exception
public void setLoopCount(int lc) throws M4Exception
setLoopCount
in interface Step
lc
- the new loop count
M4Exception
public void setMultiStepCondition(java.lang.String msc)
setMultiStepCondition
in interface Step
msc
- The new multistep conditionpublic Case getTheCase()
getTheCase
in interface Step
public java.util.Collection getParameterTuples() throws M4Exception
Step
in tuple-wise form (not aggregated by OpParam
arrays!).
getParameterTuples
in interface Step
Parameter
objects
M4Exception
public java.util.Collection getSuccessors() throws M4Exception
Step
's successors.
getSuccessors
in interface Step
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.
addSuccessor
in interface Step
step
- the Step
to add
M4Exception
public void primitiveAddSuccessor(Step step) throws M4Exception
addSuccessor(Step) but without setting any of
the dirty flags. This method should only be used while loading
or if you know what you are doing!
- Throws:
M4Exception
public boolean removeSuccessor(Step step) throws M4Exception
Step
from this Step
's Collection
of dependent Step
s.
removeSuccessor
in interface Step
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.
removeSuccessor
in interface Step
name
- the name of the step to remove
true
iff the Step
was found in the
Collection
and could be successfully removed
M4Exception
public boolean dependencyExists(Chain toChain) throws M4Exception
Step
dependencyExists
in interface Step
toChain
- the given chain
M4Exception
Step.dependencyExists(Chain)
public boolean isRelationallyValid()
isRelationallyValid
in interface Step
public void addPredecessor(Step step) throws M4Exception
addPredecessor
in interface Step
M4Exception
addPredecessor(Step)
public void deleteSoon() throws M4Exception
deleteSoon
in interface M4Data
deleteSoon
in class GraphicalM4Object
M4Exception
protected void deleteLocal() throws M4Exception
deleteLocal
in class GraphicalM4Object
M4Exception
public ParamDict readParametersFromDB(boolean paramsMustExist) throws M4Exception
Step
and stores them in a parameter dictionary.
This is a service method for the compiler, aggregating all parameters to arrays
as specified by the corresponding OpParam
objects!
paramsMustExist
- If TRUE, it means that an exception ought to be
thrown if not all parameters are set. This parameter serves to enable the
new GUI to set the parameters initially.
M4Exception
public java.util.Collection getCrossReferences() throws M4Exception
getCrossReferences
in interface Step
Collection
of Step
to Step
dependencies for sequentializing all Step
s before writing updates
to the database.
M4Exception
protected boolean hasCoordinates()
Step
s have coordinates.
hasCoordinates
in class GraphicalM4Object
protected void storeLocal() throws M4Exception
Collection
of dependent
Step
s to the database (table STEPSEQUENCE_T)
if there were any updates to that Collection
.
storeLocal
in class GraphicalM4Object
M4Exception
protected void setSuccessors(java.util.Collection newSuccessors) throws M4Exception
addStepDependency(Step, Step)
method.
newSuccessors
- a Collection
of successors Step
s
M4Exception
protected void removeAllM4References() throws M4Exception
Step
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 GraphicalM4Object
M4Exception
M4Data.getDependentObjects()
public java.util.Collection getM4Trash() throws M4Exception
getM4Trash
in interface Step
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
addToTrash
in interface Step
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
.
deleteM4Trash
in interface Step
M4Exception
public void addDatabaseObjectToTrash(java.lang.String objectName, java.lang.String schemaName, java.lang.String objectType) throws M4Exception
addDatabaseObjectToTrash
in interface Step
M4Exception
public void deleteDbTrash() throws M4Exception
deleteDbTrash
in interface Step
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.
isCompiled
in interface Step
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.
setCompiled
in interface Step
M4Exception
public Step getPredecessor() throws M4Exception
M4Exception
edu.udo.cs.miningmart.m4.Step#getPredecessor()
public java.util.Collection getAllPredecessors() throws M4Exception
getAllPredecessors
in interface Step
M4Exception
getAllPredecessors()
public boolean belongsToChainOrSubChain(Chain theChain) throws M4Exception
Step
belongsToChainOrSubChain
in interface Step
theChain
- the given Chain
M4Exception
Step.belongsToChainOrSubChain(Chain)
public boolean hasPredecessorOutsideChain() throws M4Exception
Step
hasPredecessorOutsideChain
in interface Step
M4Exception
Step.hasPredecessorOutsideChain()
public boolean hasSuccessorOutsideChain() throws M4Exception
Step
hasSuccessorOutsideChain
in interface Step
M4Exception
Step.hasSuccessorOutsideChain()
public void removePredecessor() throws M4Exception
Step
removePredecessor
in interface Step
M4Exception
edu.udo.cs.miningmart.m4.Step#removePredecessor(String)
public Parameter getParameterTuple(java.lang.String name, int loopNr) throws M4Exception
Step
getParameterTuple
in interface Step
name
- the NameloopNr
- the loop number as in M4
M4Exception
public Parameter createParameterTuple(java.lang.String name, ParameterObject object, long number, int loopNumber, java.lang.String ioType) throws M4Exception
Step
createParameterTuple
in interface Step
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 numberioType
- the parameter type. Possible values are
Parameter.TYPE_INPUT or Parameter.TYPE_OUTPUT
M4Exception
Step#createParameter(String, M4Object, Operator, int, String)
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
Step
createValueParameterTuple
in interface Step
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
Step#createValueParameter(String, String, String, Operator, int, String)
public Step copy(Case newCase, Chain newChain) throws M4Exception
copy
in interface Step
M4Exception
copy(Case, Chain)
public java.util.Collection getParameter(OpParam theOpParam, int loopNr) throws M4Exception
Step
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.
getParameter
in interface Step
theOpParam
- an OpParam object specifying the parameter to be returnedloopNr
- the loop index for this parameter (ignored for non-loopable parameters)
M4Exception
edu.udo.cs.miningmart.m4.Step#getParameter(OpParam)
public void setParameter(OpParam theOpParam, java.util.Collection theParameterObjects, int loopNr) throws M4Exception
Collection
for theParameterObjects
makes this method remove the parameter (as otherwise the type would be
unclear, anyway).
setParameter
in interface Step
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
edu.udo.cs.miningmart.m4.Step#setParameter(OpParam, Collection)
public boolean checkInputParameterEntries() throws M4Exception
Step
checkInputParameterEntries
in interface Step
M4Exception
- An exception carrying a meaningful error message,
intended to direct the user to improve the parameter settings.Step.checkInputParameterEntries()
public boolean checkOutputParameterEntries() throws M4Exception, UserError
Step
checkOutputParameterEntries
in interface Step
M4Exception
- An exception carrying a meaningful error message,
intended to direct the user to improve the parameter settings.
UserError
Step.checkOutputParameterEntries()
public java.util.Collection getPossibleConceptsForParam(OpParam opParam) throws M4Exception
Step
getPossibleConceptsForParam
in interface Step
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
Step
getPossibleInputConcepts
in interface Step
M4Exception
public boolean isContainedInInputConcept(OpParam outputFeature) throws M4Exception
isContainedInInputConcept
in interface Step
outputFeature
- the OpParam representing the output feature
M4Exception
public ParamDict getParameterDictionary(boolean expectingAllParamsToExist) throws M4Exception
Step
in aggregated form.
getParameterDictionary
in interface Step
expectingAllParamsToExist
- If true, the caller expects the step to
be fully parameterised.
M4Exception
public boolean isVisible(Feature theFeature) throws M4Exception
Step
isVisible
in interface Step
theFeature
- The feature for which visibility is tested
M4Exception
Step.isVisible(Feature)
public boolean usesLoopsForCoordination() throws M4Exception
Step
usesLoopsForCoordination
in interface Step
M4Exception
Step.usesLoopsForCoordination()
public void createOutput(OpParam theOpParam, java.util.Collection theNames) throws M4Exception
createOutput
in interface Step
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 BaseAttribute[][] getKeysOfRelationshipAssertion() throws M4Exception
getKeysOfRelationshipAssertion
in interface Step
M4Exception
public void renameOutput(OpParam theOpParam, java.util.Collection theNames) throws M4Exception
updateOutput
before this one.
renameOutput
in interface Step
theOpParam
- the OpParam object specifying which output parameter is meanttheNames
- a Collection of Strings giving the new name(s)
M4Exception
public java.util.Collection getInputConceptsThatAreParameters() throws M4Exception
getInputConceptsThatAreParameters
in interface Step
M4Exception
public java.util.Collection getAllInputConcepts() throws M4Exception
Step
getAllInputConcepts
in interface Step
M4Exception
public java.util.Collection getAllInputRelations() throws M4Exception
getAllInputRelations
in interface Step
M4Exception
public Concept getOutputConcept() throws M4Exception
Step
getOutputConcept
in interface Step
M4Exception
Step.getOutputConcept()
public java.util.Collection getResultingDataModel() throws M4Exception
getResultingDataModel
in interface Step
M4Exception
public void updateOutput(OpParam theOpParam) throws M4Exception
renameOutput
afterwards.
updateOutput
in interface Step
theOpParam
- the OpParam object specifying which output parameter is meant
M4Exception
public boolean inputChangeCanAffectOutput(OpParam theOpParam) throws M4Exception
inputChangeCanAffectOutput
in interface Step
theOpParam
- an input OpParam of the operator of this step
M4Exception
public EstimatedStatistics estimateStatisticsForOutputConcept() throws M4Exception
M4Exception
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |