TaskMC
TaskMC()luaTable - to store named parameters
| ClassMatchRatioMin | Threshold value for class-match ratio test |
| ClassMatchRatioMinTestFlag | Whether to test class-match ratio |
| ClusterCountMax | Maximal number of generated clusters |
| DataTable | the DataTable, this task is based on |
| Description | Textual description of this object (up to 65535 characters) |
| DisabledFlag | If this task is disabled and cannot be run |
| FrequencyClusterMin | Minimal size of a cluster |
| FrequencyTotalMin | Minimal number of clustered objects |
| HypothesisCountMax | Maximal number of hypotheses before generation is interrupted |
| ID | Unique identifier (primary key) of the object |
| IntraExtraDistanceRatioMax | Threshold value for Intra/Extra distance ratio test |
| IntraExtraDistanceRatioMaxTestFlag | Whether to test maximal Intra/Extra distance ratio |
| IterationCountMax | Maximal number of k-Means iterations |
| Name | Unique name of this object. Cannot be empty. |
| Note | Text comment to this object (up to 255 characters) |
| RandSeedInit | Seed init number for pseudo-random numbers |
| TargetClassAttribute | the TargetClassAttribute, an optional class attribute |
| TargetClassAttributeFlag | Whether a class attribute has been set |
| TargetClusterMax | Maximal target number of clusters |
| TargetClusterMin | Minimal target number of clusters |
| TaskGenerationStatus | Status code for task, see TaskGenerationStatus codes |
| TaskGroup | the TaskGroup, this task belongs to |
| canDel () | Returns true if the object could be deleted (is not used) |
| clone () | Creates a clone (an exact copy) of this task |
| findFTWholeCedentSetting () | Tries to look-up a FTWholeCedentSetting with a unique property given as parameter. Just one parameter has to be specified. Returns nil if FTWholeCedentSetting with this property doesn't exists. |
| findHypothesis () | Tries to look-up a Hypothesis with a unique property given as parameter. Just one parameter has to be specified. Returns nil if Hypothesis with this property doesn't exists. |
| findHypothesisGroup () | Tries to look-up a HypothesisGroup with a unique property given as parameter. Just one parameter has to be specified. Returns nil if HypothesisGroup with this property doesn't exists. |
| findMCPartialGroupSetting () | Tries to look-up a MCPartialGroupSetting with a unique property given as parameter. Just one parameter has to be specified. Returns nil if MCPartialGroupSetting with this property doesn't exists. |
| getDataTable () | Returns the DataTable this task is based on, the value of DataTable property |
| getFTWholeCedentSettingCount () | Returns number of whole cedents in this task |
| getHypothesisCount () | Returns number of hypotheses in this task (if the value of TaskGenerationStatus property is equal or greater then Running, see TaskGenerationStatus codes |
| getHypothesisCountMax () | Returns the value of HypothesisCountMax property |
| getHypothesisGroupCount () | Returns number of groups of hypotheses in this task |
| getID () | Returns unique identifier (primary key) of the object |
| getMCAlgorithmTypeCode () | Returns code of clustering algorithm type, see MCAlgorithmType codes |
| getMCAlgorithmTypeKey () | Returns unique string key of clustering algorithm type |
| getMCAlgorithmTypeName () | Returns string representation of clustering algorithm type |
| getMCDistanceTypeCode () | Returns code of objects distance measurement type, see MCDistanceType codes |
| getMCDistanceTypeKey () | Returns unique string key of objects distance measurement type |
| getMCDistanceTypeName () | Returns string representation of objects distance measurement type |
| getMCLinkageTypeCode () | Returns code of cluster linkage type, see MCLinkageType codes |
| getMCLinkageTypeKey () | Returns unique string key of cluster linkage type |
| getMCLinkageTypeName () | Returns string representation of cluster linkage type |
| getMCPartialGroupSettingCount () | Returns number of MCPartialGroupSettings for attributes in this task |
| getName () | Returns the value of Name property, name of this object |
| getNote () | Returns the value of Note property |
| getTaskGenerationStatus () | Returns the value of TaskGenerationStatus property |
| getTaskGenerationStatusStr () | Returns textual description of the value of TaskGenerationStatus property |
| getTaskGroup () | Returns the TaskGroup this task belongs to, the value of TaskGroup property |
| getTaskSubTypeCode () | Returns code of sub-type of this task (type of patterns it looks for), see TaskSubType codes |
| getTaskSubTypeKey () | Returns unique string key of sub-type of this task (type of patterns it looks for) |
| getTaskSubTypeName () | Returns string representation of sub-type of this task (type of patterns it looks for) |
| isDisabledFlag () | Returns the value of DisabledFlag property |
| isTaskGenerationStatusFinished () | Returns true when the value of TaskGenerationStatus property is Solved, Interrupted or Failed |
| isTaskGenerationStatusInProcess () | Returns true when the value of TaskGenerationStatus property is Request, Waiting or Running |
| onAdd () | Store the newly created object into metabase |
| onDel () | Delete the object from metabase (fails if canDel returns false) |
| onUpdate () | Save changes made to the object into metabase |
| prepareFTWholeCedentSettingArray () | Returns array of FTWholeCedentSettings (the whole cedents in this task) |
| prepareHypothesisArray () | Returns array of hypotheses in this task. Returns objects of a descendant class corresponding to this task type (ie. HypothesisFT for TaskFT etc.) |
| prepareHypothesisGroupArray () | Returns array of groups of hypotheses in this task |
| prepareMCPartialGroupSettingArray () | Returns array of MCPartialGroupSettings (groups of attributes in this task) |
| queryTaskGenerationStatus () | Re-reads the task state from metabase and returns 1 if the the state has changed from isTaskGenerationStatusInProcess to isTaskGenerationStatusFinished, otherwise returns 0 |
| runAndWaitForResults () | Starts the data-mining task and waits till it has finished |
| runAsync () | Starts the task (if not already in isTaskGenerationStatusInProcess) in a parallel thread and returns immediately |
| setDisabledFlag () | Sets the value of DisabledFlag property |
| setHypothesisCountMax () | Sets the value of HypothesisCountMax property |
| setMCAlgorithmTypeCode () | Sets code of clustering algorithm type, see MCAlgorithmType codes |
| setMCDistanceTypeCode () | Sets code of objects distance measurement type, see MCDistanceType codes |
| setMCLinkageTypeCode () | Sets code of cluster linkage type, see MCLinkageType codes |
| setName () | Sets the value of Name property, name of this object (must be unique) |
| setNote () | Sets the value of Note property |
| setTaskGroup () | Sets the TaskGroup this task belongs to, the value of TaskGroup property |
| waitForResults () | Waits till the task state changes to isTaskGenerationStatusFinished |
ClassMatchRatioMin : floatClassMatchRatioMinTestFlag : booleanClusterCountMax : integerDataTable (read-only) : DataTableDescription : stringDisabledFlag : booleanFrequencyClusterMin : integerFrequencyTotalMin : integerHypothesisCountMax : integerID (read-only) : integerIntraExtraDistanceRatioMax : floatIntraExtraDistanceRatioMaxTestFlag : booleanIterationCountMax : integerName : stringNote : stringRandSeedInit : integerTargetClassAttribute : TargetClassAttributeTargetClassAttributeFlag (read-only) : booleanTargetClusterMax : integerTargetClusterMin : integerTaskGenerationStatus (read-only) : integerTaskGroup (read-only) : TaskGroupcanDel() : booleanbooleanclone() : TaskTask - cloned taskfindFTWholeCedentSetting() : FTWholeCedentSettingnil if FTWholeCedentSetting with this property doesn't exists.
luaTable - to store named parameters
nCedentTypeCode : integer - CedentType code to identify the whole cedent to find
FTWholeCedentSetting - or nilfindHypothesis() : Hypothesisnil if Hypothesis with this property doesn't exists.
luaTable - to store named parameters
nID : integer - an ID of the Hypothesis to look-up
Hypothesis - or nilfindHypothesisGroup() : HypothesisGroupnil if HypothesisGroup with this property doesn't exists.
luaTable - to store named parameters
nID : integer - an ID of the HypothesisGroup to look-up
name : string - a name of the group of hypotheses to look-up
HypothesisGroup - or nilfindMCPartialGroupSetting() : MCPartialGroupSettingnil if MCPartialGroupSetting with this property doesn't exists.
luaTable - to store named parameters
nID : integer - an ID of the MCPartialGroupSetting to look-up
MCPartialGroupSetting - or nilgetDataTable() : DataTablegetFTWholeCedentSettingCount() : integerintegergetHypothesisCount() : integerintegergetHypothesisCountMax() : integerintegergetHypothesisGroupCount() : integerintegergetID() : integerintegergetMCAlgorithmTypeCode() : integerintegergetMCAlgorithmTypeKey() : stringstringgetMCAlgorithmTypeName() : stringstringgetMCDistanceTypeCode() : integerintegergetMCDistanceTypeKey() : stringstringgetMCDistanceTypeName() : stringstringgetMCLinkageTypeCode() : integerintegergetMCLinkageTypeKey() : stringstringgetMCLinkageTypeName() : stringstringgetMCPartialGroupSettingCount() : integerintegergetName() : stringstringgetNote() : stringstringgetTaskGenerationStatus() : integerintegergetTaskGenerationStatusStr() : stringstringgetTaskGroup() : TaskGroupgetTaskSubTypeCode() : integerintegergetTaskSubTypeKey() : stringstringgetTaskSubTypeName() : stringstringisDisabledFlag() : booleanbooleanisTaskGenerationStatusFinished() : booleanbooleanisTaskGenerationStatusInProcess() : booleanbooleanonAdd()onDel()onUpdate()prepareFTWholeCedentSettingArray() : luaTableluaTableprepareHypothesisArray() : luaTableluaTableprepareHypothesisGroupArray() : luaTableluaTableprepareMCPartialGroupSettingArray() : luaTableluaTablequeryTaskGenerationStatus() : integerinteger - one or zerorunAndWaitForResults()luaTable - to store named parameters
nTargetPlatform : integer - TargetPlatform code
bForceRunFinished : boolean - if true, forces the task to be run again even if it is already finished
integer - number of launched tasks (0 or 1)
runAsync()luaTable - to store named parameters
nTargetPlatform : integer - TargetPlatform code
bForceRunFinished : boolean - if true, forces the task to be run again even if it is already finished
integer - number of launched tasks
setDisabledFlag( boolean )booleansetHypothesisCountMax( integer )integersetMCAlgorithmTypeCode( integer )integersetMCDistanceTypeCode( integer )integersetMCLinkageTypeCode( integer )integersetName( string )string - cannot be emptysetNote( string )stringsetTaskGroup( TaskGroup )waitForResults()luaTable - to store named parameters
nSleepTime : integer - time (in milliseconds) between two checks for change in metabase