CrcAPI Class Reference

Inheritance diagram for CrcAPI:

Collaboration diagram for CrcAPI:

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.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.Boolean pActualFormOnly)
_.Library.Status	GetByFilter (result, _.Library.Integer domainid, _.iKnow.Filters.Filter filter, _.Library.Integer filtermode)
_.Library.Status	GetBySource (result, _.Library.Integer domainid, _.Library.List sourceidlist, _.Library.Integer page, _.Library.Integer pagesize)
_.Library.Integer	GetCountByDomain (_.Library.Integer domainid, _.iKnow.Filters.Filter filter, _.Library.Status sc, _.Library.Boolean includeZeroFrequency)
_.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 crcUniId, _.Library.Integer vSrcId, _.iKnow.Filters.Filter filter, _.Library.Status sc)
_.Library.Integer	GetId (_.Library.Integer domainid, _.Library.String head, _.Library.String relation, _.Library.String tail, _.Library.Integer vSrcId)
_.Library.Integer	GetOccurrenceCountBySource (_.Library.Integer domainid, _.Library.List sourceidlist, _.Library.Status sc)
_.Library.Status	GetOccurrencesBySource (result, _.Library.Integer domainid, _.Library.Integer srcid, _.Library.Integer page, _.Library.Integer pagesize)
_.Library.Integer	GetSpread (_.Library.Integer domainId, _.Library.Integer crcUniId, _.iKnow.Filters.Filter filter, _.Library.Status sc)
_.Library.Status	GetTop (result, _.Library.Integer domainid, _.Library.Integer page, _.Library.Integer pagesize, _.iKnow.Filters.Filter filter, _.Library.Integer filtermode, _.Library.Integer sorttype, _.Library.Integer vSrcId)
_.Library.List	GetValue (_.Library.Integer domainid, _.Library.Integer crcid, _.Library.Integer vSrcId)

Static Public Attributes
	GetByEntitiesRT = None

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 retrieve Concept-Relation-Concept triples (CRCs). In a CRC, the first concept is called the Head and the last the Tail, which are linked to one another through the Relation element.

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.Boolean  pActualFormOnly  )

static

This method will return all CRC triples in which any 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 CRCs 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 CRCs in which the supplied entities are in the Head (with positionstomatch = $$$USEPOSH), Relation (with positionstomatch = $$$USEPOSR) or Tail (with positionstomatch = $$$USEPOST) role of the CRC, or in any combination of these (with positionstomatch = $$$USEPOSHT, $$$USEPOSHR, $$$USEPOSRT, $$$USEPOSALL (the default)).

If stemming is enabled for this domain through $$$IKPSTEMMING, CRCs containing any actual form of the entities in entityList will be returned. Use pActualFormOnly=1 to retrieve only those CRCs 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.Boolean  pActualFormOnly  )

static

Returns the CRCs in this domain containing any or all of a list of entity IDs.

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

GetByFilter()

_.Library.Status GetByFilter (   result, _.Library.Integer  domainid, _.iKnow.Filters.Filter  filter, _.Library.Integer  filtermode  )

static

Returns all CRCs appearing in any source satisfying the supplied filter

objects criteria, with their frequencies and spread recalculated to comply with the filter depending on the value of filtermode, but the result is NOT re-sorted, regardless of the value for filtermode (use <method>GetTop</method> if you want sorted results).

GetBySource()

_.Library.Status GetBySource (   result, _.Library.Integer  domainid, _.Library.List  sourceidlist, _.Library.Integer  page, _.Library.Integer  pagesize  )

static

Returns the unique CRCs appearring in the specified sources.

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

GetCountByDomain()

_.Library.Integer GetCountByDomain ( _.Library.Integer  domainid, _.iKnow.Filters.Filter  filter, _.Library.Status  sc, _.Library.Boolean  includeZeroFrequency  )

static

Returns the total number of unique CRCs in a domain, optionally limited through supplying a

<class>iKnow.Filters.Filter</class> object as the filter parameter to restrict the result to those CRCs occurring in any source satisfying the filter criteria.

GetCountByEntities()

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

static

Returns the number of CRCs in this domain, 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

Returns the number of CRCs in this domain, 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 CRCs appearing in either (if setop = $$$UNION) or

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

To get the unique CRCs 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  crcUniId, _.Library.Integer  vSrcId, _.iKnow.Filters.Filter  filter, _.Library.Status  sc  )

static

Returns the frequency of the CRC 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  domainid, _.Library.String  head, _.Library.String  relation, _.Library.String  tail, _.Library.Integer  vSrcId  )

static

Returns, if any, the CRC ID for the combination of Head, Relation and Tail specified.

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

GetOccurrenceCountBySource()

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

static

Returns the total number of CRC occurrences in the specified sources.

Use negative source IDs to refer to virtual sources

GetOccurrencesBySource()

_.Library.Status GetOccurrencesBySource (   result, _.Library.Integer  domainid, _.Library.Integer  srcid, _.Library.Integer  page, _.Library.Integer  pagesize  )

static

Returns the CRC occurrences for a given source, in the order in which they appear.

GetSpread()

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

static

Returns the spread of the CRC corresponding to the supplied crcUniId.

GetTop()

_.Library.Status GetTop (   result, _.Library.Integer  domainid, _.Library.Integer  page, _.Library.Integer  pagesize, _.iKnow.Filters.Filter  filter, _.Library.Integer  filtermode, _.Library.Integer  sorttype, _.Library.Integer  vSrcId  )

static

Returns the most frequently occurring CRCs for this domain, sorted by descending frequency

(with sorttype $$$SORTBYFREQUENCY), spread (with sorttype $$$SORTBYSPREAD) or the domain default (with sorttype $$$SORTBYDOMAINDEFAULT).

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 CRCs 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.

If a Virtual Source ID is provided, only the entities in that virtual source will be considered, filters are ignored and the sort type will always be $$$SORTBYFREQUENCY.

GetValue()

_.Library.List GetValue ( _.Library.Integer  domainid, _.Library.Integer  crcid, _.Library.Integer  vSrcId  )

static

Returns the entity values this CRC is composed of.

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

Member Data Documentation

GetByEntitiesRT

GetByEntitiesRT = None

static

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

This is the main Query API to retrieve Concept-Relation-Concept triples (CRCs). In a CRC, the first concept is called the Head and the last the Tail, which are linked to one another through the Relation element.