Class %iKnow.Queries.CrcAPI

class %iKnow.Queries.CrcAPI extends %iKnow.Queries.AbstractAPI

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

Inventory

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
7		22

Summary

Methods
%%OIDGet	%AddToSaveSet	%ClassIsLatestVersion	%ClassName
%ConstructClone	%DispatchClassMethod	%DispatchGetModified	%DispatchGetProperty
%DispatchMethod	%DispatchSetModified	%DispatchSetMultidimProperty	%DispatchSetProperty
%Extends	%GetParameter	%IsA	%IsModified
%New	%NormalizeObject	%ObjectModified	%OriginalNamespace
%PackageName	%RemoveFromSaveSet	%SerializeObject	%SetModified
%ValidateObject	GetByEntities	GetByEntityIds	GetByFilter
GetBySource	GetCountByDomain	GetCountByEntities	GetCountByEntityIds
GetCountBySource	GetFrequency	GetId	GetOccurrenceCountBySource
GetOccurrencesBySource	GetSpread	GetTop	GetValue

Parameters

• parameter GetByEntitiesRT = "crcId:%Integer,master:%String,relation:%String,slave:%String,frequency:%Integer,spread:%Integer";

• parameter GetByEntityIdsRT = "crcId:%Integer,master:%String,relation:%String,slave:%String,frequency:%Integer,spread:%Integer";

• parameter GetByFilterRT = "crcId:%Integer,master:%String,relation:%String,slave:%String,frequency:%Integer,spread:%Integer";

• parameter GetBySourceRT = "crcId:%Integer,master:%String,relation:%String,slave:%String,frequency:%Integer,spread:%Integer";

• parameter GetOccurrencesBySourceRT = "crcOccId:%Integer,crcUniId:%Integer,master:%String,relation:%String,slave:%String,sentenceId:%Integer,posInSent:%Integer";

• parameter GetTopRT = "crcId:%Integer,master:%String,relation:%String,slave:%String,freq:%Integer,spread:%Integer";

• parameter GetValueRT = "master:%String,relation:%String,slave:%String";

Methods

• classmethod GetByEntities(ByRef result, domainid As %Integer, entitylist As %List, page As %Integer = 1, pagesize As %Integer = 10, filter As %iKnow.Filters.Filter = "", filtermode As %Integer = $$$FILTERONLY, positionstomatch As %Integer = $$$USEPOSALL) as %Status

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 %iKnow.Filters.Filter 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 Master (with positionstomatch = $$$USEPOSM), Relation (with positionstomatch = $$$USEPOSR) or Slave (with positionstomatch = $$$USEPOSS) role of the CRC, or in any combination of these (with positionstomatch = $$$USEPOSMS, $$$USEPOSMR, $$$USEPOSRS, $$$USEPOSALL (the default)).

• classmethod GetByEntityIds(ByRef result, domainid As %Integer, entityidlist As %List, page As %Integer = 1, pagesize As %Integer = 10, filter As %iKnow.Filters.Filter = "", filtermode As %Integer = $$$FILTERONLY, positionstomatch As %Integer = $$$USEPOSALL) as %Status

Returns a list of CRCs in this domain, based on a list of entity IDs.

See also GetByEntities for a description of the parameters.

• classmethod GetByFilter(ByRef result, domainid As %Integer, filter As %iKnow.Filters.Filter = "", filtermode As %Integer = $$$FILTERONLY) as %Status

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 GetTop if you want sorted results).

• classmethod GetBySource(ByRef result, domainid As %Integer, sourceidlist As %List, page As %Integer = 1, pagesize As %Integer = 10) as %Status

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

• classmethod GetCountByDomain(domainid As %Integer, filter As %iKnow.Filters.Filter = "", Output sc As %Status = $$$OK, includeZeroFrequency As %Boolean = 0) as %Integer

Returns the total number of unique CRCs in a domain, optionally limited through supplying a %iKnow.Filters.Filter object as the filter parameter to restrict the result to those CRCs occurring in any source satisfying the filter criteria.

• classmethod GetCountByEntities(domainid As %Integer, entitylist As %List, filter As %iKnow.Filters.Filter = "", positionstomatch As %Integer = $$$USEPOSALL, Output sc As %Status = $$$OK) as %Integer

Returns the number of CRCs in this domain, based on a list of entities.

See also GetByEntities for a description of the parameters.

• classmethod GetCountByEntityIds(domainid As %Integer, entityidlist As %List, filter As %iKnow.Filters.Filter = "", positionstomatch As %Integer = $$$USEPOSALL, Output sc As %Status = $$$OK) as %Integer

Returns the number of CRCs in this domain, based on a list of entity IDs.

See also GetByEntities for a description of the parameters.

• classmethod GetCountBySource(domainid As %Integer, sourceidlist As %List, setop As %Integer = $$$UNION, Output sc As %Status = $$$OK) as %Integer

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

• classmethod GetFrequency(domainId As %Integer, crcUniId As %Integer, vSrcId As %Integer = 0) as %Integer

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.

• classmethod GetId(domainid As %Integer, master As %String, relation As %String, slave As %String, vSrcId As %Integer = 0) as %Integer

Returns, if any, the CRC ID for the combination of master, relation and slave specified.

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

• classmethod GetOccurrenceCountBySource(domainid As %Integer, sourceidlist As %List, Output sc As %Status = $$$OK) as %Integer

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

Use negative source IDs to refer to virtual sources

• classmethod GetOccurrencesBySource(ByRef result, domainid As %Integer, srcid As %Integer, page As %Integer = 1, pagesize As %Integer = 10) as %Status

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

• classmethod GetSpread(domainId As %Integer, crcUniId As %Integer) as %Integer

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

• classmethod GetTop(ByRef result, domainid As %Integer, page As %Integer = 1, pagesize As %Integer = 10, filter As %iKnow.Filters.Filter = "", filtermode As %Integer = $$$FILTERONLY, sorttype As %Integer = $$$SORTBYDOMAINDEFAULT, vSrcId As %Integer = 0) as %Status

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 %iKnow.Filters.Filter 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.

• classmethod GetValue(domainid As %Integer, crcid As %Integer, vSrcId As %Integer = 0) as %List

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.


[BASEXML] > [%iKnow] > [Queries] > [CrcAPI]		Private Storage