Class %iKnow.Stemming.Configuration

deprecatedabstract persistent class %iKnow.Stemming.Configuration extends %Persistent

This class encapsulates the configuration settings of a customized %iKnow.Stemmer object, as identified by a configuration name. Use GetStemmer to retrieve a saved stemmer configuration.

Look at the subclasses for actual stemmer-specific parameters.

Inventory

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
	1	4		1

Summary

Properties
Name

Methods
%%CLASSNAMELogicalToStorage	%%CLASSNAMEStorageToLogical	%AddToSaveSet	%AddToSyncSet
%BMEBuilt	%BuildIndicesAsync	%BuildIndicesAsyncResponse	%CheckConstraints
%CheckConstraintsForExtent	%ClassIsLatestVersion	%ClassName	%ComposeOid
%ConstructClone	%Delete	%DeleteExtent	%DeleteId
%DispatchClassMethod	%DispatchGetModified	%DispatchGetProperty	%DispatchMethod
%DispatchSetModified	%DispatchSetMultidimProperty	%DispatchSetProperty	%Exists
%ExistsId	%Extends	%GUID	%GUIDSet
%GetLock	%GetParameter	%GetSwizzleObject	%Id
%InsertBatch	%IsA	%IsModified	%IsNull
%KillExtent	%KillExtentData	%LoadFromMemory	%LockExtent
%LockId	%New	%NormalizeObject	%ObjectIsNull
%ObjectModified	%Oid	%OnBeforeAddToSync	%OnDeleteFinally
%OnDetermineClass	%OnNew	%OnOpenFinally	%OnSaveFinally
%Open	%OpenId	%OriginalNamespace	%PackageName
%PhysicalAddress	%PurgeIndices	%Reload	%RemoveFromSaveSet
%ResolveConcurrencyConflict	%RollBack	%Save	%SaveDirect
%SaveIndices	%SerializeObject	%SetModified	%SortBegin
%SortEnd	%SyncObjectIn	%SyncTransport	%UnlockExtent
%UnlockId	%ValidateIndices	%ValidateObject	%ValidateTable
CreateStemmerObject	GetStemmer

Subclasses
%iKnow.Stemming.HunspellConfig	%iKnow.Stemming.MultiLanguageConfig	%iKnow.Stemming.TextConfig

Properties

• property Name as %String(MAXLEN=150) [ Required ];

Name of this stemmer configuration. Should be unique within the namespace

Methods

• method %OnNew(pName As %String) as %Status

This callback method is invoked by the %New method to provide notification that a new instance of an object is being created.
If this method returns an error then the object will not be created.
It is passed the arguments provided in the %New call. When customizing this method, override the arguments with whatever variables and types you expect to receive from %New(). For example, if you're going to call %New, passing 2 arguments, %OnNew's signature could be:
Method %OnNew(dob as %Date = "", name as %Name = "") as %Status If instead of returning a %Status code this returns an oref and this oref is a subclass of the current class then this oref will be the one returned to the caller of %New method.

• abstract method CreateStemmerObject(Output pStemmer As %iKnow.Stemmer) as %Status

Instantiates a stemmer object based on the current object's configuration. (Does not need to be persisted)

• final classmethod GetStemmer(pName As %String, Output pStemmer As %iKnow.Stemmer) as %Status

Instantiates a stemmer object based on the stemmer configuration saved with Name = pName. Alternatively, if pName is a colon-delimited list of which the first entry is a valid class name referring to a class that inherits from %iKnow.Stemmer, that class is instantiated, using the remaining elements of the list as arguments for its %New method.

Indices

•index (NameIndex on Name) [Unique];

Class Reference IRIS for UNIX 2024.1.2
Documentation Search