%iKnow.Queries.CcQAPI
class %iKnow.Queries.CcQAPI extends %iKnow.Queries.AbstractQAPI
This is an automatically generated class, offering a functionally equivalent set of methods and queries as %iKnow.Queries.CcAPI, exposed as SqlProc methods.
See the classdocs for %iKnow.Queries.CcAPI for more information.
This class was generated by : %iKnow.Queries.CcAPI.cls
Method Inventory
- GetCountByEntities()
- GetCountByEntityIds()
- GetCountBySource()
- GetFrequency()
- GetId()
- GetInverse()
- GetSpread()
- GetValue()
Methods
This method returns the number of CC pairs based on a list of entities.
See also GetByEntities() for a description of the parameters.
This method returns the number of CC pairs based on a list of entity ids.
See also GetByEntities() for a description of the parameters.
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).
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.
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.
Returns the spread of the CC corresponding to the supplied ccUniId.
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.
Queries
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.
This method looks up CCs based on a list of Entity IDs.
See also GetByEntities() for a description of the parameters.
Inherited Members
Inherited 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()