LISp-Miner Control Language Reference, version: 27.14.01 of 8 Oct 2017

Class TaskMC

MCluster-Miner data-mining task
inherits from Task
namespace: lm.tasks

Constructor

TaskMC()
Creates a new object of this class

Parameters

  • luaTable - to store named parameters

Obligatory named parameters

  • name : string - unique name for the new MCluster-Miner task
  • pTaskGroup : TaskGroup - parent group of tasks
  • pDataTable : DataTable - database table this task is based upon

Properties List

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

Methods List

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 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

Properties

ClassMatchRatioMin : float
Threshold value for class-match ratio test
ClassMatchRatioMinTestFlag : boolean
Whether to test class-match ratio
ClusterCountMax : integer
Maximal number of generated clusters
DataTable  (read-only) : DataTable
the DataTable, this task is based on
Intherited from: Task
Description : string
Textual description of this object (up to 65535 characters)
Intherited from: Task
DisabledFlag : boolean
If this task is disabled and cannot be run
Intherited from: Task
FrequencyClusterMin : integer
Minimal size of a cluster
FrequencyTotalMin : integer
Minimal number of clustered objects
HypothesisCountMax : integer
Maximal number of hypotheses before generation is interrupted
Intherited from: Task
ID  (read-only) : integer
Unique identifier (primary key) of the object
Intherited from: LMWrap
IntraExtraDistanceRatioMax : float
Threshold value for Intra/Extra distance ratio test
IntraExtraDistanceRatioMaxTestFlag : boolean
Whether to test maximal Intra/Extra distance ratio
IterationCountMax : integer
Maximal number of k-Means iterations
Name : string
Unique name of this object. Cannot be empty.
Intherited from: LMWrapName
Note : string
Text comment to this object (up to 255 characters)
Intherited from: LMWrapName
RandSeedInit : integer
Seed init number for pseudo-random numbers
TargetClassAttribute : TargetClassAttribute
the TargetClassAttribute, an optional class attribute
TargetClassAttributeFlag  (read-only) : boolean
Whether a class attribute has been set
TargetClusterMax : integer
Maximal target number of clusters
TargetClusterMin : integer
Minimal target number of clusters
TaskGenerationStatus  (read-only) : integer
Status code for task, see TaskGenerationStatus codes
Intherited from: Task
TaskGroup  (read-only) : TaskGroup
the TaskGroup, this task belongs to
Intherited from: Task

Methods

canDel() : boolean
Returns true if the object could be deleted (is not used)
Intherited from: LMWrap

Returns

  • boolean
clone() : Task
Creates a clone (an exact copy) of this task
Intherited from: Task

Returns

  • Task - cloned task
findFTWholeCedentSetting() : FTWholeCedentSetting
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.
Intherited from: Task

Parameters

  • luaTable - to store named parameters

Obligatory named parameters

  • nCedentTypeCode : integer - CedentType code to identify the whole cedent to find

Returns

findHypothesis() : Hypothesis
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.
Intherited from: Task

Parameters

  • luaTable - to store named parameters

Optional named parameters

  • nID : integer - an ID of the Hypothesis to look-up

Returns

findHypothesisGroup() : HypothesisGroup
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.
Intherited from: Task

Parameters

  • luaTable - to store named parameters

Optional named parameters

  • nID : integer - an ID of the HypothesisGroup to look-up
  • name : string - a name of the group of hypotheses to look-up

Returns

findMCPartialGroupSetting() : MCPartialGroupSetting
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.

Parameters

  • luaTable - to store named parameters

Obligatory named parameters

  • nID : integer - an ID of the MCPartialGroupSetting to look-up

Returns

getDataTable() : DataTable
Returns the DataTable this task is based on, the value of DataTable property
Intherited from: Task

Returns

getFTWholeCedentSettingCount() : integer
Returns number of whole cedents in this task
Intherited from: Task

Returns

  • integer
