deprecatedclass %iKnow.Matching.DictionaryQAPI
extends %iKnow.Queries.AbstractQAPI
This is an automatically generated class, offering a functionally equivalent set of methods and queries as %iKnow.Matching.DictionaryAPI, exposed as SqlProc methods.
See the classdocs for %iKnow.Matching.DictionaryAPI for more information.
• classmethod CreateDictionary(domainId As %Integer, name As %String(MAXLEN=32767), description As %String(MAXLEN=32767)="", defaultLanguage As %String(MAXLEN=32767)="en", defaultProfileId As %Integer = "", Output scText As %String = "")
as %Library.Integer
[ SQLProc = ]
Creates a Dictionary and returns its ID.
• classmethod CreateDictionaryFormat(domainId As %Integer, formatClass As %String(MAXLEN=32767), formatParams As %String(MAXLEN=32767)="", Output scText As %String = "")
as %Library.Integer
[ SQLProc = ]
Creates a Dictionary Format instance of the supplied formatClass and returns its ID.
• classmethod CreateDictionaryItem(domainId As %Integer, dictId As %Integer, name As %String(MAXLEN=32767), ByRef URI As %String(MAXLEN=32767), defaultLanguage As %String(MAXLEN=32767)="en", Output scText As %String = "")
as %Library.Integer
[ SQLProc = ]
Creates a Dictionary Item and returns its ID.
• classmethod CreateDictionaryItemAndTerm(domainId As %Integer, dictId As %Integer, name As %String(MAXLEN=32767), ByRef URI As %String(MAXLEN=32767), language As %String(MAXLEN=32767)="en", Output scText As %String = "")
as %Library.Integer
[ SQLProc = ]
Shorthand method for creating a Dictionary Item and Term using the Item's name. Returns the Items ID.
• classmethod CreateDictionaryTerm(domainId As %Integer, dictItemId As %Integer, string As %String(MAXLEN=32767), language As %String(MAXLEN=32767)="en", Output scText As %String = "", isProcessed As %Boolean = 0)
as %Library.Integer
[ SQLProc = ]
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.
• classmethod CreateDictionaryTermFormat(domainId As %Integer, dictItemId As %Integer, formatClass As %String(MAXLEN=32767), formatParams As %String(MAXLEN=32767)="", Output scText As %String = "")
as %Library.Integer
[ SQLProc = ]
Creates a Dictionary Term composed of a single Dictionary Format and returns the Terms ID.
• classmethod CreateRegularExpression(pDomainId As %Integer, pDictItemId As %Integer, pRegularExpression As %String(MAXLEN=32767), pReplace As %String(MAXLEN=32767)="", Output scText As %String = "")
as %Library.Integer
[ SQLProc = ]
Shorthand method to create a Dictionary Term composed of a single Dictionary Format of type
%iKnow.Matching.Formats.RegularExpression, matching pRegularExpression and
optionally producing output by replacing the matched parts of an entity with pReplace.
• classmethod DropAllDictionaryData(domainId As %Integer)
as %Boolean
[ SQLProc = ]
Drops all dictionary data, including matching results.
This method will fail if there are managed dictionaries in this domain.
• classmethod DropDictionary(domainId As %Integer, dictId As %Integer)
as %Boolean
[ SQLProc = ]
Deletes a Dictionary and all related items, terms, elements and matches.
• classmethod DropDictionaryItem(domainId As %Integer, dictItemId As %Integer)
as %Boolean
[ SQLProc = ]
Deletes a Dictionary Item with all related terms, elements and matches.
• classmethod DropDictionaryTerm(domainId As %Integer, dictTermId As %String(MAXLEN=32767))
as %Boolean
[ SQLProc = ]
Drops a single Dictionary Term and its matching results
• classmethod GetDictionaryCount(pDomainId As %Integer, Output scText As %String = "")
as %Library.Integer
[ SQLProc = ]
• classmethod GetDictionaryId(domainId As %Integer, name As %String(MAXLEN=32767), Output scText As %String = "")
as %Library.Integer
[ SQLProc = ]
Looks up the Dictionary ID corresponding to the supplied Dictionary name.
• classmethod GetDictionaryItemIdByURI(domainId As %Integer, URI As %String(MAXLEN=32767), Output scText As %String = "")
as %Library.Integer
[ SQLProc = ]
Looks up the Dictionary Item ID corresponding to the supplied Dictionary Item URI.
• classmethod GetItemCount(pDomainId As %Integer, pDictIds As %String(MAXLEN=32767)="", Output scText As %String = "")
as %Library.Integer
[ SQLProc = ]
• classmethod GetTermCount(pDomainId As %Integer, pDictIds As %String(MAXLEN=32767)="", Output scText As %String = "")
as %Library.Integer
[ SQLProc = ]
• classmethod GetTermCountByItem(pDomainId As %Integer, pDictItemIds As %String(MAXLEN=32767)="", Output scText As %String = "")
as %Library.Integer
[ SQLProc = ]
• classmethod HasDictionaries(pDomainId As %Integer)
as %Library.Boolean
[ SQLProc = ]
Returns whether or not there are any dictionaries in the domain
• query GetDictionaries(domainId As %Integer, page As %Integer = 1, pageSize As %Integer = 10, pIncludeCrossDomain As %Boolean = 0)
Selects
dictId As %Integer, name As %String(MAXLEN=32767), description As %String(MAXLEN=32767), defaultLanguage As %String(MAXLEN=32767)
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.
• query GetDictionaryItems(domainId As %Integer, dictId As %Integer, page As %Integer = 1, pageSize As %Integer = 10)
Selects
dictItemId As %Integer, name As %String(MAXLEN=32767), URI As %String(MAXLEN=32767), defaultLanguage As %String(MAXLEN=32767)
Returns all Dictionary Items for the given Dictionary ID.
• query GetDictionaryItemsAndTerms(domainId As %Integer, dictId As %Integer, page As %Integer = 1, pageSize As %Integer = 10)
Selects
dictItemId As %Integer, name As %String(MAXLEN=32767), URI As %String(MAXLEN=32767), dictTermId As %Integer, string As %String(MAXLEN=32767), language As %String(MAXLEN=32767), isProcessed As %Boolean
Returns all Dictionary Items and their Terms for the given Dictionary ID.
• query GetDictionaryTermsByItem(domainId As %Integer, dictItemId As %Integer, page As %Integer = 1, pageSize As %Integer = 10)
Selects
dictTermId As %Integer, string As %String(MAXLEN=32767), language As %String(MAXLEN=32767), isProcessed As %Boolean
Returns all the Dictionary Terms for the given Dictionary Item ID.
• query GetItemsByName(pDomainId As %Integer, pString As %String(MAXLEN=32767), pPage As %Integer = 1, pPageSize As %Integer = 10, pFilter As %String(MAXLEN=32767)="", pDictIds As %String(MAXLEN=32767)="", pMode As %Integer = $$$USEPARTS, pCheck As %String(VALUELIST="NAME,URI")="NAME", pLang As %String(MAXLEN=32767)="en")
Selects
dictId As %Integer, dictName As %String(MAXLEN=32767), itemId As %Integer, itemName As %String(MAXLEN=32767), URI As %String(MAXLEN=32767), language As %String(MAXLEN=32767)
Note: pFilter is ignored when looking at cross-domain dictionaries
• query GetTermsByName(pDomainId As %Integer, pString As %String(MAXLEN=32767), pPage As %Integer = 1, pPageSize As %Integer = 10, pFilter As %String(MAXLEN=32767)="", pDictIds As %String(MAXLEN=32767)="", pMode As %Integer = $$$USEPARTS, pLang As %String(MAXLEN=32767)="en")
Selects
dictId As %Integer, dictName As %String(MAXLEN=32767), itemId As %Integer, itemName As %String(MAXLEN=32767), URI As %String(MAXLEN=32767), termId As %Integer, term As %String(MAXLEN=32767), language As %String(MAXLEN=32767)
Note: pFilter is ignored when looking at cross-domain dictionaries
