DominanceQAPI Class Reference

Inheritance diagram for DominanceQAPI:

Collaboration diagram for DominanceQAPI:

Static Public Member Functions
_.Library.Integer	GetCountBySource (_.Library.Integer domainid, _.Library.Integer srcid, _.Library.Integer type, _.Library.Integer cutoff, _.Library.String scText)
_.Library.Numeric	GetDomainValue (_.Library.Integer domainid, _.Library.Integer id, _.Library.Integer type, _.Library.String scText)
_.Library.Integer	GetProfileCountByDomain (_.Library.Integer domainid, _.Library.Integer type, _.Library.String scText)
_.Library.Integer	GetProfileCountBySource (_.Library.Integer domainid, _.Library.Integer srcid, _.Library.Integer type, _.Library.Integer cutoff, _.Library.String scText)
_.Library.Numeric	GetSourceValue (_.Library.Integer domainid, _.Library.Integer srcid, _.Library.Integer id, _.Library.Integer type, _.Library.String scText)

Detailed Description

This is an automatically generated class, offering a functionally equivalent set of methods and queries as <class>iKnow.Semantics.DominanceAPI</class>, exposed as SqlProc methods.

See the classdocs for <class>iKnow.Semantics.DominanceAPI</class> for more information.

Member Function Documentation

GetCountBySource()

_.Library.Integer GetCountBySource ( _.Library.Integer  domainid, _.Library.Integer  srcid, _.Library.Integer  type, _.Library.Integer  cutoff, _.Library.String  scText  )

static

This is an automatically generated class, offering a functionally equivalent set of methods and queries as <class>iKnow.Semantics.DominanceAPI</class>, exposed as SqlProc methods.

See the classdocs for <class>iKnow.Semantics.DominanceAPI</class> for more information.

Returns the number of dominant terms found in a specific source. The type of elements counted can be set by the type parameter.

Available types are $$$SDCONCEPT, $$$SDRELATION, $$$SDENTITY, $$$SDCRC, $$$SDPATH and $$$SDAGGREGATE.

The number of elements counted can be limited to those with a dominance value above average by setting the cutoff parameter to $$$SDABOVEAVERAGE.

GetDomainValue()

_.Library.Numeric GetDomainValue ( _.Library.Integer  domainid, _.Library.Integer  id, _.Library.Integer  type, _.Library.String  scText  )

static

Returns the dominance value of an element within a specified domain. The id parameter takes either an entityId, crcId or pathId and the

type parameter defines of what type the id parameter is. Thus valid types are $$$SDCONCEPT, $$$SDCRC and $$$SDPATH.

GetProfileCountByDomain()

_.Library.Integer GetProfileCountByDomain ( _.Library.Integer  domainid, _.Library.Integer  type, _.Library.String  scText  )

static

Returns the number of dominant terms in the profile of a complete domain. The type of elements counted can be set by the type parameter.

Available types are $$$SDCONCEPT, $$$SDRELATION, $$$SDENTITY, $$$SDCRC and $$$SDAGGREGATE.

GetProfileCountBySource()

_.Library.Integer GetProfileCountBySource ( _.Library.Integer  domainid, _.Library.Integer  srcid, _.Library.Integer  type, _.Library.Integer  cutoff, _.Library.String  scText  )

static

Returns the number of dominant terms in the profile of a specific source. The type of elements counted can be set by the type parameter.

Available types are $$$SDCONCEPT, $$$SDRELATION, $$$SDENTITY, $$$SDCRC, $$$SDPATH and $$$SDAGGREGATE.

The number of elements counted can be limited to those with a dominance value above average by setting the cutoff parameter to $$$SDABOVEAVERAGE.

GetSourceValue()

_.Library.Numeric GetSourceValue ( _.Library.Integer  domainid, _.Library.Integer  srcid, _.Library.Integer  id, _.Library.Integer  type, _.Library.String  scText  )

static

Returns the dominance value of an element within a specified source. The id parameter takes either an entityId, crcId or pathId and the

type parameter defines of what type the id parameter is. Thus valid types are $$$SDCONCEPT, $$$SDRELATIONM, $$$SDENTITY, $$$SDCRC and $$$SDPATH.