SourceQAPI Class Reference

Inheritance diagram for SourceQAPI:

Collaboration diagram for SourceQAPI:

Static Public Member Functions
_.Library.Integer	GetCountByCrcIds (_.Library.Integer domainid, _.Library.String crcidlist, _.Library.String filter, _.Library.Integer setop, _.Library.String scText)
_.Library.Integer	GetCountByCrcMask (_.Library.Integer domainid, _.Library.String head, _.Library.String relation, _.Library.String tail, _.Library.String filter, _.Library.String scText, _.Library.Boolean pActualFormOnly)
_.Library.Integer	GetCountByCrcs (_.Library.Integer domainid, _.Library.String crclist, _.Library.String filter, _.Library.Integer setop, _.Library.String scText)
_.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	GetCountByPathIds (_.Library.Integer domainid, _.Library.String pathidlist, _.Library.String filter, _.Library.String scText)
_.Library.String	GetExternalId (_.Library.Integer domainid, _.Library.Integer srcId, _.Library.String scText)
_.Library.String	GetFullReference (_.Library.Integer domainId, _.Library.Integer srcId, _.Library.String scText)
_.Library.Integer	GetSourceId (_.Library.Integer domainid, _.Library.String externalId, _.Library.String scText)
_.Library.String	GetSummaryDirect (_.Library.Integer domainId, _.Library.Integer sourceId, _.Library.Integer length, _.Library.Boolean isTruncated, _.Library.String scText, _.Library.String separator, _.Library.String summaryConfig)
_.Library.String	GetTopLanguage (_.Library.Integer domainid, _.Library.Integer sourceid, _.Library.Numeric totalConfidence, _.Library.Integer numberOfSentences, _.Library.String scText)

Detailed Description

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

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

Member Function Documentation

GetCountByCrcIds()

_.Library.Integer GetCountByCrcIds ( _.Library.Integer  domainid, _.Library.String  crcidlist, _.Library.String  filter, _.Library.Integer  setop, _.Library.String  scText  )

static

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

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

Retrieves the number of sources containing the given CRC ids.

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

GetCountByCrcMask()

_.Library.Integer GetCountByCrcMask ( _.Library.Integer  domainid, _.Library.String  head, _.Library.String  relation, _.Library.String  tail, _.Library.String  filter, _.Library.String  scText, _.Library.Boolean  pActualFormOnly  )

static

Retrieves the number of sources containing a CRC satisfying the given CRC Mask.

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

GetCountByCrcs()

_.Library.Integer GetCountByCrcs ( _.Library.Integer  domainid, _.Library.String  crclist, _.Library.String  filter, _.Library.Integer  setop, _.Library.String  scText  )

static

Retrieves the number of sources containing the given CRCs.

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

GetCountByDomain()

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

static

This method returns the total number of sources in the specified domain, optionally filtered

through a <class>iKnow.Filters.Filter</class> object passed in as 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 sources containing the given 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 sources containing the given entity ids.

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

GetCountByPathIds()

_.Library.Integer GetCountByPathIds ( _.Library.Integer  domainid, _.Library.String  pathidlist, _.Library.String  filter, _.Library.String  scText  )

static

Retrieves the number of sources containing the given path ids.

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

GetExternalId()

_.Library.String GetExternalId ( _.Library.Integer  domainid, _.Library.Integer  srcId, _.Library.String  scText  )

static

Retrieves the external ID for the source identified by srcId.

A negative srcId is considered to refer to a Virtual Source.

GetFullReference()

_.Library.String GetFullReference ( _.Library.Integer  domainId, _.Library.Integer  srcId, _.Library.String  scText  )

static

Retrieves the Full Reference for the source identified by srcId.

A negative srcId is considered to refer to a Virtual Source.

GetSourceId()

_.Library.Integer GetSourceId ( _.Library.Integer  domainid, _.Library.String  externalId, _.Library.String  scText  )

static

Retrieves the source ID for the source identified by externalId.

GetSummaryDirect()

_.Library.String GetSummaryDirect ( _.Library.Integer  domainId, _.Library.Integer  sourceId, _.Library.Integer  length, _.Library.Boolean  isTruncated, _.Library.String  scText, _.Library.String  separator, _.Library.String  summaryConfig  )

static

This is a utility wrapper method around <method>GetSummary</method>, returning the summary

sentences as a single concatenated string.

The isTruncated output parameter indicates whether or not the returned string is complete or was truncated to avoid MAXSTRING errors. This can happen when either an individual sentence surpassed the maximum string length or when the concatenation of these sentences surpassed it.

GetTopLanguage()

_.Library.String GetTopLanguage ( _.Library.Integer  domainid, _.Library.Integer  sourceid, _.Library.Numeric  totalConfidence, _.Library.Integer  numberOfSentences, _.Library.String  scText  )

static

This method returns the language of a given source, calculated as the one with the

highest total confidence rating for the individual sentences in the source. This total confidence, as well as the number of sentences to which this language was assigned is provided through output variables totalConfidence and numberOfSentences.

A totalConfidence of 0 indicates ALI was switched off when indexing this source.

A negative Source ID is interpreted as a Virtual Source.