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

Class FTLiteralSetting

Set of parameters describing all possible FT literals (basic boolean attributes) that should be generated and veryfied in the analyzed data
inherits from LMWrap
namespace: lm.tasks.settings

Constructor

FTLiteralSetting()
Creates a new object of this class

Parameters

  • luaTable - to store named parameters

Obligatory named parameters

Optional named parameters

  • nOrder : integer - position of the literal in the list of literals of its partial cedent

Properties List

Attribute  the Attribute, this literal is build upon
FTPartialCedentSetting  the FTPartialCedentSetting, this literal belongs to
HideCoefficientFlag  Whether to show categories in coefficient of this literal in interpretation
ID  Unique identifier (primary key) of the object
MaxLen  Maximal length of the partial cedent
MinLen  Minimal length of the partial cedent
Note  Additional note to this partial cedent
Order  Order-index of this literal in array of literals of its FTPartialCedentSetting

Methods List

canDel () Returns true if the object could be deleted (is not used)
getAttribute () Returns the Attribute, the attribute this literal is based upon, the value of Attribute property
getCategory () Returns the Category, the one and only category for the coefficient type of 'One category'
getCategoryVarAfter () Returns Category, the one and only category for the coefficient type of 'One category' for Ac4ft-Miner state 'After'
getFTCoefficientTypeCode () Returns code of coefficient type for this literal, see FTCoefficientType codes
getFTCoefficientTypeKey () Returns unique string key of coefficient type for this literal
getFTCoefficientTypeName () Returns string representation of coefficient type for this literal
getFTGaceTypeCode () Returns code of gace type (positive, negative or both) for this literal, see FTGaceType codes
getFTGaceTypeKey () Returns unique string key of gace type (positive, negative or both) for this literal
getFTGaceTypeName () Returns string representation of gace type (positive, negative or both) for this literal
getFTLiteralTypeCode () Returns code of literal type (basic or remaing) for this literal, see FTLiteralType codes
getFTLiteralTypeKey () Returns unique string key of literal type (basic or remaing) for this literal
getFTLiteralTypeName () Returns string representation of literal type (basic or remaing) for this literal
getFTPartialCedentSetting () Returns the FTPartialCedentSetting, the partial cedent this literal Setting belongs to, the value of FTPartialCedentSetting property
getID () Returns unique identifier (primary key) of the object
getMaxLen () Returns the value of MaxLen property
getMinLen () Returns the value of MinLen property
getNote () Returns the value of Note property
getOrder () Returns the value of Order property
isHideCoefficientFlag () Returns the value of HideCoefficientFlag 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
setAttribute () Sets the Attribute, the attribute this literal is based upon, the value of Attribute property
setCategory () Sets the Category, the one and only category for the coefficient type of 'One category'
setCategoryVarAfter () Sets Category, the one and only category for the coefficient type of 'One category' for Ac4ft-Miner state 'After'
setFTCoefficientTypeCode () Sets code of coefficient type for this literal, see FTCoefficientType codes
setFTGaceTypeCode () Sets code of gace type (positive, negative or both) for this literal, see FTGaceType codes
setFTLiteralTypeCode () Sets code of literal type (basic or remaing) for this literal, see FTLiteralType codes
setHideCoefficientFlag () Sets the value of HideCoefficientFlag property
setMaxLen () Sets the value of MaxLen property
setMinLen () Sets the value of MinLen property
setNote () Sets the value of Note property
setOrder () Sets the value of Order property

Properties

Attribute  (read-only) : Attribute
the Attribute, this literal is build upon
FTPartialCedentSetting  (read-only) : FTPartialCedentSetting
the FTPartialCedentSetting, this literal belongs to
HideCoefficientFlag : boolean
Whether to show categories in coefficient of this literal in interpretation
ID  (read-only) : integer
Unique identifier (primary key) of the object
Intherited from: LMWrap
MaxLen : integer
Maximal length of the partial cedent
MinLen : integer
Minimal length of the partial cedent
Note : string
Additional note to this partial cedent
Order : integer
Order-index of this literal in array of literals of its FTPartialCedentSetting

Methods

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

Returns

  • boolean
getAttribute() : Attribute
Returns the Attribute, the attribute this literal is based upon, the value of Attribute property

Returns

getCategory() : Category
Returns the Category, the one and only category for the coefficient type of 'One category'

Returns

getCategoryVarAfter() : Category
Returns Category, the one and only category for the coefficient type of 'One category' for Ac4ft-Miner state 'After'

Returns

getFTCoefficientTypeCode() : integer
Returns code of coefficient type for this literal, see FTCoefficientType codes

Returns

  • integer
getFTCoefficientTypeKey() : string
Returns unique string key of coefficient type for this literal

Returns

  • string
getFTCoefficientTypeName() : string
Returns string representation of coefficient type for this literal

Returns

  • string
getFTGaceTypeCode() : integer
Returns code of gace type (positive, negative or both) for this literal, see FTGaceType codes

Returns

  • integer
getFTGaceTypeKey() : string
Returns unique string key of gace type (positive, negative or both) for this literal

Returns

  • string
getFTGaceTypeName() : string
Returns string representation of gace type (positive, negative or both) for this literal

Returns

  • string
getFTLiteralTypeCode() : integer
Returns code of literal type (basic or remaing) for this literal, see FTLiteralType codes

Returns

  • integer
getFTLiteralTypeKey() : string
Returns unique string key of literal type (basic or remaing) for this literal

Returns

  • string
getFTLiteralTypeName() : string
Returns string representation of literal type (basic or remaing) for this literal

Returns

  • string
getFTPartialCedentSetting() : FTPartialCedentSetting
Returns the FTPartialCedentSetting, the partial cedent this literal Setting belongs to, the value of FTPartialCedentSetting property

Returns

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

Returns

  • integer
getMaxLen() : integer
Returns the value of MaxLen property

Returns

  • integer
getMinLen() : integer
Returns the value of MinLen property

Returns

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

Returns

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

Returns

  • integer
isHideCoefficientFlag() : boolean
Returns the value of HideCoefficientFlag property

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
setAttribute( Attribute )
Sets the Attribute, the attribute this literal is based upon, the value of Attribute property

Parameters

setCategory( Category )
Sets the Category, the one and only category for the coefficient type of 'One category'

Parameters

setCategoryVarAfter( Category )
Sets Category, the one and only category for the coefficient type of 'One category' for Ac4ft-Miner state 'After'

Parameters

setFTCoefficientTypeCode( integer )
Sets code of coefficient type for this literal, see FTCoefficientType codes

Parameters

  • integer
setFTGaceTypeCode( integer )
Sets code of gace type (positive, negative or both) for this literal, see FTGaceType codes

Parameters

  • integer
setFTLiteralTypeCode( integer )
Sets code of literal type (basic or remaing) for this literal, see FTLiteralType codes

Parameters

  • integer
setHideCoefficientFlag( boolean )
Sets the value of HideCoefficientFlag property

Parameters

  • boolean
setMaxLen( integer )
Sets the value of MaxLen property

Parameters

  • integer
setMinLen( integer )
Sets the value of MinLen property

Parameters

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

Parameters

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

Parameters

  • integer