Inheritance diagram for UserDictionary:

[legend]

Collaboration diagram for UserDictionary:

[legend]

Public Member Functions
_.Library.Status	AddCertaintyTerm (_.Library.String pWord, _.Library.Integer pLevel, pPosition)
	Use pLevel to specify the level of certainty for this term (1-9). More...

_.Library.Status	AddEntry (_.Library.String pRewriteFrom, _.Library.String pRewriteTo, _.Library.Integer pPosition)

_.Library.Status	ClearEntries ()
	Removes all entries from this user dictionary (only relevant for non-transient ones)

_.Library.Status	GetEntries (pResult)

_.Library.Status	RemoveEntry (_.Library.Integer pPosition)

Public Member Functions inherited from Persistent
_.Library.Status	AcquireLock (_.Library.String locktype)
	Acquires a lock for the current instance. More...

_.Library.Status	LoadData (_.Library.String id)
	LoadData() - loads an object from storage. More...

_.Library.Status	OnAfterSave (_.Library.Boolean insert)
	This callback method is invoked by the <METHOD>Save</METHOD> method to. More...

_.Library.Status	OnBeforeSave (_.Library.Boolean insert)
	This callback method is invoked by the <METHOD>Save</METHOD> method to. More...

_.Library.Status	OnOpen ()
	This callback method is invoked by the <METHOD>Open</METHOD> method to. More...

_.Library.Status	OnReload ()
	This callback method is invoked by the <METHOD>Reload</METHOD> method to. More...

_.Library.Status	OnRollBack ()
	This callback method is invoked by the <METHOD>Save</METHOD> method to. More...

_.Library.Status	ReleaseLock (_.Library.String locktype)
	Releases a lock for the current instance. More...

_.Library.Status	SaveData (_.Library.String id)
	SaveData() - saves an object to disk, checks uniqueness and referential More...

Public Member Functions inherited from SwizzleObject
_.Library.Status	OnJournalObject (_.Library.Integer tranid, _.Library.Integer jrnid, _.Library.String filter)
	This callback method is invoked by the <METHOD>JournalObject</METHOD> method to. More...

Public Member Functions inherited from RegisteredObject
_.Library.Status	OnAddToSaveSet (_.Library.Integer depth, _.Library.Integer insert, _.Library.Integer callcount)
	This callback method is invoked when the current object is added to the SaveSet,. More...

_.Library.Status	OnClose ()
	This callback method is invoked by the <METHOD>Close</METHOD> method to. More...

_.Library.Status	OnConstructClone (_.Library.RegisteredObject object, _.Library.Boolean deep, _.Library.String cloned)
	This callback method is invoked by the <METHOD>ConstructClone</METHOD> method to. More...

_.Library.Status	OnNew ()
	This callback method is invoked by the <METHOD>New</METHOD> method to. More...

_.Library.Status	OnValidateObject ()
	This callback method is invoked by the <METHOD>ValidateObject</METHOD> method to. More...

Static Public Member Functions
_.iKnow.UserDictionary	OpenByName (_.Library.String pName)

Static Public Member Functions inherited from Persistent
_.Library.Status	DeleteData (_.Library.String id, _.Library.Integer concurrency)
	This method is normally generated by the storage class for persistent classes using. More...

_.Library.Status	KillExtentData (_.Library.Boolean killstreams)
	KillExtentData() - kills extent data in storage. More...

_.Library.Status	OnAfterBuildIndices (_.Library.String indexlist)
	This callback method is invoked by the <METHOD>BuildIndices</METHOD> method after all work is completed. More...

_.Library.Status	OnAfterDelete (_.Library.ObjectIdentity oid)
	This callback method is invoked by the <METHOD>Delete</METHOD> method to. More...

_.Library.Status	OnAfterPurgeIndices (_.Library.String indexlist)
	This callback method is invoked by the <METHOD>PurgeIndices</METHOD> method after all work is completed. More...

_.Library.Status	OnBeforeBuildIndices (_.Library.String indexlist)

_.Library.Status	OnBeforePurgeIndices (_.Library.String indexlist)

_.Library.Status	OnDelete (_.Library.ObjectIdentity oid)
	This callback method is invoked by the <METHOD>Delete</METHOD> method to. More...

Public Attributes
	Description
	@qualifier final More...

	Id
	@qualifier final More...

	Name
	@qualifier final More...

Private Member Functions
_.Library.RegisteredObject	ConstructClone (_.Library.Boolean deep, _.Library.String cloned, _.Library.String location)

