|
|
| Line 1: |
Line 1: |
| {{CGscriptClass_Template
| |
| |Name=<nowiki>LuceneIndexSearcher</nowiki>
| |
| |Description=<nowiki>Find documents</nowiki>
| |
| |Constructors=
| |
| {{CGscriptConstructors_Template|Parameters=
| |
| {{CGscriptParameters_Template|Type=string|Name=<nowiki>name</nowiki>|Description=<nowiki>Name of the index</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=array|Name=<nowiki>columns</nowiki>|Description=<nowiki>The column configuration. This MUST be the same every time every time for the same index, or a new index must be created</nowiki>}}
| |
| |Description=<nowiki>Instanciate searcher</nowiki>}}
| |
| |Methods=
| |
| {{CGscriptMethods_Template|ReturnType=array|Name=<nowiki>GetAll</nowiki>|Parameters=
| |
| {{CGscriptParameters_Template|Type=LuceneColumn|Name=<nowiki>orderByColumn</nowiki>|Description=<nowiki>Which column to order by</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=<nowiki>orderByDirection</nowiki>|Description=<nowiki>False if ascending</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>nrHits</nowiki>|Description=<nowiki>How many results to try to get</nowiki>}}
| |
| |Description=<nowiki>Get all documents</nowiki>}}
| |
| {{CGscriptMethods_Template|ReturnType=array|Name=<nowiki>Search</nowiki>|Parameters=
| |
| {{CGscriptParameters_Template|Type=string|Name=<nowiki>queryString</nowiki>|Description=<nowiki>Query to search for. See https://lucene.apache.org/core/2_9_4/queryparsersyntax.html</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>nrHits</nowiki>|Description=<nowiki>How many results to try to get</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=<nowiki>addExplain</nowiki>|Description=<nowiki>Add explaination. This is also limits nrHits to 10</nowiki>}}
| |
| |Description=<nowiki>Find documents</nowiki>}}
| |
| {{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Description=<nowiki>The string representation of the object.</nowiki>}}
| |
| |Properties=
| |
| {{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>Hits</nowiki>|HasGetter=1|Description=<nowiki>Number of hits found. This may be different than the number of documents returned</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>}}
| |
| }}
| |
| [[Category:Archive]] | | [[Category:Archive]] |
