PathQAPI Class Reference

Inheritance diagram for PathQAPI:

Collaboration diagram for PathQAPI:

Static Public Member Functions
_.Library.Integer	GetCountByDomain (_.Library.Integer domainid, _.Library.String filter, _.Library.String scText)
_.Library.Integer	GetCountByEntities (_.Library.Integer domainid, _.Library.String entitylist, _.Library.String filter, _.Library.Integer setop, _.Library.String scText, _.Library.Boolean pActualFormOnly)
_.Library.Integer	GetCountByEntityIds (_.Library.Integer domainid, _.Library.String entityidlist, _.Library.String filter, _.Library.Integer setop, _.Library.String scText, _.Library.Boolean pActualFormOnly)
_.Library.Integer	GetCountBySource (_.Library.Integer domainid, _.Library.String sourceidlist, _.Library.String scText)
_.Library.Integer	GetId (_.Library.Integer domainid, _.Library.String entityList, _.Library.Integer vSrcId, _.Library.String scText)
_.Library.Integer	GetSentenceId (_.Library.Integer domainId, _.Library.Integer pathId, _.Library.String scText, _.Library.Integer vSrcId)
	Returns the sentence ID in which the supplied path ID occurs.
_.Library.Integer	GetSourceId (_.Library.Integer domainId, _.Library.Integer pathId, _.Library.String scText)
	Returns the source ID in which the supplied path ID occurs.
_.Library.String	GetValue (_.Library.Integer domainid, _.Library.Integer pathid, _.Library.Integer vSrcId, _.Library.String scText, _.Library.Boolean pUseStems)

Detailed Description

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

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

Member Function Documentation

GetCountByDomain()

_.Library.Integer GetCountByDomain ( _.Library.Integer  domainid, _.Library.String  filter, _.Library.String  scText  )

static

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

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

Returns the number of paths in a domain, optionally restricted to those appearing in a source

satisfying the <class>iKnow.Filters.Filter</class> object supplied through filter.

GetCountByEntities()

_.Library.Integer GetCountByEntities ( _.Library.Integer  domainid, _.Library.String  entitylist, _.Library.String  filter, _.Library.Integer  setop, _.Library.String  scText, _.Library.Boolean  pActualFormOnly  )

static

Retrieves the number of paths containing the specified entities.

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

GetCountByEntityIds()

_.Library.Integer GetCountByEntityIds ( _.Library.Integer  domainid, _.Library.String  entityidlist, _.Library.String  filter, _.Library.Integer  setop, _.Library.String  scText, _.Library.Boolean  pActualFormOnly  )

static

Retrieves the number of paths containing the specified entity IDs.

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

GetCountBySource()

_.Library.Integer GetCountBySource ( _.Library.Integer  domainid, _.Library.String  sourceidlist, _.Library.String  scText  )

static

Returns the total number of paths in the sources specified through sourceidlist.

Use negative source IDs to refer to virtual sources.

GetId()

_.Library.Integer GetId ( _.Library.Integer  domainid, _.Library.String  entityList, _.Library.Integer  vSrcId, _.Library.String  scText  )

static

This method will try to find a path corresponding to the supplied list of entities in the

specified order. If no path is found, "" is returned.

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

GetValue()

_.Library.String GetValue ( _.Library.Integer  domainid, _.Library.Integer  pathid, _.Library.Integer  vSrcId, _.Library.String  scText, _.Library.Boolean  pUseStems  )

static

Returns the sequence of entity values corresponding to the specified path as a

<class>List</class>.

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

If stemming is enabled for this domain through the $$$IKPSTEMMING domain parameter, you can use pUseStems=1 to get the stems rather than the entities for this path.