DictionaryAPI Class Reference

Inheritance diagram for DictionaryAPI:

Collaboration diagram for DictionaryAPI:

Static Public Member Functions
_.Library.Integer	CreateDictionary (_.Library.Integer domainId, _.Library.String name, _.Library.String description, _.Library.String defaultLanguage, _.Library.Integer defaultProfileId, _.Library.Status sc)
	Creates a Dictionary and returns its ID.
_.Library.Integer	CreateDictionaryFormat (_.Library.Integer domainId, _.Library.String formatClass, _.Library.List formatParams, _.Library.Status sc)
	Creates a Dictionary Format instance of the supplied formatClass and returns its ID.
_.Library.Integer	CreateDictionaryItem (_.Library.Integer domainId, _.Library.Integer dictId, _.Library.String name, _.Library.String URI, _.Library.String defaultLanguage, _.Library.Status sc)
	Creates a Dictionary Item and returns its ID.
_.Library.Integer	CreateDictionaryItemAndTerm (_.Library.Integer domainId, _.Library.Integer dictId, _.Library.String name, _.Library.String URI, _.Library.String language, _.Library.Status sc)
	Shorthand method for creating a Dictionary Item and Term using the Item's name. More...
_.Library.Integer	CreateDictionaryTerm (_.Library.Integer domainId, _.Library.Integer dictItemId, _.Library.String string, _.Library.String language, _.Library.Status sc, _.Library.Boolean isProcessed)
_.Library.Integer	CreateDictionaryTermFormat (_.Library.Integer domainId, _.Library.Integer dictItemId, _.Library.String formatClass, _.Library.List formatParams, _.Library.Status sc)
	Creates a Dictionary Term composed of a single Dictionary Format and returns the Terms ID.
_.Library.Integer	CreateRegularExpression (_.Library.Integer pDomainId, _.Library.Integer pDictItemId, _.Library.String pRegularExpression, _.Library.String pReplace, _.Library.Status pSC)
	Shorthand method to create a Dictionary Term composed of a single Dictionary Format of type. More...
_.Library.Status	DropAllDictionaryData (_.Library.Integer domainId)
	Drops all dictionary data, including matching results. More...
_.Library.Status	DropDictionary (_.Library.Integer domainId, _.Library.Integer dictId)
	Deletes a Dictionary and all related items, terms, elements and matches.
_.Library.Status	DropDictionaryItem (_.Library.Integer domainId, _.Library.Integer dictItemId)
	Deletes a Dictionary Item with all related terms, elements and matches.
_.Library.Status	DropDictionaryTerm (_.Library.Integer domainId, _.Library.String dictTermId)
	Drops a single Dictionary Term and its matching results.
_.Library.Status	GetDictionaries (result, _.Library.Integer domainId, _.Library.Integer page, _.Library.Integer pageSize, _.Library.Boolean pIncludeCrossDomain)
	Returns all Dictionaries in this domain. More...
_.Library.Integer	GetDictionaryId (_.Library.Integer domainId, _.Library.String name, _.Library.Status sc)
	Looks up the Dictionary ID corresponding to the supplied Dictionary name.
_.Library.Integer	GetDictionaryItemIdByURI (_.Library.Integer domainId, _.Library.String URI, _.Library.Status sc)
	Looks up the Dictionary Item ID corresponding to the supplied Dictionary Item URI.
_.Library.Status	GetDictionaryItems (result, _.Library.Integer domainId, _.Library.Integer dictId, _.Library.Integer page, _.Library.Integer pageSize)
	Returns all Dictionary Items for the given Dictionary ID.
_.Library.Status	GetDictionaryItemsAndTerms (result, _.Library.Integer domainId, _.Library.Integer dictId, _.Library.Integer page, _.Library.Integer pageSize)
	Returns all Dictionary Items and their Terms for the given Dictionary ID.
_.Library.Status	GetDictionaryTermsByItem (result, _.Library.Integer domainId, _.Library.Integer dictItemId, _.Library.Integer page, _.Library.Integer pageSize)
	Returns all the Dictionary Terms for the given Dictionary Item ID.
_.Library.Status	GetFormatDetails (_.Library.Integer pDomainId, _.Library.Integer pDictionaryFormatId, _.Library.String pFormatClass, _.Library.List pFormatParams)
	Retrieves the Dictionary format class and parameters for a given pDictionaryFormatId
_.Library.Status	GetItemsByName (pResult, _.Library.Integer pDomainId, _.Library.String pString, _.Library.Integer pPage, _.Library.Integer pPageSize, _.iKnow.Filters.Filter pFilter, _.Library.List pDictIds, _.Library.Integer pMode, _.Library.String pCheck, _.Library.String pLang)
	Note: pFilter is ignored when looking at cross-domain dictionaries.
_.Library.Status	GetTermsByName (pResult, _.Library.Integer pDomainId, _.Library.String pString, _.Library.Integer pPage, _.Library.Integer pPageSize, _.iKnow.Filters.Filter pFilter, _.Library.List pDictIds, _.Library.Integer pMode, _.Library.String pLang)
	Note: pFilter is ignored when looking at cross-domain dictionaries.
_.Library.Boolean	HasDictionaries (_.Library.Integer pDomainId)
	Returns whether or not there are any dictionaries in the domain.

Detailed Description

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

Main entry point for managing Dictionary contents to be used by the Matching APIs

Member Function Documentation

CreateDictionaryItemAndTerm()

_.Library.Integer CreateDictionaryItemAndTerm ( _.Library.Integer  domainId, _.Library.Integer  dictId, _.Library.String  name, _.Library.String  URI, _.Library.String  language, _.Library.Status  sc  )

static

Shorthand method for creating a Dictionary Item and Term using the Item's name.

Returns the Items ID.

CreateDictionaryTerm()

_.Library.Integer CreateDictionaryTerm ( _.Library.Integer  domainId, _.Library.Integer  dictItemId, _.Library.String  string, _.Library.String  language, _.Library.Status  sc, _.Library.Boolean  isProcessed  )

static

Creates a Dictionary Term and returns its ID.

If isProcessed is 1 (default 0), the term will be marked as processed upon creation and no Dictionary Elements will be created. This parameter is for internal use only and deprecated in 2013.1.

CreateRegularExpression()

_.Library.Integer CreateRegularExpression ( _.Library.Integer  pDomainId, _.Library.Integer  pDictItemId, _.Library.String  pRegularExpression, _.Library.String  pReplace, _.Library.Status  pSC  )

static

Shorthand method to create a Dictionary Term composed of a single Dictionary Format of type.

<class>iKnow.Matching.Formats.RegularExpression</class>, matching pRegularExpression and optionally producing output by replacing the matched parts of an entity with pReplace.

DropAllDictionaryData()

_.Library.Status DropAllDictionaryData ( _.Library.Integer  domainId )

static

Drops all dictionary data, including matching results.

This method will fail if there are managed dictionaries in this domain.

GetDictionaries()

_.Library.Status GetDictionaries (   result, _.Library.Integer  domainId, _.Library.Integer  page, _.Library.Integer  pageSize, _.Library.Boolean  pIncludeCrossDomain  )

static

Returns all Dictionaries in this domain.

If pIncludeCrossDomain = 1, any cross-domain dictionaries registered in "domain 0" are also included in the result, using a negative value for their ID.