CcAPI Class Reference

Inheritance diagram for CcAPI:

Collaboration diagram for CcAPI:

Static Public Member Functions
_.Library.Status	GetByEntities (result, _.Library.Integer domainid, _.Library.List entitylist, _.Library.Integer page, _.Library.Integer pagesize, _.iKnow.Filters.Filter filter, _.Library.Integer filtermode, _.Library.Integer positionstomatch, _.Library.Integer sorttype, _.Library.Boolean pActualFormOnly)
_.Library.Status	GetByEntityIds (result, _.Library.Integer domainid, _.Library.List entityidlist, _.Library.Integer page, _.Library.Integer pagesize, _.iKnow.Filters.Filter filter, _.Library.Integer filtermode, _.Library.Integer positionstomatch, _.Library.Integer sorttype, _.Library.Boolean pActualFormOnly)
_.Library.Integer	GetCountByEntities (_.Library.Integer domainid, _.Library.List entitylist, _.iKnow.Filters.Filter filter, _.Library.Integer positionstomatch, _.Library.Status sc, _.Library.Boolean pActualFormOnly)
_.Library.Integer	GetCountByEntityIds (_.Library.Integer domainid, _.Library.List entityidlist, _.iKnow.Filters.Filter filter, _.Library.Integer positionstomatch, _.Library.Status sc, _.Library.Boolean pActualFormOnly)
_.Library.Integer	GetCountBySource (_.Library.Integer domainid, _.Library.List sourceidlist, _.Library.Integer setop, _.Library.Status sc)
_.Library.Integer	GetFrequency (_.Library.Integer domainId, _.Library.Integer ccUniId, _.Library.Integer vSrcId, _.iKnow.Filters.Filter filter, _.Library.Status sc)
_.Library.Integer	GetId (_.Library.Integer pDomainId, _.Library.String pHead, _.Library.String pTail, _.Library.Integer vSrcId, _.Library.Status pSC)
_.Library.Integer	GetInverse (_.Library.Integer domainId, _.Library.Integer ccUniId, _.Library.Status sc)
	Returns the "inverse" of a CC pair, which means the CC composed of the same. More...
_.Library.Integer	GetSpread (_.Library.Integer domainId, _.Library.Integer ccUniId, _.iKnow.Filters.Filter filter, _.Library.Status sc)
_.Library.List	GetValue (_.Library.Integer pDomainId, _.Library.Integer pCcId, _.Library.Integer vSrcId, _.Library.Status pSC)

Detailed Description

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

This is the main Query API to get access to Concept-Concept pairs (CCs). CCs are an abstraction of CRCs, aggregating them across relationships to focus only on those concepts that are in a direct relationship with one another, without caring about the actual relationship linking the two.

Member Function Documentation

GetByEntities()

_.Library.Status GetByEntities (   result, _.Library.Integer  domainid, _.Library.List  entitylist, _.Library.Integer  page, _.Library.Integer  pagesize, _.iKnow.Filters.Filter  filter, _.Library.Integer  filtermode, _.Library.Integer  positionstomatch, _.Library.Integer  sorttype, _.Library.Boolean  pActualFormOnly  )

static

This method will return all CC pairs in which any (if setop = $$$UNION) or all (if setop = $$$INTERSECT)

of the entities supplied in the entitylist participate, within the boundaries of the supplied domain.

The scope of this query can be limited through supplying a <class>iKnow.Filters.Filter</class> object for the filter parameter to restrict the result to those CCs occurring in any source satisfying the filter criteria. When using a filter, the filtermode parameter will control whether or not the frequency and spread of returned records should be recalculated and whether results should be resorted along these recalculated numbers.

Specifying a value for positionstomatch will limit the result to those CCs in which the supplied entities are on the Head (with positionstomatch = $$$USEPOSH) or Tail (with positionstomatch = $$$USEPOST) side rather than either of the two (with positionstomatch = $$$USEPOSHT, default setting).

If stemming is enabled for this domain through $$$IKPSTEMMING, CCs containing any actual form of the entities in entityList will be returned. Use pActualFormOnly=1 to retrieve only those CCs containing the actual forms in entitylist. This argument is ignored if stemming is not enabled.

GetByEntityIds()

_.Library.Status GetByEntityIds (   result, _.Library.Integer  domainid, _.Library.List  entityidlist, _.Library.Integer  page, _.Library.Integer  pagesize, _.iKnow.Filters.Filter  filter, _.Library.Integer  filtermode, _.Library.Integer  positionstomatch, _.Library.Integer  sorttype, _.Library.Boolean  pActualFormOnly  )

static

This method looks up CCs based on a list of Entity IDs.

See also <method>GetByEntities</method> for a description of the parameters.

GetCountByEntities()

_.Library.Integer GetCountByEntities ( _.Library.Integer  domainid, _.Library.List  entitylist, _.iKnow.Filters.Filter  filter, _.Library.Integer  positionstomatch, _.Library.Status  sc, _.Library.Boolean  pActualFormOnly  )

static

This method returns the number of CC pairs based on a list of entities.

See also <method>GetByEntities</method> for a description of the parameters.

GetCountByEntityIds()

_.Library.Integer GetCountByEntityIds ( _.Library.Integer  domainid, _.Library.List  entityidlist, _.iKnow.Filters.Filter  filter, _.Library.Integer  positionstomatch, _.Library.Status  sc, _.Library.Boolean  pActualFormOnly  )

static

This method returns the number of CC pairs based on a list of entity ids.

See also <method>GetByEntities</method> for a description of the parameters.

GetCountBySource()

_.Library.Integer GetCountBySource ( _.Library.Integer  domainid, _.Library.List  sourceidlist, _.Library.Integer  setop, _.Library.Status  sc  )

static

Returns the total number of unique CCs appearing in either (if setop = $$$UNION) or

all (if setop = $$$INTERSECT) of the sources specified by ID in sourceidlist.

To get the unique CCs of a virtual source, only a single virtual source can be supplied using its negative ID value (otherwise, -1 is returned).

GetFrequency()

_.Library.Integer GetFrequency ( _.Library.Integer  domainId, _.Library.Integer  ccUniId, _.Library.Integer  vSrcId, _.iKnow.Filters.Filter  filter, _.Library.Status  sc  )

static

Returns the frequency of the CC corresponding to the supplied crcUniId.

When specifying a Virtual Source ID, the frequency within the virtual source will be returned.

GetId()

_.Library.Integer GetId ( _.Library.Integer  pDomainId, _.Library.String  pHead, _.Library.String  pTail, _.Library.Integer  vSrcId, _.Library.Status  pSC  )

static

Returns, if any, the CC ID for the combination of head and tail specified.

When specifying a Virtual Source ID, it will treat the heads and tails as virtual entities, in the context of that vSrcId.

GetInverse()

_.Library.Integer GetInverse ( _.Library.Integer  domainId, _.Library.Integer  ccUniId, _.Library.Status  sc  )

static

Returns the "inverse" of a CC pair, which means the CC composed of the same.

head and tail entity, but at inverted positions.

GetSpread()

_.Library.Integer GetSpread ( _.Library.Integer  domainId, _.Library.Integer  ccUniId, _.iKnow.Filters.Filter  filter, _.Library.Status  sc  )

static

Returns the spread of the CC corresponding to the supplied ccUniId.

GetValue()

_.Library.List GetValue ( _.Library.Integer  pDomainId, _.Library.Integer  pCcId, _.Library.Integer  vSrcId, _.Library.Status  pSC  )

static

Returns the entity values this CC is composed of.

When specifying a Virtual Source ID, it will treat the ccid as a virtual one, in the context of that vSrcId.