Class Reference
IRIS for UNIX 2019.3
InterSystems: The power behind what matters   
Documentation  Search
  [ENSLIB] >  [%iKnow] >  [Stemming] >  [Configuration]
Private  Storage   

abstract 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
%Concurrency Name

Methods
%%OIDGet %1Check %AddJrnObjToSyncSet %AddToSaveSet
%AddToSyncSet %BMEBuilt %BindExport %BuildIndices
%BuildIndicesAsync %BuildIndicesAsyncResponse %BuildIndicesSegment %BuildObjectGraph
%CheckConstraints %CheckConstraintsForExtent %ClassIsLatestVersion %ClassName
%Close %ComposeOid %ConstructClone %Delete
%DeleteExtent %DeleteId %DispatchClassMethod %DispatchGetModified
%DispatchGetProperty %DispatchMethod %DispatchSetModified %DispatchSetMultidimProperty
%DispatchSetProperty %DowngradeConcurrency %ExecuteAfterTriggers %ExecuteBeforeTriggers
%Exists %ExistsId %Extends %FileIndices
%FileIndicesBuffered %GUID %GUIDSet %GetLock
%GetParameter %GetSwizzleObject %Id %IncrementCount
%InsertBatch %IsA %IsModified %IsNull
%JournalObject %KillExtent %KillExtentData %LoadFromMemory
%LockExtent %LockId %New %NormalizeObject
%ObjectIsNull %ObjectModified %Oid %OnBeforeAddToSync
%OnDetermineClass %OnNew %Open %OpenId
%OriginalNamespace %PackageName %PhysicalAddress %PurgeIndices
%Reload %RemoveFromSaveSet %ResolveConcurrencyConflict %RollBack
%SQLAcquireLock %SQLAcquireTableLock %SQLAfterTriggers %SQLBeforeTriggers
%SQLBuildIndices %SQLBuildPurgeIndexForRow %SQLBuildPurgeIndices %SQLCheckUnique
%SQLCheckUniqueIndices %SQLCheckUniqueKeys %SQLCopyIcolIntoName %SQLCopyNameIntoIcol
%SQLCreateInsDelTables %SQLDefineiDjVars %SQLDelete %SQLDeleteChildren
%SQLDeleteTempStreams %SQLEExit %SQLExists %SQLFKeyDelLock
%SQLFastInsert %SQLFieldValidate %SQLGetLock %SQLGetOld
%SQLGetOldAll %SQLGetOldIndex %SQLInsert %SQLInsertComputes
%SQLInsertStreams %SQLInvalid %SQLInvalid2 %SQLMVDelete
%SQLMVIndexDelete %SQLMVIndexInsert %SQLMVIndexUpdate %SQLMVInsert
%SQLMVUpdate %SQLMissing %SQLNormalizeCompFields %SQLNormalizeFields
%SQLPurgeIndices %SQLQuickBulkInsert %SQLQuickBulkLoad %SQLQuickBulkSave
%SQLQuickBulkUpdate %SQLQuickDelete %SQLQuickDeleteChildren %SQLQuickFindPKeyByRowID
%SQLQuickFindRowIDByPKey %SQLQuickInsert %SQLQuickLoad %SQLQuickLoadChildren
%SQLQuickLogicalToOdbc %SQLQuickOdbcToLogical %SQLQuickUpdate %SQLReleaseLock
%SQLReleaseTableLock %SQLStorageValidation %SQLTrigDelTab %SQLTrigInsTab
%SQLUnlock %SQLUnlock2 %SQLUnlockError %SQLUnlockRef
%SQLUpdate %SQLUpdateComputes %SQLUpdateStreams %SQLValidateCompFields
%SQLValidateFields %SQLicompView %SQLnBuild %Save
%SaveDirect %SaveIndices %SerializeObject %SetModified
%SortBegin %SortEnd %SyncObjectIn %SyncTransport
%UnlockExtent %UnlockId %UpgradeConcurrency %ValidateIndices
%ValidateObject 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.
• private classmethod NameIsValid(pValue As %String) as %Status

Indices

•index (NameIndex on Name) [Unique];


Copyright (c) 2019 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.