|
|
| Line 1: |
Line 1: |
| {{CGscriptClass_Template
| | [[Category:Archive]] |
| |Name=<nowiki>LuceneDocument</nowiki>
| |
| |Description=<nowiki>Document to search for given the fields it contains</nowiki>
| |
| |Constructors=
| |
| {{CGscriptConstructors_Template|Parameters=
| |
| {{CGscriptParameters_Template|Type=string|Name=<nowiki>id</nowiki>|Description=<nowiki>Id of document</nowiki>}}
| |
| |Description=<nowiki>Instanciate new document</nowiki>}}
| |
| |Methods=
| |
| {{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>AddField</nowiki>|Parameters=
| |
| {{CGscriptParameters_Template|Type=LuceneColumn|Name=<nowiki>type</nowiki>|Description=<nowiki>Which column to store value in</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=object|Name=<nowiki>value</nowiki>|Description=<nowiki>Value to save</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=<nowiki>storeValue</nowiki>|Description=<nowiki>If true, the value can be extracted from the search result</nowiki>}}
| |
| |Description=<nowiki>Add a new field to the document. Multiple calls are valid for the same column, and it is not necessary to add values for all columns</nowiki>}}
| |
| {{CGscriptMethods_Template|ReturnType=object|Name=<nowiki>GetField</nowiki>|Parameters=
| |
| {{CGscriptParameters_Template|Type=LuceneColumn|Name=<nowiki>type</nowiki>|Description=<nowiki>Which column to get value from</nowiki>}}
| |
| |Description=<nowiki>Get the values for a given field. Only valid if storeValue was true when updating the document</nowiki>}}
| |
| {{CGscriptMethods_Template|ReturnType=array|Name=<nowiki>GetFields</nowiki>|Parameters=
| |
| {{CGscriptParameters_Template|Type=LuceneColumn|Name=<nowiki>type</nowiki>|Description=<nowiki>Which column to get values from</nowiki>}}
| |
| |Description=<nowiki>Get the values for a given field. Only valid if storeValue was true when updating the document</nowiki>}}
| |
| {{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Description=<nowiki>The string representation of the object.</nowiki>}}
| |
| |Properties=
| |
| {{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>Explain</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Explain why the search found this document</nowiki>}}
| |
| {{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>Id</nowiki>|HasGetter=1|Description=<nowiki>Id of the document</nowiki>}}
| |
| {{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ObjectTypeName</nowiki>|HasGetter=1|Description=<nowiki>The name of the type of object.</nowiki>}}
| |
| {{CGscriptProperties_Template|ReturnType=number|Name=<nowiki>ResultScore</nowiki>|HasGetter=1|Description=<nowiki>The score generated by Lucene for this search result</nowiki>}}
| |
| {{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Description=<nowiki>Get information about this class.</nowiki>}}
| |
| }}
| |
