EntityQAPI Class Reference

Inheritance diagram for EntityQAPI:

Collaboration diagram for EntityQAPI:

Static Public Member Functions
_.Library.Integer	GetCountByDomain (_.Library.Integer domainid, _.Library.String filter, _.Library.String scText, _.Library.String skipListIds, _.Library.Boolean includeZeroFrequency, _.Library.Boolean pUseStems)
_.Library.Integer	GetCountBySource (_.Library.Integer domainid, _.Library.String sourceidlist, _.Library.Integer setop, _.Library.String scText, _.Library.String skipListIds, _.Library.Integer enttype, _.Library.Boolean pUseStems)
_.Library.Integer	GetFrequency (_.Library.Integer domainId, _.Library.Integer entUniId, _.Library.Integer enttype, _.Library.Integer vSrcId, _.Library.String filter, _.Library.String scText)
_.Library.Integer	GetId (_.Library.Integer domainid, _.Library.String entityvalue, _.Library.Integer vSrcId)
_.Library.String	GetLiteral (_.Library.Integer pDomainId, _.Library.Integer pPartId, _.Library.Integer vSrcId)
_.Library.Integer	GetOccurrenceCountByDomain (_.Library.Integer pDomainId, _.Library.String pFilter, _.Library.Integer pEntType, _.Library.String scText)
_.Library.Integer	GetOccurrenceCountBySource (_.Library.Integer domainid, _.Library.String sourceidlist, _.Library.String scText, _.Library.Integer enttype)
_.Library.Integer	GetRelatedCount (_.Library.Integer domainid, _.Library.String entitylist, _.Library.String filter, _.Library.Integer positionstomatch, _.Library.Integer setop, _.Library.String scText, _.Library.Boolean pIncludeActualForms)
_.Library.Integer	GetRelatedCountById (_.Library.Integer domainid, _.Library.String entityidlist, _.Library.String filter, _.Library.Integer positionstomatch, _.Library.Integer setop, _.Library.String scText, _.Library.Boolean pIncludeActualForms)
_.Library.Integer	GetSpread (_.Library.Integer domainId, _.Library.Integer entUniId, _.Library.Integer enttype, _.Library.String filter, _.Library.String scText)
_.Library.String	GetStem (_.Library.Integer pDomainId, _.Library.String pString, _.Library.String pLanguage, _.Library.String scText)
	Returns the stemmed form of the supplied string pString. More...
_.Library.Integer	GetStemFrequency (_.Library.Integer pDomainId, _.Library.Integer pStemUniId, _.Library.Integer pEntType, _.Library.Integer vSrcId, _.Library.String pFilter, _.Library.String scText)
_.Library.Integer	GetStemId (_.Library.Integer pDomainId, _.Library.String pStemValue, _.Library.Integer vSrcId)
_.Library.String	GetStemRepresentationForm (_.Library.Integer pDomainId, _.Library.Integer pStemUniId, _.Library.String pLanguage, _.Library.Integer vSrcId, _.Library.String scText)
	Returns the representation form for the given stem and language.
_.Library.Integer	GetStemSpread (_.Library.Integer pDomainId, _.Library.Integer pStemUniId, _.Library.Integer pEntType, _.Library.String pFilter, _.Library.String scText)
_.Library.String	GetStemValue (_.Library.Integer pDomainId, _.Library.Integer pStemUniId, _.Library.Integer vSrcId, _.Library.String scText)
	Returns the string value of the stem identified by pStemUniId
_.Library.String	GetValue (_.Library.Integer domainid, _.Library.Integer entityid, _.Library.Integer vSrcId, _.Library.String scText)
_.Library.Boolean	IsAttributed (_.Library.Integer pDomainId, _.Library.Integer pEntOccId, _.Library.Integer pAttTypeId, _.Library.Integer vSrcId, _.Library.String scText)
	Checks if a given entity occurrence has the requested attribute pAttTypeId.

Detailed Description

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

See the classdocs for <class>iKnow.Queries.EntityAPI</class> for more information.

Member Function Documentation

GetCountByDomain()

_.Library.Integer GetCountByDomain ( _.Library.Integer  domainid, _.Library.String  filter, _.Library.String  scText, _.Library.String  skipListIds, _.Library.Boolean  includeZeroFrequency, _.Library.Boolean  pUseStems  )

static

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

See the classdocs for <class>iKnow.Queries.EntityAPI</class> for more information.

Returns the total number of distinct entities for this domain, optionally filtered to a set of

sources satisfying the <class>iKnow.Filters.Filter</class> object supplied through filter. Depending on the value of includeZeroFrequency, entities not appearing in any source (but registered in the domain for other purposes) are included or excluded from the result.

Through the skipListIds parameter, a user can supply one or more lists of (to the user) insignificant terms that should be excluded from the result.

GetCountBySource()

_.Library.Integer GetCountBySource ( _.Library.Integer  domainid, _.Library.String  sourceidlist, _.Library.Integer  setop, _.Library.String  scText, _.Library.String  skipListIds, _.Library.Integer  enttype, _.Library.Boolean  pUseStems  )

static

Returns the total number of distinct entities for a given list of sources. The count returned either

