%iKnow.Stemming.Configuration

deprecated abstract persistent class %iKnow.Stemming.Configuration extends %Library.Persistent

SQL Table Name: %iKnow_Stemming.Configuration

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.

Property Inventory

Name

Properties

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

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

Property methods: NameDisplayToLogical(), NameGet(), NameGetStored(), NameLogicalToDisplay(), NameLogicalToOdbc(), NameNormalize(), NameSet()

Methods

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

Inherited description: 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.

Indexes

index (IDKEY on ) [IdKey, Type = key];

Index methods: IDKEYCheck(), IDKEYDelete(), IDKEYExists(), IDKEYOpen(), IDKEYSQLCheckUnique(), IDKEYSQLExists(), IDKEYSQLFindPKeyByConstraint(), IDKEYSQLFindRowIDByConstraint()

index (NameIndex on Name) [Unique];

Index methods: NameIndexCheck(), NameIndexCheckUnique(), NameIndexDelete(), NameIndexExists(), NameIndexOpen(), NameIndexSQLCheckUnique(), NameIndexSQLExists(), NameIndexSQLFindPKeyByConstraint(), NameIndexSQLFindRowIDByConstraint()

Inherited Members

Inherited Methods

Storage

Storage Model: Storage (%iKnow.Stemming.Configuration)

^IRIS.IK.Sys.StemmerConfigD(ID)

%%CLASSNAME

Name