IRISLIB database
CubeUtils Class Reference
Inheritance diagram for CubeUtils:
Collaboration diagram for CubeUtils:

Static Public Member Functions

_.Library.Status CreateEOCube (_.Library.String pCube, _.Library.String pIKnowMeasure, _.Library.Boolean pBuild)
 
_.Library.Status CreateMRCube (_.Library.String pCube, _.Library.String pIKnowMeasure, _.Library.Boolean pBuild)
 
_.Library.Integer GetDomainId (_.Library.String pCube, _.Library.String pMeasure, _.Library.Status pSC)
 Returns the domain ID for the supplied combination of cube name (pCube) and. More...
 
_.Library.Status GetIKnowMeasures (_.Library.String pCube, pList, _.Library.Boolean pIncludeRelatedToOne, _.Library.Boolean pIncludeRelatedToMany)
 Returns all iKnow Measures for cube pCube in the form. More...
 
_.Library.Status GetMeasureInfo (_.Library.String pCube, _.Library.String pMeasure, _.Library.String pSourceType, _.Library.Integer pDomainId, _.Library.Integer pDomainName, _.Library.String pDomainType, _.Library.String pParams, _.Library.String pDictionaries)
 
_.Library.String GetSummary (_.Library.String pCube, _.Library.String pMeasure, _.Library.String pSourceObjectId, _.Library.Integer pLength)
 
_.Library.Status LoadTermListAsDictionary (_.Library.String pCube, _.Library.String pMeasure, _.Library.String pTermList, _.Library.Integer pMatch, _.Library.Integer pClear)
 
_.Library.Status LoadTermListAsSkipList (_.Library.String pCube, _.Library.String pMeasure, _.Library.String pTermList)
 
_.Library.Status UpdateDictionary (_.Library.String pTermList, _.Library.String pCube, _.Library.String pMeasure, _.Library.Boolean pClearFirst)
 

Additional Inherited Members

- 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 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 offers a number of utility options for interacting with DeepSee-managed domains.

Member Function Documentation

◆ CreateEOCube()

_.Library.Status CreateEOCube ( _.Library.String  pCube,
_.Library.String  pIKnowMeasure,
_.Library.Boolean  pBuild 
)
static

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

This class offers a number of utility options for interacting with DeepSee-managed domains.

This method creates a new DeepSee Cube definition representing the entities

occurring in the textual contents of an iKnow measure pIKnowMeasure in cube pCube. The generated cube will have a set of meaningful dimensions for this entity occurrence level as well as a relationship to pCube, so all of its dimensions are also available for the new cube. The name of this cube will be "<var>pCube</var> &gt; <var>pIKnowMeasure</var> &gt; <i>Entity Occurrences</i>" and can be used or modified just like any other DeepSee cube after creation.

Setting pBuild to 1 will automatically build the cube.

NOTE: some of the functionality exposed by this cube can be achieved by using the iKnow plugin exposing numerical query results <class>DeepSee.PlugIn.iKnow</class> as a calculated measure, without the need to create any additional cubes.

◆ CreateMRCube()

_.Library.Status CreateMRCube ( _.Library.String  pCube,
_.Library.String  pIKnowMeasure,
_.Library.Boolean  pBuild 
)
static

This method creates a new DeepSee Cube definition representing the matching results

occurring in the textual contents of an iKnow measure pIKnowMeasure in cube pCube. The generated cube will have a set of meaningful dimensions for this dictionary match level as well as a relationship to pCube, so all of its dimensions are also available for the new cube. The name of this cube will be "<var>pCube</var> &gt; <var>pIKnowMeasure</var> &gt; <i>Matching Results</i>" and can be used or modified just like any other DeepSee cube after creation.

Setting pBuild to 1 will automatically build the cube.

NOTE: most of the functionality exposed by this cube can be achieved by using the iKnow plugin for Dictionaries <class>DeepSee.PlugIn.iKnowDictionary</class> as a calculated measure, without the need to create any additional cubes.

◆ GetDomainId()

_.Library.Integer GetDomainId ( _.Library.String  pCube,
_.Library.String  pMeasure,
_.Library.Status  pSC 
)
static

Returns the domain ID for the supplied combination of cube name (pCube) and.