getHypothesisCount() : integer
Returns number of hypotheses in this task (if the value of TaskGenerationStatus property is equal or greater then Running, see TaskGenerationStatus codes
Intherited from: Task

Returns

  • integer
getHypothesisCountMax() : integer
Returns the value of HypothesisCountMax property
Intherited from: Task

Returns

  • integer
getHypothesisGroupCount() : integer
Returns number of groups of hypotheses in this task
Intherited from: Task

Returns

  • integer
getID() : integer
Returns unique identifier (primary key) of the object
Intherited from: LMWrap

Returns

  • integer
getMCAlgorithmTypeCode() : integer
Returns code of clustering algorithm type, see MCAlgorithmType codes

Returns

  • integer
getMCAlgorithmTypeKey() : string
Returns unique string key of clustering algorithm type

Returns

  • string
getMCAlgorithmTypeName() : string
Returns string representation of clustering algorithm type

Returns

  • string
getMCDistanceTypeCode() : integer
Returns code of objects distance measurement type, see MCDistanceType codes

Returns

  • integer
getMCDistanceTypeKey() : string
Returns unique string key of objects distance measurement type

Returns

  • string
getMCDistanceTypeName() : string
Returns string representation of objects distance measurement type

Returns

  • string
getMCLinkageTypeCode() : integer
Returns code of cluster linkage type, see MCLinkageType codes

Returns

  • integer
getMCLinkageTypeKey() : string
Returns unique string key of cluster linkage type

Returns

  • string
getMCLinkageTypeName() : string
Returns string representation of cluster linkage type

Returns

  • string
getMCPartialGroupSettingCount() : integer
Returns number of MCPartialGroupSettings for attributes in this task

Returns

  • integer
getName() : string
Returns the value of Name property, name of this object
Intherited from: LMWrapName

Returns

  • string
getNote() : string
Returns the value of Note property
Intherited from: LMWrapName

Returns

  • string
getTaskGenerationStatus() : integer
Returns the value of TaskGenerationStatus property
Intherited from: Task

Returns

  • integer
getTaskGenerationStatusStr() : string
Returns textual description of the value of TaskGenerationStatus property
Intherited from: Task

Returns

  • string
getTaskGroup() : TaskGroup
Returns the TaskGroup this task belongs to, the value of TaskGroup property
Intherited from: Task

Returns

getTaskSubTypeCode() : integer
Returns code of sub-type of this task (type of patterns it looks for), see TaskSubType codes
Intherited from: Task

Returns

  • integer
getTaskSubTypeKey() : string
Returns unique string key of sub-type of this task (type of patterns it looks for)
Intherited from: Task

Returns

  • string
getTaskSubTypeName() : string
Returns string representation of sub-type of this task (type of patterns it looks for)
Intherited from: Task

Returns

  • string
isDisabledFlag() : boolean
Returns the value of DisabledFlag property
Intherited from: Task

Returns

  • boolean
isTaskGenerationStatusFinished() : boolean
Returns true when the value of TaskGenerationStatus property is Solved, Interrupted or Failed
Intherited from: Task

Returns

  • boolean
isTaskGenerationStatusInProcess() : boolean
Returns true when the value of TaskGenerationStatus property is Waiting or Running
Intherited from: Task

Returns

  • boolean
onAdd()
Store the newly created object into metabase
Intherited from: LMWrap
onDel()
Delete the object from metabase (fails if canDel returns false)
Intherited from: LMWrap
onUpdate()
Save changes made to the object into metabase
Intherited from: LMWrap
prepareFTWholeCedentSettingArray() : luaTable
Returns array of FTWholeCedentSettings (the whole cedents in this task)
Intherited from: Task

Returns

  • luaTable
prepareHypothesisArray() : luaTable
Returns array of hypotheses in this task. Returns objects of a descendant class corresponding to this task type (ie. HypothesisFT for TaskFT etc.)
Intherited from: Task

Returns

  • luaTable
prepareHypothesisGroupArray() : luaTable
Returns array of groups of hypotheses in this task
Intherited from: Task

Returns

  • luaTable
prepareMCPartialGroupSettingArray() : luaTable
Returns array of MCPartialGroupSettings (groups of attributes in this task)

Returns

  • luaTable
queryTaskGenerationStatus() : integer
Re-reads the task state from metabase and returns 1 if the the state has changed from isTaskGenerationStatusInProcess to isTaskGenerationStatusFinished, otherwise returns 0
Intherited from: Task

Returns

  • integer - one or zero
runAndWaitForResults()
Starts the data-mining task and waits till it has finished
Intherited from: Task

Parameters

  • luaTable - to store named parameters

Optional named parameters

  • nTargetPlatform : integer - TargetPlatform code
  • bForceRunFinished : boolean - if true, forces the task to be run again even if it is already finished

Returns

  • integer - number of launched tasks (0 or 1)
runAsync()
Starts the task (if not already in isTaskGenerationStatusInProcess) in a parallel thread and returns immediately
Intherited from: Task

Parameters

  • luaTable - to store named parameters

Optional named parameters

  • nTargetPlatform : integer - TargetPlatform code
  • bForceRunFinished : boolean - if true, forces the task to be run again even if it is already finished

Returns

  • integer - number of launched tasks
setDisabledFlag( boolean )
Sets the value of DisabledFlag property
Intherited from: Task

Parameters

  • boolean
setHypothesisCountMax( integer )
Sets the value of HypothesisCountMax property
Intherited from: Task

Parameters

  • integer
setMCAlgorithmTypeCode( integer )
Sets code of clustering algorithm type, see MCAlgorithmType codes

Parameters

  • integer
setMCDistanceTypeCode( integer )
Sets code of objects distance measurement type, see MCDistanceType codes

Parameters

  • integer
setMCLinkageTypeCode( integer )
Sets code of cluster linkage type, see MCLinkageType codes

Parameters

  • integer
setName( string )
Sets the value of Name property, name of this object (must be unique)
Intherited from: LMWrapName

Parameters

  • string - cannot be empty
setNote( string )
Sets the value of Note property
Intherited from: LMWrapName

Parameters

  • string
setTaskGroup( TaskGroup )
Sets the TaskGroup this task belongs to, the value of TaskGroup property
Intherited from: Task

Parameters

waitForResults()
Waits till the task state changes to isTaskGenerationStatusFinished
Intherited from: Task

Parameters

  • luaTable - to store named parameters

Optional named parameters

  • nSleepTime : integer - time (in milliseconds) between two checks for change in metabase