Class Reference
IRIS for UNIX 2019.3
InterSystems: The power behind what matters   
Documentation  Search
  [ENSLIB] >  [%iKnow] >  [Queries] >  [CrcQAPI]
Private  Storage   

class %iKnow.Queries.CrcQAPI extends %iKnow.Queries.AbstractQAPI

This is an automatically generated class, offering a functionally equivalent set of methods and queries as %iKnow.Queries.CrcAPI, exposed as SqlProc methods.

See the classdocs for %iKnow.Queries.CrcAPI for more information.

This class was generated by %iKnow.Queries.CrcAPI.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
29 7


Summary

Methods
%%OIDGet %AddToSaveSet %BindExport %BuildObjectGraph
%ClassIsLatestVersion %ClassName %Close %ConstructClone
%DispatchClassMethod %DispatchGetModified %DispatchGetProperty %DispatchMethod
%DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty %Extends
%GetParameter %IncrementCount %IsA %IsModified
%New %NormalizeObject %ObjectModified %OriginalNamespace
%PackageName %RemoveFromSaveSet %SerializeObject %SetModified
%ValidateObject GetByEntitiesClose GetByEntitiesExecute GetByEntitiesFetch
GetByEntityIdsClose GetByEntityIdsExecute GetByEntityIdsFetch GetByFilterClose
GetByFilterExecute GetByFilterFetch GetBySourceClose GetBySourceExecute
GetBySourceFetch GetCountByDomain GetCountByEntities GetCountByEntityIds
GetCountBySource GetFrequency GetId GetOccurrenceCountBySource
GetOccurrencesBySourceClose GetOccurrencesBySourceExecute GetOccurrencesBySourceFetch GetSpread
GetTopClose GetTopExecute GetTopFetch GetValueClose
GetValueExecute GetValueFetch


Methods

• classmethod GetByEntitiesClose(ByRef qHandle As %Binary) as %Status
• classmethod GetByEntitiesExecute(ByRef qHandle As %Binary, domainid As %Integer, entitylist As %String(MAXLEN=32767), page As %Integer = 1, pagesize As %Integer = 10, filter As %String(MAXLEN=32767)="", filtermode As %Integer = $$$FILTERONLY, positionstomatch As %Integer = $$$USEPOSALL, pActualFormOnly As %Boolean = 0) as %Status
• classmethod GetByEntitiesFetch(ByRef qHandle As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer = 0) as %Status
• classmethod GetByEntityIdsClose(ByRef qHandle As %Binary) as %Status
• classmethod GetByEntityIdsExecute(ByRef qHandle As %Binary, domainid As %Integer, entityidlist As %String(MAXLEN=32767), page As %Integer = 1, pagesize As %Integer = 10, filter As %String(MAXLEN=32767)="", filtermode As %Integer = $$$FILTERONLY, positionstomatch As %Integer = $$$USEPOSALL, pActualFormOnly As %Boolean = 0) as %Status
• classmethod GetByEntityIdsFetch(ByRef qHandle As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer = 0) as %Status
• classmethod GetByFilterClose(ByRef qHandle As %Binary) as %Status
• classmethod GetByFilterExecute(ByRef qHandle As %Binary, domainid As %Integer, filter As %String(MAXLEN=32767)="", filtermode As %Integer = $$$FILTERONLY) as %Status
• classmethod GetByFilterFetch(ByRef qHandle As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer = 0) as %Status
• classmethod GetBySourceClose(ByRef qHandle As %Binary) as %Status
• classmethod GetBySourceExecute(ByRef qHandle As %Binary, domainid As %Integer, sourceidlist As %String(MAXLEN=32767), page As %Integer = 1, pagesize As %Integer = 10) as %Status
• classmethod GetBySourceFetch(ByRef qHandle As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer = 0) as %Status
• classmethod GetCountByDomain(domainid As %Integer, filter As %String(MAXLEN=32767)="", Output scText As %String = "", includeZeroFrequency As %Boolean = 0) as %Library.Integer [ SQLProc = ]

Returns the total number of unique CRCs in a domain, optionally limited through supplying a %iKnow.Filters.Filter object as the filter parameter to restrict the result to those CRCs occurring in any source satisfying the filter criteria.