represents the entities appearing in either (with setop $$$UNION) or all (with setop $$$INTERSECT) of the supplied sources. Using enttype, the returned count is filtered to just entities ($$$ENTTYPECONCEPT), relations ($$$ENTTYPERELATION). The default is unfiltered ($$$ENTTYPEANY).

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

Through the skipListIds parameter, a user can supply one or more lists of (to the user) insignificant terms that should be excluded from the result.

GetFrequency()

_.Library.Integer GetFrequency ( _.Library.Integer  domainId, _.Library.Integer  entUniId, _.Library.Integer  enttype, _.Library.Integer  vSrcId, _.Library.String  filter, _.Library.String  scText  )

static

Returns the frequency of the entity corresponding to the supplied entUniId, occurring

in a concept role (if enttype = $$$ENTTYPECONCEPT), a relationship role (if enttype = $$$ENTTYPERELATION) or both (enttype = $$$ENTTYPEANY).

When specifying a Virtual Source ID, the frequency within the virtual source will be returned.

GetId()

_.Library.Integer GetId ( _.Library.Integer  domainid, _.Library.String  entityvalue, _.Library.Integer  vSrcId  )

static

Returns the entity ID corresponding to the specified entity value, if any.

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

GetLiteral()

_.Library.String GetLiteral ( _.Library.Integer  pDomainId, _.Library.Integer  pPartId, _.Library.Integer  vSrcId  )

static

Returns the literal value for a particular Part ID, as it

occurred in the original text.

GetOccurrenceCountByDomain()

_.Library.Integer GetOccurrenceCountByDomain ( _.Library.Integer  pDomainId, _.Library.String  pFilter, _.Library.Integer  pEntType, _.Library.String  scText  )

static

Returns the total number of entity occurrences in a domain.

GetOccurrenceCountBySource()

_.Library.Integer GetOccurrenceCountBySource ( _.Library.Integer  domainid, _.Library.String  sourceidlist, _.Library.String  scText, _.Library.Integer  enttype  )

static

Returns the total number of entity occurrences for the given list of sources. Use negative source

IDs to refer to virtual sources.

GetRelatedCount()

_.Library.Integer GetRelatedCount ( _.Library.Integer  domainid, _.Library.String  entitylist, _.Library.String  filter, _.Library.Integer  positionstomatch, _.Library.Integer  setop, _.Library.String  scText, _.Library.Boolean  pIncludeActualForms  )

static

Returns the number of related entities for a given list of entities.

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

GetRelatedCountById()

_.Library.Integer GetRelatedCountById ( _.Library.Integer  domainid, _.Library.String  entityidlist, _.Library.String  filter, _.Library.Integer  positionstomatch, _.Library.Integer  setop, _.Library.String  scText, _.Library.Boolean  pIncludeActualForms  )

static

Returns the number of related entities for a given list of entity ids.

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

GetSpread()

_.Library.Integer GetSpread ( _.Library.Integer  domainId, _.Library.Integer  entUniId, _.Library.Integer  enttype, _.Library.String  filter, _.Library.String  scText  )

static

Returns the spread of the entity corresponding to the supplied entUniId, occurring

in a concept role (if enttype = $$$ENTTYPECONCEPT), a relationship role (if enttype = $$$ENTTYPERELATION) or both (enttype = $$$ENTTYPEANY).

GetStem()

_.Library.String GetStem ( _.Library.Integer  pDomainId, _.Library.String  pString, _.Library.String  pLanguage, _.Library.String  scText  )

static

Returns the stemmed form of the supplied string pString.

If pDomainId is non-null, any domain-level configuration settings will be used for the stemming operation.

GetStemFrequency()

_.Library.Integer GetStemFrequency ( _.Library.Integer  pDomainId, _.Library.Integer  pStemUniId, _.Library.Integer  pEntType, _.Library.Integer  vSrcId, _.Library.String  pFilter, _.Library.String  scText  )

static

Returns the frequency of the stem corresponding to the supplied pStemUniId, occurring

in a concept role (if pEntType = $$$ENTTYPECONCEPT), a relationship role (if pEntType = $$$ENTTYPERELATION) or both (pEntType = $$$ENTTYPEANY).

When specifying a Virtual Source ID, the frequency within the virtual source will be returned.

GetStemId()

_.Library.Integer GetStemId ( _.Library.Integer  pDomainId, _.Library.String  pStemValue, _.Library.Integer  vSrcId  )

static

Returns the stem ID corresponding to the specified stem value, if any.

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

GetStemSpread()

_.Library.Integer GetStemSpread ( _.Library.Integer  pDomainId, _.Library.Integer  pStemUniId, _.Library.Integer  pEntType, _.Library.String  pFilter, _.Library.String  scText  )

static

Returns the spread of the stem corresponding to the supplied pStemUniId, occurring

in a concept role (if pEntType = $$$ENTTYPECONCEPT), a relationship role (if pEntType = $$$ENTTYPERELATION) or both (pEntType = $$$ENTTYPEANY).

GetValue()

_.Library.String GetValue ( _.Library.Integer  domainid, _.Library.Integer  entityid, _.Library.Integer  vSrcId, _.Library.String  scText  )

static

Returns the entity string value corresponding to the specified entity ID, if any.