%iKnow.UserDictionary
deprecated persistent class %iKnow.UserDictionary extends %Library.Persistent
SQL Table Name: %iKnow.UserDictionary
The InterSystems IRIS NLP iKnow technology is now deprecated. Please see the product documentationOpens in a new tab 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 %New() method:
- Name (required)
- Description
Property Inventory
Method Inventory
- %ConstructClone()
- %DeleteExtent()
- AddCertaintyTerm()
- AddConcept()
- AddEntry()
- AddNegationTerm()
- AddNegativeSentimentTerm()
- AddNonRelevant()
- AddNumber()
- AddPositiveSentimentTerm()
- AddRelation()
- AddSentenceEnd()
- AddSentenceNoEnd()
- AddTime()
- AddUnit()
- ClearEntries()
- GetEntries()
- OpenByName()
- RemoveEntry()
Properties
Methods
Note that even if deep=0 when you clone a parent object in a parent child relationship or a one object of a one to many relationship then it will construct clones of all the child/many objects. This is because a child/many object can only point at a single parent and so if we did not create a clone of these then you would have a relationship with zero items in it. If you really just want to clone the object without these child/many objects then pass deep=-1 to this method.
After the clone is constructed it will call %OnConstructClone(object,deep,.cloned) on the clone if it is defined so that you can perform any additional steps e.g. taking out a lock. This works just the same way as %OnNew() does.
The object is the oref of the original object that was cloned. The cloned array is just used internally when doing a deep clone to prevent recursive loops, do not pass anything in at all for this parameter on the initial call. If you write a %OnConstructClone and from here you wish to call %ConstructClone on another object pass in the cloned array, e.g. 'Do oref.%ConstructClone(1,.cloned)' so that it can prevent recursive loops.
The location is used internally to pass the new location for stream objects.
Internally, %DeleteExtent() iterates over the set of instances in the
collection and invokes the %Delete() method. Returns a %Status value indicating success or failure.
Refer to Object Concurrency Options for more details
on the optional concurrency argument.
The option pInitializeExtent argument allows the user to override the default behavior
of calling %KillExtent() when all instances are successfully deleted. %KillExtent()
is called by default when the extent is empty so that empty globals can be killed. If %KillExtent()
is not called then some empty globals can remain as well as the ID counter if it exists. The default value for pInitializeExtent
is 1. Unless the caller specifies a false value for pInitializeExtent the globals used by the extent will be killed. If the
process' GlobalKillDisabled flag is enabled and not the default of false the process' GlobalKillDisabled flag will be changed temporarily to false
to allow the operation to complete without a possible
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 %Save()
Returns the contents of this User Dictionary in the form pResult(position) = $lb(rewriteFrom, rewriteTo [, metadata]).
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 %New(), %Save() and AddEntry().
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 %Save()
Indexes
Inherited Members
Inherited Methods
- %AddToSaveSet()
- %AddToSyncSet()
- %BuildDeferredIndices()
- %BuildIndicesAsync()
- %BuildIndicesAsyncResponse()
- %CheckConstraints()
- %CheckConstraintsForExtent()
- %ClassIsLatestVersion()
- %ClassName()
- %ComposeOid()
- %Delete()
- %DeleteId()
- %DispatchClassMethod()
- %DispatchGetModified()
- %DispatchGetProperty()
- %DispatchMethod()
- %DispatchSetModified()
- %DispatchSetMultidimProperty()
- %DispatchSetProperty()
- %Exists()
- %ExistsId()
- %Extends()
- %GUID()
- %GUIDSet()
- %GetLock()
- %GetParameter()
- %GetSwizzleObject()
- %Id()
- %IsA()
- %IsModified()
- %IsNull()
- %KillExtent()
- %LockExtent()
- %LockId()
- %New()
- %NormalizeObject()
- %ObjectIsNull()
- %ObjectModified()
- %Oid()
- %OnBeforeAddToSync()
- %OnDeleteFinally()
- %OnDetermineClass()
- %OnOpenFinally()
- %OnSaveFinally()
- %Open()
- %OpenId()
- %OriginalNamespace()
- %PackageName()
- %PurgeIndices()
- %Reload()
- %RemoveFromSaveSet()
- %ResolveConcurrencyConflict()
- %RollBack()
- %Save()
- %SaveDirect()
- %SerializeObject()
- %SetModified()
- %SortBegin()
- %SortEnd()
- %SyncObjectIn()
- %SyncTransport()
- %UnlockExtent()
- %UnlockId()
- %ValidateIndices()
- %ValidateObject()
- %ValidateTable()
Storage
Storage Model: SQLStorage
Maps: 2
Map number 1 is named MainMap
thismap.Global: ^IRIS.IK.Sys.UserDictD
Map number 2 is named NameIndex
thismap.Global: ^IRIS.IK.Sys.UserDictI
^IRIS.IK.Sys.UserDictD({Id})
|
= |
|
^IRIS.IK.Sys.UserDictI($$$UPPER({Name}))
|
= |
|