iKnow measure name (pMeasure).

◆ GetIKnowMeasures()

_.Library.Status GetIKnowMeasures ( _.Library.String  pCube,
  pList,
_.Library.Boolean  pIncludeRelatedToOne,
_.Library.Boolean  pIncludeRelatedToMany 
)
static

Returns all iKnow Measures for cube pCube in the form.

  pList(n) = $lb(measureName, iKnowSourceType, cubeCaption)

◆ GetMeasureInfo()

_.Library.Status GetMeasureInfo ( _.Library.String  pCube,
_.Library.String  pMeasure,
_.Library.String  pSourceType,
_.Library.Integer  pDomainId,
_.Library.Integer  pDomainName,
_.Library.String  pDomainType,
_.Library.String  pParams,
_.Library.String  pDictionaries 
)
static

Fetches measure info from the cube definition:

  • pSourceType: the value of the iKnowSource attribute
  • pDomainId: the iKnow domain (ID) containing the data for this measure
  • pDomainName: the iKnow domain (name) containing the data for this measure
  • pDomainType: "iKnow" for an iKnow-managed domain, "DeepSee" for a DeepSee-managed one
  • pParams: the semicolon-delimited list of domain parameter name/value pairs to use apply to the domain instantiated for this measure
  • pDictionaries: the comma-delimited list of Term Lists to match against.

◆ GetSummary()

_.Library.String GetSummary ( _.Library.String  pCube,
_.Library.String  pMeasure,
_.Library.String  pSourceObjectId,
_.Library.Integer  pLength 
)
static

Shorthand method to retrieve a summary of the iKnow measure value for pMeasure

in cube pCube for the record identified by pSourceObjectId. Using pLength, the user can supply a desired summary length (in sentences).

This method is available as a SQL stored procedure and can be invoked in a Listing through using the $$$IKSUMMARY keyword.

◆ LoadTermListAsDictionary()

_.Library.Status LoadTermListAsDictionary ( _.Library.String  pCube,
_.Library.String  pMeasure,
_.Library.String  pTermList,
_.Library.Integer  pMatch,
_.Library.Integer  pClear 
)
static

Loads the elements of a TermList as Dictionary Terms into a given iKnow measures domain,

taking the key as the Term string and value as the items name. The Terms will all be added to a single dictionary named after this TermList.
The following fields will be interpreted along the way, if present:

  • "URI": the unique identifier for the Item level the value field refers to. If not present, a URI of the form :pTermList:value will be created.
  • "language": the two-letter language code to use for this term. Defaults to English ("en") if not present.

If pMatch is 1, the newly created dictionary will be matched against the contents of the domain. If set to 2, all existing dictionaries will be matched and if set to 0, no matching will occur as part of this method invocation.

If pClear is 1, any existing dictionary named pTermList will be deleted prior to loading this Term List. If set to 0, none will be dropped. The option to clear all dictionaries using the value 2 is discontinued as from 2013.2.

◆ LoadTermListAsSkipList()

_.Library.Status LoadTermListAsSkipList ( _.Library.String  pCube,
_.Library.String  pMeasure,
_.Library.String  pTermList 
)
static

Loads the elements of a Term List as a SkipList into a given iKnow measures domain,

using just the key as a string to be Skiplisted. The Terms will all be added to a single Skiplist named after this Term List.
If a SkipList with the given name already exists, its contents will be replaced by the contents of the supplied Term List. If no value is supplied for pTermList, its value will be derived from the value of the domain parameter $$$IKPDSSKIPLIST.

◆ UpdateDictionary()

_.Library.Status UpdateDictionary ( _.Library.String  pTermList,
_.Library.String  pCube,
_.Library.String  pMeasure,
_.Library.Boolean  pClearFirst 
)
static

This method will update matching results for the Term List identified by pTermList

to reflect the changes made to the Term List entries. If pCube is left blank, this method will be invoked for all cubes in this namespace. If pMeasure is left blank, it will be called for all iKnow measures in pCube.

Using pClearFirst, the user can specify whether or not the existing dictionary should first be dropped before reloading it from the Term List. Leave pClearFirst at 0 if you only appended to the Term List and use 1 if any existing terms were changed or removed.