Difference between revisions of "LuceneAutoCompleteIndexCreator class"

From Catglobe Wiki
Jump to: navigation, search
(Created page with "{{CGscriptClass_Template |Name=<nowiki>LuceneAutoCompleteIndexCreator</nowiki> |Description=<nowiki>Creates and updates lucene indexes to help find things</nowiki> |Constructo...")
 
 
(One intermediate revision by one other user not shown)
Line 2: Line 2:
 
|Name=<nowiki>LuceneAutoCompleteIndexCreator</nowiki>
 
|Name=<nowiki>LuceneAutoCompleteIndexCreator</nowiki>
 
|Description=<nowiki>Creates and updates lucene indexes to help find things</nowiki>
 
|Description=<nowiki>Creates and updates lucene indexes to help find things</nowiki>
|Constructors=
+
|InheritsFrom=object|Constructors=
{{CGscriptConstructors_Template|Parameters=
+
{{CGscriptConstructors_Template|Description=<nowiki>Initialize a index creator</nowiki>}}
{{CGscriptParameters_Template|Type=string|Name=<nowiki>name</nowiki>|Description=<nowiki>Name of the index</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>parentResourceId</nowiki>|Description=<nowiki>Resource to check permissions on</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>nrPrefix</nowiki>|Description=<nowiki>Number of chars before prefix is used before infix</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=Dictionary|Name=<nowiki>dict</nowiki>|Description=<nowiki>Dictionary of searchValues and weight (number of occurances)</nowiki>}}
+
|Methods=
 +
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>CreateOrOverwrite</nowiki>|Parameters=
 +
{{CGscriptParameters_Template|Type=string|Name=<nowiki>name</nowiki>|Description=<nowiki>Name of the index</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>parentResourceId</nowiki>|Description=<nowiki>Resource to check permissions on</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>nrPrefix</nowiki>|Description=<nowiki>Number of chars before prefix is used before infix</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=Dictionary|Name=<nowiki>dict</nowiki>|Description=<nowiki>Dictionary of searchValues and weight (number of occurances). Must have atleast 1 value</nowiki>}}
 
|Description=<nowiki>Initialize a brand new index, or overwrite all values in existing</nowiki>}}
 
|Description=<nowiki>Initialize a brand new index, or overwrite all values in existing</nowiki>}}
|Methods=
+
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Inherited=object|Description=<nowiki>The string representation of the object.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>Commit</nowiki>|Description=<nowiki>Ensure all changes are serialized to disc. No changes are allowed after calling this.</nowiki>}}
+
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>UpdateWeights</nowiki>|Parameters=
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Description=<nowiki>The string representation of the object.</nowiki>}}
+
{{CGscriptParameters_Template|Type=string|Name=<nowiki>name</nowiki>|Description=<nowiki>Name of the index</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>parentResourceId</nowiki>|Description=<nowiki>Resource to check permissions on</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>nrPrefix</nowiki>|Description=<nowiki>Number of chars before prefix is used before infix</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=Dictionary|Name=<nowiki>dict</nowiki>|Description=<nowiki>Dictionary of searchValues and change in weight (number of occurances, may be negative). Must have atleast 1 value</nowiki>}}
 +
|Description=<nowiki>Update weights</nowiki>}}
 
|Properties=
 
|Properties=
 
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ObjectTypeName</nowiki>|HasGetter=1|Description=<nowiki>The name of the type of object.</nowiki>}}
 
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ObjectTypeName</nowiki>|HasGetter=1|Description=<nowiki>The name of the type of object.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Description=<nowiki>Get information about this class.</nowiki>}}
+
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Inherited=object|Description=<nowiki>Get information about this class.</nowiki>}}
 
}}
 
}}

Latest revision as of 05:45, 2 July 2020

LuceneAutoCompleteIndexCreator



Creates and updates lucene indexes to help find things

Parent class

Inherits from object

Constructors

  • () - Initialize a index creator

Methods

  • Empty CreateOrOverwrite(string name "Name of the index", int parentResourceId "Resource to check permissions on", int nrPrefix "Number of chars before prefix is used before infix", Dictionary dict "Dictionary of searchValues and weight (number of occurances). Must have atleast 1 value") - Initialize a brand new index, or overwrite all values in existing
  • (From object) string ToString() - The string representation of the object.
  • Empty UpdateWeights(string name "Name of the index", int parentResourceId "Resource to check permissions on", int nrPrefix "Number of chars before prefix is used before infix", Dictionary dict "Dictionary of searchValues and change in weight (number of occurances, may be negative). Must have atleast 1 value") - Update weights

Properties

  • string ObjectTypeName { get; } - The name of the type of object.
  • (From object) TypeInformation TypeInformation { get; } - Get information about this class.