LISp-Miner Control Language Reference, version: 27.15.01 of 27 Oct 2017

Class FTPartialCedentSetting

Set of parameters describing all possible FT-partial cedents (derived boolean attributes) that should be generated and veryfied in the analyzed data. Each FT-partial cedent consists of one or more FT-literals combined through logical operators.
inherits from LMWrap
namespace: lm.tasks.settings

Constructor

FTPartialCedentSetting()
Creates a new object of this class

Parameters

  • luaTable - to store named parameters

Obligatory named parameters

  • pTask : Task - to which this cedent setting belongs
  • nCedentTypeCode : integer - CedentType code to identify the Partial cedent to find

Optional named parameters

  • name : string - optional name description for the new partial cedent
  • nOrder : integer - position of the partial cedent in the list of partial cedents of its whole cedent

Properties List

Description  Textual description of this partial cedent. Deprecated!
ID  Unique identifier (primary key) of the object
MaxLen  Maximal length of the partial cedent
MinLen  Minimal length of the partial cedent
Name  Textual description of this partial cedent
Note  Additional note to this partial cedent
Order  Order-index of this partial cedent in array of partial cedent of its FTWholeCedentSetting
Task  the Task, this partial cedent belongs to

Methods List

canDel () Returns true if the object could be deleted (is not used)
findFTLiteralSetting () Tries to look-up a FTLiteralSetting with a unique property given as parameter. Just one parameter has to be specified. Returns nil if FTLiteralSetting with this property doesn't exists.
getBoolOpTypeCode () Returns code of literals boolean type (conjunction or disjunction) for this partial cedent, see BoolOpType codes
getBoolOpTypeKey () Returns unique string key of literals boolean type (conjunction or disjunction) for this partial cedent
getBoolOpTypeName () Returns string representation of literals boolean type (conjunction or disjunction) for this partial cedent
getCedentTypeCode () Returns code of type of cedent, see CedentType codes
getCedentTypeKey () Returns unique string key of type of cedent
getCedentTypeName () Returns string representation of type of cedent
getDescription () Returns the value of Description property
getFTLiteralSettingCount () Returns number of literal Setting in this partial cedent
getID () Returns unique identifier (primary key) of the object
getMaxLen () Returns the value of MaxLen property
getMaxLenReal () Returns the real maximal length (after considering maximal lengths of all its partial cedents)
getMinLen () Returns the value of MinLen property
getMinLenReal () Returns the real minimal length (after considering minimal lengths of all its partial cedents)
getName () Returns the value of Name property
getNote () Returns the value of Note property
getOrder () Returns the value of Order property
getTask () Returns the Task this partial cedent setting belongs to, the value of Task 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
prepareFTLiteralSettingArray () Returns array of FTLiteralSettings (literals in this partial cedent)
setBoolOpTypeCode () Sets code of literals boolean type (conjunction or disjunction) for this partial cedent, see BoolOpType codes
setDescription () Sets the value of Description property
setMaxLen () Sets the value of MaxLen property
setMinLen () Sets the value of MinLen property
setName () Sets the value of Name property
setNote () Sets the value of Note property
setOrder () Sets the value of Order property

Properties

Description : string
Textual description of this partial cedent. Deprecated!
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
Name : string
Textual description of this partial cedent
Note : string
Additional note to this partial cedent
Order : integer
Order-index of this partial cedent in array of partial cedent of its FTWholeCedentSetting
Task  (read-only) : Task
the Task, this partial cedent belongs to

Methods

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

Returns

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

Parameters

  • luaTable - to store named parameters

Optional named parameters

  • nID : integer - an ID of the FTLiteralSetting to look-up
  • pAttribute : Attribute - the literal should be based on (return the first literal matching the condition)

Returns

getBoolOpTypeCode() : integer
Returns code of literals boolean type (conjunction or disjunction) for this partial cedent, see BoolOpType codes

Returns

  • integer
getBoolOpTypeKey() : string
Returns unique string key of literals boolean type (conjunction or disjunction) for this partial cedent

Returns

  • string
getBoolOpTypeName() : string
Returns string representation of literals boolean type (conjunction or disjunction) for this partial cedent

Returns

  • string
getCedentTypeCode() : integer
Returns code of type of cedent, see CedentType codes

Returns

  • integer
getCedentTypeKey() : string
Returns unique string key of type of cedent

Returns

  • string
getCedentTypeName() : string
Returns string representation of type of cedent

Returns

  • string
getDescription() : string
Returns the value of Description property

Returns

  • string
getFTLiteralSettingCount() : integer
Returns number of literal Setting in this partial cedent

Returns

  • integer
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
getMaxLenReal() : integer
Returns the real maximal length (after considering maximal lengths of all its partial cedents)

Returns

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

Returns

  • integer
getMinLenReal() : integer
Returns the real minimal length (after considering minimal lengths of all its partial cedents)

Returns

  • integer
getName() : string
Returns the value of Name property

Returns

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

Returns

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

Returns

  • integer
getTask() : Task
Returns the Task this partial cedent setting belongs to, the value of Task property

Returns

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
prepareFTLiteralSettingArray() : luaTable
Returns array of FTLiteralSettings (literals in this partial cedent)

Returns

  • luaTable
setBoolOpTypeCode( integer )
Sets code of literals boolean type (conjunction or disjunction) for this partial cedent, see BoolOpType codes

Parameters

  • integer
setDescription( string )
Sets the value of Description property

Parameters

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

Parameters

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

Parameters

  • integer
setName( string )
Sets the value of Name property

Parameters

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

Parameters

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

Parameters

  • integer