Additional Inherited Members
Static Public Attributes inherited from Persistent
	XCOMPACTANCESTRY
	XCOMPACTANCESTRY can be set to a string to replace the value of the %CLASSNAME property (x__classname field) More...

	DATALOCATIONGLOBAL = None
	Global name containing master map data for this class. More...

	DEFAULTGLOBAL = None

	DSCONDITION = None
	DSCONDITION is the expression that will be evaluated before deciding whether certain actions must be taken. More...

	DSINTERVAL = None
	DSINTERVAL is the number of seconds between one DSTIME value and the next. More...

	DSTIME = None
	If the DSTIME parameter is set to AUTO then the most recent filing operation in the current DSTIME value. More...

	EXTENTQUERYSPEC = None
	The EXTENTQUERYSPEC parameter defines the properties to be retrieved in. More...

	EXTENTSIZE = None
	The EXTENTSIZE parameter is used to inform the SQL Query Optimizer More...

	GUIDENABLED = None
	If this parameter is set to 1 then a GUID will be assigned (to the GUID property) to each new object. More...

	IDENTIFIEDBY = None
	The IDENTIFIEDBY parameter can optionally be set to the name. More...

	MANAGEDEXTENT = None
	The MANAGEDEXTENT parameter can be set to 0 (zero) to cause the Extent Manager. More...

	READONLY = None
	READONLY = 1 means that objects can be created, opened but not saved or deleted. More...

	ROWLEVELSECURITY = None
	ROWLEVELSECURITY = 1 \| <property> means that row level security is active and the list More...

	SQLPREVENTFULLSCAN = None
	SQLPREVENTFULLSCAN = 1 means an attempt to prepare a query that will result in a full scan More...

	STORAGEDEFAULT = None
	STORAGEDEFAULT defines the default storage allocation to use for properties in this class. More...

	USEEXTENTSET = None

	VERSIONCLIENTNAME = None
	VERSIONCLIENTNAME can be set to a valid CLIENTNAME (see property CLIENTNAME) value. More...

	VERSIONPROPERTY = None
	VERSIONPROPERTY = <property> means that the <property> in memory will be compared to. More...

Static Public Attributes inherited from SwizzleObject
	DEFAULTCONCURRENCY = None
	DEFAULTCONCURRENCY is the default value for the concurrency formal argument. More...

	JOURNALSTREAM = None
	If OBJJOURNAL is true then the value of the JOURNALSTREAM parameter defines whether or not. More...

	OBJJOURNAL = None
	if OBJJOURNAL is TRUE then inserts, updates and deletes will be logged in ^OBJ.JournalT More...

Static Public Attributes inherited from RegisteredObject
	CAPTION = None
	Optional name used by the Form Wizard for a class when generating forms. More...

	JAVATYPE = None
	The Java type to be used when exported.

	PROPERTYVALIDATION = None
	This parameter controls the default validation behavior for the object. More...

Detailed Description

The InterSystems IRIS NLP iKnow technology is now deprecated. Please see the product documentation for more detail.

This class represents User Dictionaries, used to rewrite fragments of input data specific to a particular use case.

When creating a User Dictionary, you can pass initial values for the following properties to its <method>New</method> method:

<property>Name</property> (required)
<property>Description</property>

Check the respective property descriptions for more details.

Member Function Documentation

◆ ConstructClone()

_.Library.RegisteredObject ConstructClone	(	_.Library.Boolean	deep,
		_.Library.String	cloned,
		_.Library.String	location
	)

private

The InterSystems IRIS NLP iKnow technology is now deprecated. Please see the product documentation for more detail.

This class represents User Dictionaries, used to rewrite fragments of input data specific to a particular use case.

When creating a User Dictionary, you can pass initial values for the following properties to its <method>New</method> method:

<property>Name</property> (required)
<property>Description</property>

Check the respective property descriptions for more details.

◆ AddCertaintyTerm()

_.Library.Status AddCertaintyTerm	(	_.Library.String	pWord,
		_.Library.Integer	pLevel,
			pPosition
	)

Use pLevel to specify the level of certainty for this term (1-9).

A value of 1 implies a very uncertain statement, a value of 9 a very certain one.

◆ AddEntry()

_.Library.Status AddEntry	(	_.Library.String	pRewriteFrom,
		_.Library.String	pRewriteTo,
		_.Library.Integer	pPosition
	)

Adds a single entry to this User Dictionary at position. If position <= 0 (default=0),

it is added at the bottom of the list, otherwise at the requested position, shifting existing entries down if it was already taken.

These changes are saved automatically. There is no need to call <method>Save</method>

◆ GetEntries()

_.Library.Status GetEntries ( pResult )

Returns the contents of this User Dictionary in the form pResult(position) = $lb(rewriteFrom, rewriteTo [, metadata]).

◆ OpenByName()

_.iKnow.UserDictionary OpenByName ( _.Library.String pName )

static

Returns a User Dictionary object by name. First, this method checks if pName

is a name used by any saved User Dictionary object. If none found, it is used as a file path for the legacy file-based User Dictionaries. If there is no file at this path, "" is returned.

Note: file-based User Dictionaries are deprecated. Please use object-based ones by using <method>New</method>, <method>Save</method> and <method>AddEntry</method>.

◆ RemoveEntry()

_.Library.Status RemoveEntry ( _.Library.Integer pPosition )

Removes the User Dictionary entry registered at position. This method will

not impact the order or position of any remaining entries.

These changes are saved automatically. There is no need to call <method>Save</method>

Member Data Documentation

◆ Description

Description

@qualifier final

◆ Id

Id

@qualifier final

◆ Name

Name

@qualifier final

Public Member Functions

Static Public Member Functions

Public Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ ConstructClone()

◆ AddCertaintyTerm()

◆ AddEntry()

◆ GetEntries()

◆ OpenByName()

◆ RemoveEntry()

Member Data Documentation

◆ Description

◆ Id

◆ Name