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

Class FTLiteral

Basic boolean attribute, combination of an multi-categorial attribute and one or more of its categories in coefficient
inherits from LMWrap
namespace: lm.tasks.results

Constructor

No constructor available. Objects of this class could not be instantiated from Lua scripts.

Properties List

Attribute  the Attribute this literal is based upon
CategoryCount  Number of categories in coefficient
CoefficientSize  Number of categories in coefficient (alias for the value of CategoryCount property)
ID  Unique identifier (primary key) of the object
NegationFlag  Whether this literal has logical negation prefix
Text  Textual representation of this literal

Methods List

findCategory () Tries to look-up a Category with a unique property given as parameter. Just one parameter has to be specified. Returns nil if Category with this property doesn't exists.
getAttribute () Returns the Attribute, the Attribute this literal is based upon
getCategoryCount () Returns the value of CategoryCount property
getFTLiteralSetting () Returns the FTLiteralSetting, the FTLiteralSetting this literal is based upon
getFTPartialCedent () Returns the FTPartialCedent, the partial cedent this literal belongs to
getID () Returns unique identifier (primary key) of the object
prepareCategoryArray () Returns array of Category'ies composing coefficient of this literal

Properties

Attribute  (read-only) : Attribute
the Attribute this literal is based upon
CategoryCount  (read-only) : string
Number of categories in coefficient
CoefficientSize  (read-only) : string
Number of categories in coefficient (alias for the value of CategoryCount property)
ID  (read-only) : integer
Unique identifier (primary key) of the object
Intherited from: LMWrap
NegationFlag  (read-only) : boolean
Whether this literal has logical negation prefix
Text  (read-only) : string
Textual representation of this literal

Methods

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

Parameters

  • luaTable - to store named parameters

Optional named parameters

  • nID : integer - an ID of the category to look-up
  • name : string - a name of the category to look-up

Returns

getAttribute() : Attribute
Returns the Attribute, the Attribute this literal is based upon

Returns

getCategoryCount() : integer
Returns the value of CategoryCount property

Returns

  • integer
getFTLiteralSetting() : FTLiteralSetting
Returns the FTLiteralSetting, the FTLiteralSetting this literal is based upon

Returns

getFTPartialCedent() : FTPartialCedent
Returns the FTPartialCedent, the partial cedent this literal belongs to

Returns

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

Returns

  • integer
prepareCategoryArray() : luaTable
Returns array of Category'ies composing coefficient of this literal

Returns

  • luaTable