Loading...
 

CX_OBJECT_DICTIONARY

CX_OBJECT_DICTIONARY CX_INDEX.png

Class hierarchy
Description:

The class CX_OBJECT_DICTIONARY largely corresponds to the class CX_OBJECT_DICTIONARY_ML. The difference lies in the renunciation of multilingualism. CX_OBJECT_DICTIONARY objects are suitable for registering objects under such terms that do not depend on the language just selected (key numbers, names of companies, ...).

An object can have any number of identifiers, and any number of objects can be entered in the Dictionary per identifier. Conceptually, a dictionary corresponds to a multimap.

The multi-language methods EnterML and RemoveML have been introduced for the purpose of a uniform interface. The keys are nevertheless only inserted in one language (current language of the transferred ML_STRINGS).

CX_OBJECT_DICTIONARY belongs to the family of object dictionary classes.

Code example: 
Var(dict)
CreateTransObject(CX_OBJECT_DICTIONARY) -> dict

"cx" user dict Call(Enter)

"cx" user dict Call(Exists) // -> TRUE
"c*" 0 dict Call(Query)     // -> Collection (user)
"cx" user dict Call(Remove)

List of methods (MDI)
Function MA* Parameters Return Brief description
Cardinalities VECTOR&lmt;INTEGER>Number of elements in the dictionary
Clear Deletes all entries
CreateBKTree
230545		 Creates BK tree for subsequent DLDistance searches.
DestroyBKTree
230545		 Removes BK-Tree
Enter STRING, OBJECT insert new entry for the object, if exactly this entry (term, object) already exists -> error message
EnterAlways STRING, OBJECT for test purposes only !
like Enter, but without test, double entries possible
EnterIfNotThere STRING, OBJECT like Enter, if exactly this entry (term, object) already exists -> no operation
EnterML MULTIPLE_STRING, OBJECT like Enter
EnterMLIfNotThere MULTIPLE_STRING, OBJECT like EnterIfNotThere
Exists STRING, OBJECT INTEGER Tests whether the object is entered in the dictionary under the term
FixKeyOwnership
220621		 STRING Reorg for dictionaries created before Dll version 220415.
GetAllKeys COLLECTION Return: all dictionary entries as CX_OBJECT_KEYWORDs
GetNames OBJECT COLLECTION Return: all entries for an object as CX_OBJECT_KEYWORDs
GetObjectsWithDLDistance
222024		 STRING, STRING, INTEGER, INTEGER, STRINGCOLLECTIONall objects that have a key that is similar to the search term
GetObjectsWithDLDistanceWithBKTree
230545		 STRING, STRING, INTEGER, INTEGER, STRING, INTEGERCOLLECTIONlike GetObjectsWithDLDistance but logarithmic search in a BK-tree instead of linear search
GetRelatedObjects OBJECT COLLECTION Return: all entries for an object as CX_OBJECT_KEYWORDs
NewKey OBJECT OBJECT new entry = create new object CX_KEYWORD
Query STRING, INTEGER COLLECTION find all objects for a search term
QueryByType STRING, STRING, INTEGER, INTEGER COLLECTION like query, filter result by class
QueryByDLDistance
222024		 INTEGER, STRINGCOLLECTIONall objects that have a key that is similar to the search term
QueryByDLDistanceWithBKTree
230545		 INTEGER, STRING, INTEGERCOLLECTIONlike QueryByDLDistance but logarithmic search in a BK-tree instead of linear search
RebuildDictionary Rebuild dictionary completely
RegExQuery STRING, INTEGER COLLECTION find all objects for the search term, search argument is regular expression
RegExQueryByType STRING, STRING, INTEGER, INTEGER COLLECTION like ReqExQuery, filter result by class
Remove STRING, OBJECT Delete entry for the object
RemoveDuplicateKeys delete all duplicated entries
RemoveLonelyKeys delete all entries without inverse relationship
RemoveML
220415		 MULTIPLE_STRING, OBJECT Delete entry for the object
RemoveNames OBJECT delete all entries for the object
RemoveNamesOfDeletedObjects delete all entries that refer to a logically deleted object
SanityCheck INTEGER Determine whether internal structures are free from logical errors
Clone INTEGER OBJECT Creates a new dictionary with the same entries for the same objects
string INTEGER CX_STRING Returns the string representation of the object

* MA = Member Access function,
grey background = inherited function

Data directory (DDI)
Data field Type Reference class I* Brief description
uniqueID STRING * Name

* I = Indexable data field,
grey background = inherited data field

Use in AppsWH
Module Brief description