• classmethod GetCountByEntities(domainid As %Integer, entitylist As %String(MAXLEN=32767), filter As %String(MAXLEN=32767)="", positionstomatch As %Integer = $$$USEPOSALL, Output scText As %String = "", pActualFormOnly As %Boolean = 0) as %Library.Integer [ SQLProc = ]

Returns the number of CRCs in this domain, based on a list of entities.

See also GetByEntities for a description of the parameters.

• classmethod GetCountByEntityIds(domainid As %Integer, entityidlist As %String(MAXLEN=32767), filter As %String(MAXLEN=32767)="", positionstomatch As %Integer = $$$USEPOSALL, Output scText As %String = "", pActualFormOnly As %Boolean = 0) as %Library.Integer [ SQLProc = ]

Returns the number of CRCs in this domain, based on a list of entity IDs.

See also GetByEntities for a description of the parameters.

• classmethod GetCountBySource(domainid As %Integer, sourceidlist As %String(MAXLEN=32767), setop As %Integer = $$$UNION, Output scText As %String = "") as %Library.Integer [ SQLProc = ]

Returns the total number of unique CRCs appearing in either (if setop = $$$UNION) or all (if setop = $$$INTERSECT) of the sources specified by ID in sourceidlist.

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

• classmethod GetFrequency(domainId As %Integer, crcUniId As %Integer, vSrcId As %Integer = 0, filter As %String(MAXLEN=32767)="", Output scText As %String = "") as %Library.Integer [ SQLProc = ]

Returns the frequency of the CRC corresponding to the supplied crcUniId.

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

• classmethod GetId(domainid As %Integer, master As %String(MAXLEN=32767), relation As %String(MAXLEN=32767), slave As %String(MAXLEN=32767), vSrcId As %Integer = 0) as %Library.Integer [ SQLProc = ]

Returns, if any, the CRC ID for the combination of master, relation and slave specified.

When specifying a Virtual Source ID, it will treat the master, relation and slaves as virtual entities, in the context of that vSrcId.

• classmethod GetOccurrenceCountBySource(domainid As %Integer, sourceidlist As %String(MAXLEN=32767), Output scText As %String = "") as %Library.Integer [ SQLProc = ]

Returns the total number of CRC occurrences in the specified sources.

Use negative source IDs to refer to virtual sources

• classmethod GetOccurrencesBySourceClose(ByRef qHandle As %Binary) as %Status
• classmethod GetOccurrencesBySourceExecute(ByRef qHandle As %Binary, domainid As %Integer, srcid As %Integer, page As %Integer = 1, pagesize As %Integer = 10) as %Status
• classmethod GetOccurrencesBySourceFetch(ByRef qHandle As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer = 0) as %Status
• classmethod GetSpread(domainId As %Integer, crcUniId As %Integer, filter As %String(MAXLEN=32767)="", Output scText As %String = "") as %Library.Integer [ SQLProc = ]

Returns the spread of the CRC corresponding to the supplied crcUniId.

• classmethod GetTopClose(ByRef qHandle As %Binary) as %Status
• classmethod GetTopExecute(ByRef qHandle As %Binary, domainid As %Integer, page As %Integer = 1, pagesize As %Integer = 10, filter As %String(MAXLEN=32767)="", filtermode As %Integer = $$$FILTERONLY, sorttype As %Integer = $$$SORTBYDOMAINDEFAULT, vSrcId As %Integer = 0) as %Status
• classmethod GetTopFetch(ByRef qHandle As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer = 0) as %Status
• classmethod GetValueClose(ByRef qHandle As %Binary) as %Status
• classmethod GetValueExecute(ByRef qHandle As %Binary, domainid As %Integer, crcid As %Integer, vSrcId As %Integer = 0) as %Status
• classmethod GetValueFetch(ByRef qHandle As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer = 0) as %Status

Queries

• query GetByEntities(domainid As %Integer, entitylist As %String(MAXLEN=32767), page As %Integer = 1, pagesize As %Integer = 10, filter As %String(MAXLEN=32767)="", filtermode As %Integer = $$$FILTERONLY, positionstomatch As %Integer = $$$USEPOSALL, pActualFormOnly As %Boolean = 0)
Selects crcId As %Integer, master As %String(MAXLEN=32767), relation As %String(MAXLEN=32767), slave As %String(MAXLEN=32767), frequency As %Integer, spread As %Integer

This method will return all CRC triples in which any of the entities supplied in the entitylist participate, within the boundaries of the supplied domain.

