SentenceQAPI Class Reference

Inheritance diagram for SentenceQAPI:

Collaboration diagram for SentenceQAPI:

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.Integer setop, _.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 sourceidlist, _.Library.String scText)
_.Library.Integer	GetCountBySource (_.Library.Integer domainid, _.Library.String sourceidlist, _.Library.String scText)
_.Library.String	GetLanguage (_.Library.Integer domainid, _.Library.Integer sentenceid, _.Library.Numeric confidence, _.Library.Integer vSrcId)
_.Library.String	GetPartLiteral (_.Library.Integer domainId, _.Library.Integer sentenceId, _.Library.Integer position, _.Library.Integer vSrcId)
	Returns the literal of the entity or nonrelevant at the specified position.
_.Library.Integer	GetPosition (_.Library.Integer domainId, _.Library.Integer sentenceId, _.Library.Integer vSrcId)
	Returns the position within the source this sentence occurs at (1-based).
_.Library.Integer	GetSourceId (_.Library.Integer domainId, _.Library.Integer sentenceId)
	Returns the source ID in which the supplied sentence ID occurs.
_.Library.String	GetValue (_.Library.Integer domainid, _.Library.Integer sentenceid, _.Library.Boolean fullSentence, _.Library.Integer vSrcId)

Detailed Description

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

See the classdocs for <class>iKnow.Queries.SentenceAPI</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.SentenceAPI</class>, exposed as SqlProc methods.

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

Retrieves the number of sentences containing the given CRC ids, optionally limited to

all sentences in records satisfying filter. For querying Virtual Sources, set filter to a single, negative integer. In this case, crcidlist is expected to contain virtual Entity 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.Integer  setop, _.Library.String  scText, _.Library.Boolean  pActualFormOnly  )

static

Retrieves the number of sentences containing a CRC satisfying the given CRC Mask, optionally limited to

all sentences in records satisfying filter. For querying Virtual Sources, set filter to a single, negative integer.

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 sentences containing the given CRCs, optionally limited to

all sentences in records satisfying filter. For querying Virtual Sources, set filter to a single, negative integer.

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

Returns the total number of sentences for a given domain, optionally filtered to those sources

satisfying a <class>iKnow.Filters.Filter</class> object passed in 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 sentences containing the given entities, optionally limited to

all sentences in records satisfying filter. For querying Virtual Sources, set filter to a single, negative integer.

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 nubmer of sentences containing the given entity ids.

For querying Virtual Sources, set filter to a single, negative integer. In this case, entityidlist is expected to contain virtual Entity IDs.

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

If stemming is enabled for this domain through $$$IKPSTEMMING, sources containing any actual form of the entities in entityidlist will be returned. Use pActualFormOnly=1 to retrieve only those sources containing the actual forms in entityidlist. This argument is ignored if stemming is not enabled.

GetCountByPathIds()

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

static

Retrieves the number of sentences containing the given path 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 sentences for the given sources. Negative Source IDs are

interpreted as referring to Virtual Sources.

GetLanguage()

_.Library.String GetLanguage ( _.Library.Integer  domainid, _.Library.Integer  sentenceid, _.Library.Numeric  confidence, _.Library.Integer  vSrcId  )

static

Retrieves the language of the given sentence, as derived by the Automatic Language Identification

algorithm or, if ALI was disabled, the language specified when indexing this sentence.

The confidence level is returned as well through an output parameter. If the confidence level is 0, this means ALI was not used and the language was defined by the user loading the source.

If a Virtual Source ID is specified, the sentence ID is treated as a virtual one, in the context of the supplied vSrcId.

GetValue()

_.Library.String GetValue ( _.Library.Integer  domainid, _.Library.Integer  sentenceid, _.Library.Boolean  fullSentence, _.Library.Integer  vSrcId  )

static

This method rebuilds a sentence based on the literals and entities it is composed of.

The string returned is the first part, up to the maximum string length, whereas the output parameter fullSentence is an array containing all the parts in the right order, containing a Boolean value at the top level indicating whether the returned string is the full sentence (1) or (if 0) the user should have to look into this array to learn the full sentence.

If a Virtual Source ID is specified, the sentence ID is treated as a virtual one, in the context of the supplied vSrcId.