Learning
Documentation
Community
Open Exchange
Global Masters
Home / Class Reference / ENSLIB namespace / %iKnow.Queries.CcAPI
Private  Storage   

%iKnow.Queries.CcAPI


class %iKnow.Queries.CcAPI extends
%iKnow.Queries.AbstractAPI

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.

Inventory


Parameters Properties Methods Queries Indices ForeignKeys Triggers
2 16


Summary


Methods
%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 GetCountByEntities GetCountByEntityIds
GetCountBySource GetFrequency GetId GetInverse
GetSpread GetValue


Parameters


• parameter GetByEntitiesRT = "mEntUniId:%Integer,mEntity:%String,sEntUniId:%Integer,sEntity:%String,frequency:%Integer,spread:%Integer,ccUniId:%Integer";

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 = $$$USEPOSMS, sorttype As %Integer = $$$SORTBYDOMAINDEFAULT, pActualFormOnly As %Boolean = 0) as %Status

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 %iKnow.Filters.Filter 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 Master (with positionstomatch = $$$USEPOSM) or Slave (with positionstomatch = $$$USEPOSS) side rather than either of the two (with positionstomatch = $$$USEPOSMS, 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.

• 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 = $$$USEPOSMS, sorttype As %Integer = $$$SORTBYDOMAINDEFAULT, pActualFormOnly As %Boolean = 0) as %Status

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

See also GetByEntities for a description of the parameters.

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

This method returns the number of CC pairs 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 = $$$USEPOSMS, Output sc As %Status = $$$OK, pActualFormOnly As %Boolean = 0) as %Integer

This method returns the number of CC pairs 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 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).

• classmethod GetFrequency(domainId As %Integer, ccUniId As %Integer, vSrcId As %Integer = 0, filter As %iKnow.Filters.Filter = "", Output sc As %Status = $$$OK) as %Integer

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.

• classmethod GetId(pDomainId As %Integer, pMaster As %String, pSlave As %String, vSrcId As %Integer = 0, Output pSC As %Status = $$$OK) as %Integer

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

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

• classmethod GetInverse(domainId As %Integer, ccUniId As %Integer, Output sc As %Status = $$$OK) as %Integer
Returns the "inverse" of a CC pair, which means the CC composed of the same master and slave entity, but at inverted positions.
• classmethod GetSpread(domainId As %Integer, ccUniId As %Integer, filter As %iKnow.Filters.Filter = "", Output sc As %Status = $$$OK) as %Integer

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

• classmethod GetValue(pDomainId As %Integer, pCcId As %Integer, vSrcId As %Integer = 0, Output pSC As %Status = $$$OK) as %List

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.