The scope of this query can be limited through supplying a %iKnow.Filters.Filter object for the filter parameter to restrict the result to those CRCs occurring in any source satisfying the filter criteria. When using a filter, the filtermode parameter will control whether or not the frequency and spread of returned records should be recalculated and whether results should be resorted along these recalculated numbers.

Specifying a value for positionstomatch will limit the result to those CRCs in which the supplied entities are in the Master (with positionstomatch = $$$USEPOSM), Relation (with positionstomatch = $$$USEPOSR) or Slave (with positionstomatch = $$$USEPOSS) role of the CRC, or in any combination of these (with positionstomatch = $$$USEPOSMS, $$$USEPOSMR, $$$USEPOSRS, $$$USEPOSALL (the default)).

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

• query GetByEntityIds(domainid As %Integer, entityidlist As %String(MAXLEN=32767), page As %Integer = 1, pagesize As %Integer = 10, filter As %String(MAXLEN=32767)="", filtermode As %Integer = $$$FILTERONLY, positionstomatch As %Integer = $$$USEPOSALL, pActualFormOnly As %Boolean = 0)
Selects crcId As %Integer, master As %String(MAXLEN=32767), relation As %String(MAXLEN=32767), slave As %String(MAXLEN=32767), frequency As %Integer, spread As %Integer

Returns the CRCs in this domain containing any or all of a list of entity IDs.

See also GetByEntities for a description of the parameters.

• query GetByFilter(domainid As %Integer, filter As %String(MAXLEN=32767)="", filtermode As %Integer = $$$FILTERONLY)
Selects crcId As %Integer, master As %String(MAXLEN=32767), relation As %String(MAXLEN=32767), slave As %String(MAXLEN=32767), frequency As %Integer, spread As %Integer

Returns all CRCs appearing in any source satisfying the supplied filter objects criteria, with their frequencies and spread recalculated to comply with the filter depending on the value of filtermode, but the result is NOT re-sorted, regardless of the value for filtermode (use GetTop if you want sorted results).

• query GetBySource(domainid As %Integer, sourceidlist As %String(MAXLEN=32767), page As %Integer = 1, pagesize As %Integer = 10)
Selects crcId As %Integer, master As %String(MAXLEN=32767), relation As %String(MAXLEN=32767), slave As %String(MAXLEN=32767), frequency As %Integer, spread As %Integer

Returns the unique CRCs appearring in the specified sources.

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

• query GetOccurrencesBySource(domainid As %Integer, srcid As %Integer, page As %Integer = 1, pagesize As %Integer = 10)
Selects crcOccId As %Integer, crcUniId As %Integer, master As %String(MAXLEN=32767), relation As %String(MAXLEN=32767), slave As %String(MAXLEN=32767), sentenceId As %Integer, posInSent As %Integer

Returns the CRC occurrences for a given source, in the order in which they appear.

• query GetTop(domainid As %Integer, page As %Integer = 1, pagesize As %Integer = 10, filter As %String(MAXLEN=32767)="", filtermode As %Integer = $$$FILTERONLY, sorttype As %Integer = $$$SORTBYDOMAINDEFAULT, vSrcId As %Integer = 0)
Selects crcId As %Integer, master As %String(MAXLEN=32767), relation As %String(MAXLEN=32767), slave As %String(MAXLEN=32767), freq As %Integer, spread As %Integer

Returns the most frequently occurring CRCs for this domain, sorted by descending frequency (with sorttype $$$SORTBYFREQUENCY), spread (with sorttype $$$SORTBYSPREAD) or the domain default (with sorttype $$$SORTBYDOMAINDEFAULT).

The scope of this query can be limited through supplying a %iKnow.Filters.Filter object for the filter parameter to restrict the result to those CRCs occurring in any source satisfying the filter criteria. When using a filter, the filtermode parameter will control whether or not the frequency and spread of returned records should be recalculated and whether results should be resorted along these recalculated numbers.

If a Virtual Source ID is provided, only the entities in that virtual source will be considered, filters are ignored and the sort type will always be $$$SORTBYFREQUENCY.

• query GetValue(domainid As %Integer, crcid As %Integer, vSrcId As %Integer = 0)
Selects master As %String(MAXLEN=32767), relation As %String(MAXLEN=32767), slave As %String(MAXLEN=32767)

Returns the entity values this CRC is composed of.

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



Copyright (c) 2019 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.