Skip to main content

%SYSTEM.Context.iFind

Property Inventory

Method Inventory

Properties

property DirectInput as %iFind.DirectInput;
Property methods: DirectInputGet(), DirectInputGetSwizzled(), DirectInputIsValid(), DirectInputNewObject(), DirectInputSet()
property Indexer as %iKnow.Indexer [ MultiDimensional ];
Property methods: IndexerGet(), IndexerGetSwizzled(), IndexerIsValid(), IndexerNewObject(), IndexerSet()
property Ranker [ MultiDimensional ];
Property methods: RankerDisplayToLogical(), RankerGet(), RankerIsValid(), RankerLogicalToDisplay(), RankerLogicalToOdbc(), RankerNormalize(), RankerSet()
property Stemmer as %iKnow.Stemmer [ MultiDimensional ];
Property methods: StemmerGet(), StemmerGetSwizzled(), StemmerIsValid(), StemmerNewObject(), StemmerSet()

Methods

method CleanRankers(pMaxLifetime As %Integer = "", pMaxSize As %Integer = "", pGraceTime As %Integer = "") as %Status

This method cleans up the cache of %iFind.Rank.Abstract objects kept by iFind to satisfy ranked queries. The basic policy is as follows:

  1. First kill all rankers objects that have not been used for more than pMaxLifetime seconds.
  2. Then, get get rid of the oldest ones until at most pMaxSize are left, except if they've been used less than pGraceTime seconds ago.

This method is invoked automatically upon requesting a ranker object if it hasn't been run in the last pMaxLifetime seconds for this process.

The default values for these parameters can be overriden by setting the following globals:

 set ^ISC.IF.Settings("RankerCacheLifetime") = 600
   set ^ISC.IF.Settings("RankerCacheSize") = 50
   set ^ISC.IF.Settings("RankerCacheGrace") = 10

method CleanRankersForClass(pClassName As %String) as %Status
Cleans the Ranker cache for a specific class, when it gets recompiled.
method GetIndexer(pLanguage As %String(MAXLEN=10)="en", Output pDirect As %iFind.DirectInput, Output pIndexer As %iKnow.Indexer)
Return DirectInput object and Indexer object for iFind for the specified language. pLanguage - The language used by the iKnow Indexer. Perhaps the default should be configurable? This method is a THROWer.
method GetRanker(Output pRanker As %iFind.Rank.Abstract, pRankerClass As %String = $$$IFDEFAULTRANKER, pClassName As %String, pIndexName As %String, pSearchString As %String, pSearchOptions As %String) as %Status
Returns a ranker object initialized for the supplied parameters.
method GetStemmer(pLanguage As %String = "en", Output pStemmer As %iKnow.Stemmer, pConfigName As %String = "") as %Status
method Reset()
Clears all iFind-related cached objects held by this Context object.

Inherited Members

Inherited Methods

FeedbackOpens in a new tab