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

Class MutualInfluence

Mutual influence between two attributes
inherits from LMWrapName
namespace: lm.domain

Constructor

MutualInfluence()
Creates a new object of this class

Parameters

  • luaTable - to store named parameters

Obligatory named parameters

  • pAttributeRow : Attribute - the first attribute from the pair
  • pAttributeCol : Attribute - the first attribute from the pair

Properties List

AttributeCol  the Attribute, first from the pair this Mutual influence is based upon (column)
AttributeRow  the Attribute, first from the pair this Mutual influence is based upon (row)
BKFTAARuleCount  Number of defined 4ft atomic association rules
Description  A description of the influence
ID  Unique identifier (primary key) of the object
Name  Unique name of this object. Cannot be empty.
Note  Text comment to this object (up to 255 characters)

Methods List

autoCreateDiagonaleNegative () Automatic creation of 4ft atomic association rules on the second diagonale (negative influence)
autoCreateDiagonalePositive () Automatic creation of 4ft atomic association rules on the first diagonale (positive influence)
canDel () Returns true if the object could be deleted (is not used)
canDelBKFTAARuleAll () Returns true if all BKFTAARules of this Mutual influence could be deleted (no one is used)
getAttributeCol () Returns the Attribute, first from the pair this mutual influence is based upon, the value of AttributeCol property
getAttributeRow () Returns the Attribute, first from the pair this mutual influence is based upon, the value of AttributeRow property
getDescription () Returns the value of Description property
getID () Returns unique identifier (primary key) of the object
getMutualInfluenceScopeTypeCode () Returns code of scope of mutual influence, see MutualInfluenceScopeType codes
getMutualInfluenceScopeTypeKey () Returns unique string key of scope of mutual influence
getMutualInfluenceScopeTypeName () Returns string representation of scope of mutual influence
getMutualInfluenceTypeCode () Returns code of type of mutual influence, see MutualInfluenceType codes
getMutualInfluenceTypeKey () Returns unique string key of type of mutual influence
getMutualInfluenceTypeName () Returns string representation of type of mutual influence
getMutualInfluenceValidityTypeCode () Returns code of validity type of mutual influence, see MutualInfluenceValidityType codes
getMutualInfluenceValidityTypeKey () Returns unique string key of validity type of mutual influence
getMutualInfluenceValidityTypeName () Returns string representation of validity type of mutual influence
getName () Returns the value of Name property, name of this object
getNote () Returns the value of Note property
checkHypothesisArray () Compares all the hypotheses in a task or a hypothesis group to this mutual influence and counts number of relationship types, see HypothesisMutualInfluenceRelationship codes
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
setMutualInfluenceScopeTypeCode () Sets code of scope of mutual influence, see MutualInfluenceScopeType codes
setMutualInfluenceTypeCode () Sets code of type of mutual influence, see MutualInfluenceType codes
setMutualInfluenceValidityTypeCode () Sets code of validity type of mutual influence, see MutualInfluenceValidityType codes
setName () Sets the value of Name property, name of this object (must be unique)
setNote () Sets the value of Note property

Properties

AttributeCol  (read-only) : name
the Attribute, first from the pair this Mutual influence is based upon (column)
AttributeRow  (read-only) : name
the Attribute, first from the pair this Mutual influence is based upon (row)
BKFTAARuleCount  (read-only) : integer
Number of defined 4ft atomic association rules
Description : string
A description of the influence
ID  (read-only) : integer
Unique identifier (primary key) of the object
Intherited from: LMWrap
Name : string
Unique name of this object. Cannot be empty.
Intherited from: LMWrapName
Note : string
Text comment to this object (up to 255 characters)
Intherited from: LMWrapName

Methods

autoCreateDiagonaleNegative()
Automatic creation of 4ft atomic association rules on the second diagonale (negative influence)
autoCreateDiagonalePositive()
Automatic creation of 4ft atomic association rules on the first diagonale (positive influence)
canDel() : boolean
Returns true if the object could be deleted (is not used)
Intherited from: LMWrap

Returns

  • boolean
canDelBKFTAARuleAll() : boolean
Returns true if all BKFTAARules of this Mutual influence could be deleted (no one is used)

Returns

  • boolean
getAttributeCol() : Attribute
Returns the Attribute, first from the pair this mutual influence is based upon, the value of AttributeCol property

Returns

getAttributeRow() : Attribute
Returns the Attribute, first from the pair this mutual influence is based upon, the value of AttributeRow property

Returns

getDescription() : string
Returns the value of Description property

Returns

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

Returns

  • integer
getMutualInfluenceScopeTypeCode() : integer
Returns code of scope of mutual influence, see MutualInfluenceScopeType codes

Returns

  • integer
getMutualInfluenceScopeTypeKey() : string
Returns unique string key of scope of mutual influence

Returns

  • string
getMutualInfluenceScopeTypeName() : string
Returns string representation of scope of mutual influence

Returns

  • string
getMutualInfluenceTypeCode() : integer
Returns code of type of mutual influence, see MutualInfluenceType codes

Returns

  • integer
getMutualInfluenceTypeKey() : string
Returns unique string key of type of mutual influence

Returns

  • string
getMutualInfluenceTypeName() : string
Returns string representation of type of mutual influence

Returns

  • string
getMutualInfluenceValidityTypeCode() : integer
Returns code of validity type of mutual influence, see MutualInfluenceValidityType codes

Returns

  • integer
getMutualInfluenceValidityTypeKey() : string
Returns unique string key of validity type of mutual influence

Returns

  • string
getMutualInfluenceValidityTypeName() : string
Returns string representation of validity type of mutual influence

Returns

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

Returns

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

Returns

  • string
checkHypothesisArray()
Compares all the hypotheses in a task or a hypothesis group to this mutual influence and counts number of relationship types, see HypothesisMutualInfluenceRelationship codes

Parameters

  • luaTable - to store named parameters

Optional named parameters

  • pTask : Task - a Task to compare all of its hypothesis to this Mutual Influence
  • pHypothesisGroup : HypothesisGroup - a group of hypotheses to compare all of its hypothesis to this Mutual Influence

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
setMutualInfluenceScopeTypeCode( integer )
Sets code of scope of mutual influence, see MutualInfluenceScopeType codes

Parameters

  • integer
setMutualInfluenceTypeCode( integer )
Sets code of type of mutual influence, see MutualInfluenceType codes

Parameters

  • integer
setMutualInfluenceValidityTypeCode( integer )
Sets code of validity type of mutual influence, see MutualInfluenceValidityType codes

Parameters

  • integer
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