DominanceWSAPI Class Reference

Inheritance diagram for DominanceWSAPI:

Collaboration diagram for DominanceWSAPI:

Static Public Member Functions
_.XML.DataSet	GetAggregateOverlaps (_.Library.Integer domainid, _.Library.Integer type, _.Library.String set1, _.Library.String set2, _.Library.Integer page, _.Library.Integer pagesize)
_.XML.DataSet	GetBreakingSources (_.Library.Integer domainid, _.Library.Integer page, _.Library.Integer pagesize, _.Library.Integer type, _.Library.String filter)
_.XML.DataSet	GetBySource (_.Library.Integer domainid, _.Library.Integer srcid, _.Library.Integer page, _.Library.Integer pagesize, _.Library.Integer type, _.Library.Integer cutoff)
_.Library.Integer	GetCountBySource (_.Library.Integer domainid, _.Library.Integer srcid, _.Library.Integer type, _.Library.Integer cutoff)
_.Library.Numeric	GetDomainValue (_.Library.Integer domainid, _.Library.Integer id, _.Library.Integer type)
_.XML.DataSet	GetOverlap (_.Library.Integer domainid, _.Library.Integer page, _.Library.Integer pagesize, _.Library.Integer type, _.Library.String filter)
_.XML.DataSet	GetOverlapDetails (_.Library.Integer domainid, _.Library.Integer id, _.Library.Integer page, _.Library.Integer pagesize, _.Library.Integer type, _.Library.String filter)
_.XML.DataSet	GetProfileByDomain (_.Library.Integer domainid, _.Library.Integer page, _.Library.Integer pagesize, _.Library.Integer type)
_.XML.DataSet	GetProfileBySource (_.Library.Integer domainid, _.Library.Integer srcid, _.Library.Integer page, _.Library.Integer pagesize, _.Library.Integer type, _.Library.Integer cutoff)
_.Library.Integer	GetProfileCountByDomain (_.Library.Integer domainid, _.Library.Integer type)
_.Library.Integer	GetProfileCountBySource (_.Library.Integer domainid, _.Library.Integer srcid, _.Library.Integer type, _.Library.Integer cutoff)
_.Library.Numeric	GetSourceValue (_.Library.Integer domainid, _.Library.Integer srcid, _.Library.Integer id, _.Library.Integer type)
_.XML.DataSet	GetSourcesByCorrelation (_.Library.Integer domainid, _.Library.ListOfDataTypes entids, _.Library.Integer page, _.Library.Integer pagesize, _.Library.String filter)
_.XML.DataSet	GetTop (_.Library.Integer pDomainId, _.Library.Integer pPage, _.Library.Integer pPageSize, _.Library.String pFilter, _.Library.String pAggregation, _.Library.Integer pEntRole, _.Library.ListOfDataTypes pSkipLists)
_.XML.DataSet	GetTypicalSources (_.Library.Integer domainid, _.Library.Integer page, _.Library.Integer pagesize, _.Library.Integer type, _.Library.String filter)

Static Public Attributes
	NAMESPACE = None

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 WebMethod methods.

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

Member Function Documentation

GetAggregateOverlaps()

_.XML.DataSet GetAggregateOverlaps ( _.Library.Integer  domainid, _.Library.Integer  type, _.Library.String  set1, _.Library.String  set2, _.Library.Integer  page, _.Library.Integer  pagesize  )

static

Calculates the overlapping overlap of two sets of documents. First the overlap within set1 is calculated, then the overlap within

set2. Finally those are compared and the most overlapping elements within those 2 sets are returned.

GetBreakingSources()

_.XML.DataSet GetBreakingSources ( _.Library.Integer  domainid, _.Library.Integer  page, _.Library.Integer  pagesize, _.Library.Integer  type, _.Library.String  filter  )

static

Returns the list of most breaking sources in a domain. The type parameter defines on which type of element you want the

list of breaking documents to be based. This can be:

• $$$SDCONCEPT
• $$$SDRELATION
• $$$SDENTITY
• $$$SDCRC

.

GetBySource()

_.XML.DataSet GetBySource ( _.Library.Integer  domainid, _.Library.Integer  srcid, _.Library.Integer  page, _.Library.Integer  pagesize, _.Library.Integer  type, _.Library.Integer  cutoff  )

static

Returns all dominant elements for a specific source. The type of elements returned can be set by the type parameter.

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

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

GetCountBySource()

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

static

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  )

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.

GetOverlap()

_.XML.DataSet GetOverlap ( _.Library.Integer  domainid, _.Library.Integer  page, _.Library.Integer  pagesize, _.Library.Integer  type, _.Library.String  filter  )

static

Returns the most overlapping elements in a domain. This can be restricted by type by setting the type parameter to any of those values:

• $$$SDCONCEPT
• $$$SDRELATION
• $$$SDENTITY
• $$$SDCRC

.

GetOverlapDetails()

_.XML.DataSet GetOverlapDetails ( _.Library.Integer  domainid, _.Library.Integer  id, _.Library.Integer  page, _.Library.Integer  pagesize, _.Library.Integer  type, _.Library.String  filter  )

static

Returns the overlap details of an element in a domain. The type of the element must be specified through the type parameter to any of those values:

• $$$SDCONCEPT
• $$$SDRELATION
• $$$SDENTITY
• $$$SDCRC

.

GetProfileByDomain()

_.XML.DataSet GetProfileByDomain ( _.Library.Integer  domainid, _.Library.Integer  page, _.Library.Integer  pagesize, _.Library.Integer  type  )

static

Returns the dominance profile for a complete domain. The type of elements returned can be set by the type parameter.

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

GetProfileBySource()

_.XML.DataSet GetProfileBySource ( _.Library.Integer  domainid, _.Library.Integer  srcid, _.Library.Integer  page, _.Library.Integer  pagesize, _.Library.Integer  type, _.Library.Integer  cutoff  )

static

Returns the dominance profile for a specific source. The type of elements returned can be set by the type parameter.

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

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

GetProfileCountByDomain()

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

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  )

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  )

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.

GetSourcesByCorrelation()

_.XML.DataSet GetSourcesByCorrelation ( _.Library.Integer  domainid, _.Library.ListOfDataTypes  entids, _.Library.Integer  page, _.Library.Integer  pagesize, _.Library.String  filter  )

static

Returns a set of documents wich correlate closely to the input set (entids) of entities based on the dominance values of those entities

within the documents.

GetTop()

_.XML.DataSet GetTop ( _.Library.Integer  pDomainId, _.Library.Integer  pPage, _.Library.Integer  pPageSize, _.Library.String  pFilter, _.Library.String  pAggregation, _.Library.Integer  pEntRole, _.Library.ListOfDataTypes  pSkipLists  )

static

Returns the top entities for this domain, sorted by their aggregated dominance values.

pAggregation defines how to aggregate the source-level values. Currently the only supported value is "AVG", which just calculates a regular average as a fast approximation. Future versions will offer more advanced aggregation modes (which may be slower to calculate).

GetTypicalSources()

_.XML.DataSet GetTypicalSources ( _.Library.Integer  domainid, _.Library.Integer  page, _.Library.Integer  pagesize, _.Library.Integer  type, _.Library.String  filter  )

static

Returns the list of most typical sources in a domain. The type parameter defines on which type of element you want the

list of typical documents to be based. This can be:

• $$$SDCONCEPT
• $$$SDRELATION
• $$$SDENTITY
• $$$SDCRC

.

Member Data Documentation

NAMESPACE

NAMESPACE = None

static

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

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