LISp-Miner Control Language Reference, version: 27.13.01 of 25 Aug 2017

Class Category

Attribute category (enumeration of values or discretized interval)
inherits from LMWrapName
namespace: lm.prepro

Constructor

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

Properties List

Attribute  the Attribute, this category belongs to
Frequency  Number of objects of analyzed data matrix belonging to this category (calls calcCategoryFrequencies if necessary)
ID  Unique identifier (primary key) of the object
IncludeNullFlag  If this category covers NULL-values
IncludeNULLFlag  If this category covers NULL-values
Name  Unique name of this object. Cannot be empty.
NameHTML  HTML representation of this category
Note  Text comment to this object (up to 255 characters)
Order  Order-index of the category in array of categories of its attribute
XCategoryFlag  If this category is the X-Category

Methods List

canDel () Returns true if the object could be deleted (is not used)
getAttribute () Returns the Attribute this category belongs to, the value of Attribute property
getCategorySubTypeCode () Returns code of sub-type of category, see CategorySubType codes
getCategorySubTypeKey () Returns unique string key of sub-type of category
getCategorySubTypeName () Returns string representation of sub-type of category
getFrequency () Returns the value of Frequency property (calls calcCategoryFrequencies if necessary)
getID () Returns unique identifier (primary key) of the object
getName () Returns the value of Name property, name of this object
getNameDefault () Returns default name for this category
getNote () Returns the value of Note property
getOrder () Returns the value of Order property
getRowCount () Returns the value of Frequency property (calls calcCategoryFrequencies if necessary)
isIncludeNULLFlag () Returns the value of IncludeNullFlag property
isIncludeNullFlag () Returns the value of IncludeNullFlag property
isRowInCategory () Returns true if the value in database row identified by its index and the corresponding column belongs to this category (calls calcCategoryFrequencies if necessary)
isXCategoryFlag () Returns the value of XCategoryFlag 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
setIncludeNullFlag () Sets the value of IncludeNullFlag property
setIncludeNULLFlag () Sets the value of IncludeNullFlag property
setName () Sets the value of Name property, name of this object (must be unique)
setNote () Sets the value of Note property
setOrder () Sets the value of Order property
setXCategoryFlag () Sets the value of XCategoryFlag property

Properties

Attribute  (read-only) : Attribute
the Attribute, this category belongs to
Frequency  (read-only) : integer
Number of objects of analyzed data matrix belonging to this category (calls calcCategoryFrequencies if necessary)
ID  (read-only) : integer
Unique identifier (primary key) of the object
Intherited from: LMWrap
IncludeNullFlag : boolean
If this category covers NULL-values
IncludeNULLFlag : boolean
If this category covers NULL-values
Name : string
Unique name of this object. Cannot be empty.
Intherited from: LMWrapName
NameHTML  (read-only) : string
HTML representation of this category
Note : string
Text comment to this object (up to 255 characters)
Intherited from: LMWrapName
Order  (read-only) : integer
Order-index of the category in array of categories of its attribute
XCategoryFlag : boolean
If this category is the X-Category

Methods

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

Returns

  • boolean
getAttribute() : Attribute
Returns the Attribute this category belongs to, the value of Attribute property

Returns

getCategorySubTypeCode() : integer
Returns code of sub-type of category, see CategorySubType codes

Returns

  • integer
getCategorySubTypeKey() : string
Returns unique string key of sub-type of category

Returns

  • string
getCategorySubTypeName() : string
Returns string representation of sub-type of category

Returns

  • string
getFrequency() : integer
Returns the value of Frequency property (calls calcCategoryFrequencies if necessary)

Returns

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

Returns

  • integer
getName() : string
Returns the value of Name property, name of this object
Intherited from: LMWrapName

Returns

  • string
getNameDefault() : string
Returns default name for this category

Returns

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

Returns

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

Returns

  • integer
getRowCount() : integer
Returns the value of Frequency property (calls calcCategoryFrequencies if necessary)

Returns

  • integer
isIncludeNULLFlag() : boolean
Returns the value of IncludeNullFlag property

Returns

  • boolean
isIncludeNullFlag() : boolean
Returns the value of IncludeNullFlag property

Returns

  • boolean
isRowInCategory()
Returns true if the value in database row identified by its index and the corresponding column belongs to this category (calls calcCategoryFrequencies if necessary)

Parameters

  • integer - index of a database table row

Returns

  • boolean
isXCategoryFlag() : boolean
Returns the value of XCategoryFlag 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
setIncludeNullFlag( boolean )
Sets the value of IncludeNullFlag property

Parameters

  • boolean
setIncludeNULLFlag( boolean )
Sets the value of IncludeNullFlag property

Parameters

  • boolean
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
setOrder( integer )
Sets the value of Order property

Parameters

  • integer
setXCategoryFlag( boolean )
Sets the value of XCategoryFlag property

Parameters

  • boolean