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...")
 
Line 3: Line 3:
 
|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=
 
|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=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=string|Name=<nowiki>ToString</nowiki>|Description=<nowiki>The string representation of the object.</nowiki>}}
 
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Description=<nowiki>The string representation of the object.</nowiki>}}
 
|Properties=
 
|Properties=

Revision as of 08:12, 21 June 2017

LuceneAutoCompleteIndexCreator



Creates and updates lucene indexes to help find things

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
  • string ToString() - The string representation of the object.

Properties

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