LISp-Miner Control Language Reference, version: 27.09.01 of 21 Apr 2017

Class DFQuantifierSetting

Set of parameters describing one SD4ft-quantifier, a criterion on interest measure comparing it to a threshold value
inherits from LMWrap
namespace: lm.tasks.settings

Constructor

DFQuantifierSetting()
Creates a new object of this class

Parameters

  • luaTable - to store named parameters

Obligatory named parameters

  • pTaskDF : TaskDF - to which this quantifier setting belongs
  • nDFQuantifierTypeCode : integer - DFQuantifierType code to define this quantifier type
  • nSDQuantifierSourceTypeCode : integer - SDQuantifierSourceType code to define this quantifier calculation source type

Optional named parameters

  • nCompareTypeCode : integer - CompareType code to define relation between interest measure and threshold value
  • nDFQuantifierValueTypeCode : integer - DFQuantifierValueType code describing threshold value units
  • dThresholdValue : float - universal threshold value (will be assigned to the proper parameter for the given quantifier type)
  • nOrder : integer - position of the quantifier in the list of quantifiers of its task

Properties List

ID  Unique identifier (primary key) of the object
Note  Additional note to this partial cedent
Order  Order-index of this partial cedent in array of partial cedent of its TaskDF
ThresholdValue  Threshold value

Methods List

canDel () Returns true if the object could be deleted (is not used)
getCompareTypeCode () Returns code of comparation type for threshold value, see CompareType codes
getCompareTypeKey () Returns unique string key of comparation type for threshold value
getCompareTypeName () Returns string representation of comparation type for threshold value
getDFQuantifierTypeCode () Returns code of quantifier type for this quantifier, see DFQuantifierType codes
getDFQuantifierTypeKey () Returns unique string key of quantifier type for this quantifier
getDFQuantifierTypeName () Returns string representation of quantifier type for this quantifier
getDFQuantifierValueTypeCode () Returns code of absolute/relative type threshold value, see DFQuantifierValueType codes
getDFQuantifierValueTypeKey () Returns unique string key of absolute/relative type threshold value
getDFQuantifierValueTypeName () Returns string representation of absolute/relative type threshold value
getID () Returns unique identifier (primary key) of the object
getNote () Returns the value of Note property
getOrder () Returns the value of Order property
getSDQuantifierSourceTypeCode () Returns code of calculation source type for this quantifier, see SDQuantifierSourceType codes
getSDQuantifierSourceTypeKey () Returns unique string key of calculation source type for this quantifier
getSDQuantifierSourceTypeName () Returns string representation of calculation source type for this quantifier
getTaskDF () Returns the TaskDF, the task this quantifier setting belongs to
getThresholdValue () Returns the value of Value property
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
setCompareTypeCode () Sets code of comparation type for threshold value, see CompareType codes
setDFQuantifierTypeCode () Sets code of quantifier type for this quantifier, see DFQuantifierType codes
setDFQuantifierValueTypeCode () Sets code of absolute/relative type threshold value, see DFQuantifierValueType codes
setNote () Sets the value of Note property
setOrder () Sets the value of Order property
setSDQuantifierSourceTypeCode () Sets code of calculation source type for this quantifier, see SDQuantifierSourceType codes
setThresholdValue () Sets the value of Value property

Properties

ID  (read-only) : integer
Unique identifier (primary key) of the object
Intherited from: LMWrap
Note : string
Additional note to this partial cedent
Order : integer
Order-index of this partial cedent in array of partial cedent of its TaskDF
ThresholdValue : float
Threshold value

Methods

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

Returns

  • boolean
getCompareTypeCode() : integer
Returns code of comparation type for threshold value, see CompareType codes

Returns

  • integer
getCompareTypeKey() : string
Returns unique string key of comparation type for threshold value

Returns

  • string
getCompareTypeName() : string
Returns string representation of comparation type for threshold value

Returns

  • string
getDFQuantifierTypeCode() : integer
Returns code of quantifier type for this quantifier, see DFQuantifierType codes

Returns

  • integer
getDFQuantifierTypeKey() : string
Returns unique string key of quantifier type for this quantifier

Returns

  • string
getDFQuantifierTypeName() : string
Returns string representation of quantifier type for this quantifier

Returns

  • string
getDFQuantifierValueTypeCode() : integer
Returns code of absolute/relative type threshold value, see DFQuantifierValueType codes

Returns

  • integer
getDFQuantifierValueTypeKey() : string
Returns unique string key of absolute/relative type threshold value

Returns

  • string
getDFQuantifierValueTypeName() : string
Returns string representation of absolute/relative type threshold value

Returns

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

Returns

  • integer
getNote() : string
Returns the value of Note property

Returns

  • string
getOrder() : integer
Returns the value of Order property

Returns

  • integer
getSDQuantifierSourceTypeCode() : integer
Returns code of calculation source type for this quantifier, see SDQuantifierSourceType codes

Returns

  • integer
getSDQuantifierSourceTypeKey() : string
Returns unique string key of calculation source type for this quantifier

Returns

  • string
getSDQuantifierSourceTypeName() : string
Returns string representation of calculation source type for this quantifier

Returns

  • string
getTaskDF() : TaskDF
Returns the TaskDF, the task this quantifier setting belongs to

Returns

getThresholdValue() : float
Returns the value of Value property

Returns

  • float
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
setCompareTypeCode( integer )
Sets code of comparation type for threshold value, see CompareType codes

Parameters

  • integer
setDFQuantifierTypeCode( integer )
Sets code of quantifier type for this quantifier, see DFQuantifierType codes

Parameters

  • integer
setDFQuantifierValueTypeCode( integer )
Sets code of absolute/relative type threshold value, see DFQuantifierValueType codes

Parameters

  • integer
setNote( string )
Sets the value of Note property

Parameters

  • string
setOrder( integer )
Sets the value of Order property

Parameters

  • integer
setSDQuantifierSourceTypeCode( integer )
Sets code of calculation source type for this quantifier, see SDQuantifierSourceType codes

Parameters

  • integer
setThresholdValue( float )
Sets the value of Value property

Parameters

  • float