Class TaskKL

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

Constructor

TaskKL()

Creates a new object of this class

Parameters

• luaTable - to store named parameters

Obligatory named parameters

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

Properties List

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
ExtensionsCheckMinLenFlag	Include the minimal length check when considering extensions
HypothesisCountMax	Maximal number of hypotheses before generation is interrupted
ID	Unique identifier (primary key) of the object
IncludeSameFreqExtensionCoefficientFlag	Include extensions of coefficients with no change in the four-fold table
IncludeSameFreqExtensionLiteralFlag	Include extensions of cedents with no change in the four-fold table
IncludeWorseExtensionConditionFlag	Include (worse) Condition extensions (for implications and AAD/BAD)
Name	Unique name of this object. Cannot be empty.
Note	Text comment to this object (up to 255 characters)
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.
findKLColPartialGroupSetting ()	Tries to look-up a KLPartialGroupSetting with a unique property given as parameter. Just one parameter has to be specified. Returns nil if KLPartialGroupSetting with this property doesn't exists.
findKLQuantifierSetting ()	Tries to look-up a KLQuantifierSetting with a unique property given as parameter. Just one parameter has to be specified. Returns nil if KLQuantifierSetting with this property doesn't exists.
findKLRowPartialGroupSetting ()	Tries to look-up a KLPartialGroupSetting with a unique property given as parameter. Just one parameter has to be specified. Returns nil if KLPartialGroupSetting 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
getKLColPartialGroupSettingCount ()	Returns number of KLPartialGroupSettings for column attributes in this task
getKLQuantifierSettingCount ()	Returns number of quantifiers in this task
getKLRowPartialGroupSettingCount ()	Returns number of KLPartialGroupSettings for row 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
prepareKLColPartialGroupSettingArray ()	Returns array of KLPartialGroupSettings (groups of column attributes in this task)
prepareKLQuantifierSettingArray ()	Returns array of KLQuantifierSettings (quantifiers in this task)
prepareKLRowPartialGroupSettingArray ()	Returns array of KLPartialGroupSettings (groups of row 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
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

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

ExtensionsCheckMinLenFlag : boolean

Include the minimal length check when considering extensions

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

IncludeSameFreqExtensionCoefficientFlag : boolean

Include extensions of coefficients with no change in the four-fold table

IncludeSameFreqExtensionLiteralFlag : boolean

Include extensions of cedents with no change in the four-fold table

IncludeWorseExtensionConditionFlag : boolean

Include (worse) Condition extensions (for implications and AAD/BAD)

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

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

• FTWholeCedentSetting - or nil

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

• Hypothesis - or nil

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

• HypothesisGroup - or nil

findKLColPartialGroupSetting() : KLPartialGroupSetting

Tries to look-up a KLPartialGroupSetting with a unique property given as parameter. Just one parameter has to be specified. Returns nil if KLPartialGroupSetting with this property doesn't exists.

Parameters

• luaTable - to store named parameters

Obligatory named parameters

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

Returns

• KLPartialGroupSetting - or nil

findKLQuantifierSetting() : KLQuantifierSetting

Tries to look-up a KLQuantifierSetting with a unique property given as parameter. Just one parameter has to be specified. Returns nil if KLQuantifierSetting with this property doesn't exists.

Parameters

• luaTable - to store named parameters

Optional named parameters

• nKLQuantifierTypeCode : integer - KLQuantifierType code to identify the quantifier to find

Returns

• KLQuantifierSetting - or nil

findKLRowPartialGroupSetting() : KLPartialGroupSetting

Tries to look-up a KLPartialGroupSetting with a unique property given as parameter. Just one parameter has to be specified. Returns nil if KLPartialGroupSetting with this property doesn't exists.

Parameters

• luaTable - to store named parameters

Obligatory named parameters

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

Returns

• KLPartialGroupSetting - or nil

getDataTable() : DataTable

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

Returns

• DataTable

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

getKLColPartialGroupSettingCount() : integer

Returns number of KLPartialGroupSettings for column attributes in this task

Returns

• integer

getKLQuantifierSettingCount() : integer

Returns number of quantifiers in this task

Returns

• integer

getKLRowPartialGroupSettingCount() : integer

Returns number of KLPartialGroupSettings for row 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

• TaskGroup

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

prepareKLColPartialGroupSettingArray() : luaTable

Returns array of KLPartialGroupSettings (groups of column attributes in this task)

Returns

• luaTable

prepareKLQuantifierSettingArray() : luaTable

Returns array of KLQuantifierSettings (quantifiers in this task)

Returns

• luaTable

prepareKLRowPartialGroupSettingArray() : luaTable

Returns array of KLPartialGroupSettings (groups of row 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

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

• TaskGroup

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