This is documentation for Caché & Ensemble. See the InterSystems IRIS version of this content.

For information on migrating to InterSystems IRIS, see Why Migrate to InterSystems IRIS?

%iKnow.Objects.CcUnique

persistent class %iKnow.Objects.CcUnique extends %Library.Persistent

SQL Table Name: %iKnow_Objects.CcUnique

Note: the use of this class is no longer recommended for accessing elements of a specific domain. For those scenarios, %iKnow.Tables.Utils offers a more flexible and customizable way of projecting iKnow domain data to SQL

This is a read-only object representation wrapping the internal iKnow data structures for unique CCs.

This class can be used from Cache ObjectScript or SQL to access a single or small number of entries, but the storage mappings are not meant to support elaborate or complex queries targeting this SQL table.

Please use the predefined queries in %iKnow.Queries.CcAPI and other query classes to consult CC data as the internal global structures are designed to optimize performance for these queries rather than general-purpose access.

NOTE: This object assumes all underlying data structures are present. Use domain-specific copies of these objects for domains where not all indices are built. See also the GenerateAllObjectsForDomain() method in %iKnow.Objects.Utils.

Property Inventory

Parameters

parameter READONLY = 1;
Inherited description: READONLY = 1 means that objects can be created, opened but not saved or deleted. Tables are projected to SQL as READONLY.

Properties

property CcUniId as %Integer [ Required ];
Property methods: CcUniIdDisplayToLogical(), CcUniIdFreqExists(), CcUniIdGet(), CcUniIdIsValid(), CcUniIdLogicalToDisplay(), CcUniIdNormalize(), CcUniIdSet(), CcUniIdSpreadExists()
property CorpusFrequency as %Integer [ Calculated ];
Property methods: CorpusFrequencyCompute(), CorpusFrequencyDisplayToLogical(), CorpusFrequencyGet(), CorpusFrequencyIsValid(), CorpusFrequencyLogicalToDisplay(), CorpusFrequencyNormalize(), CorpusFrequencySQLCompute()
property CorpusSpread as %Integer [ Calculated ];
Property methods: CorpusSpreadCompute(), CorpusSpreadDisplayToLogical(), CorpusSpreadGet(), CorpusSpreadIsValid(), CorpusSpreadLogicalToDisplay(), CorpusSpreadNormalize(), CorpusSpreadSQLCompute()
property DomainId as %Integer [ Required ];
Property methods: DomainIdDisplayToLogical(), DomainIdGet(), DomainIdIsValid(), DomainIdLogicalToDisplay(), DomainIdNormalize(), DomainIdSet()
property Master as %iKnow.Objects.EntityUnique [ Calculated ];
Property methods: MasterCompute(), MasterGet(), MasterGetObject(), MasterGetObjectId(), MasterIdDisplayToLogical(), MasterIdGet(), MasterIdIsValid(), MasterIdLogicalToDisplay(), MasterIdNormalize(), MasterIdSet(), MasterSQLCompute()
property MasterId as %Integer;
Property methods: MasterIdDisplayToLogical(), MasterIdGet(), MasterIdIsValid(), MasterIdLogicalToDisplay(), MasterIdNormalize(), MasterIdSet()
property Slave as %iKnow.Objects.EntityUnique [ Calculated ];
Property methods: SlaveCompute(), SlaveGet(), SlaveGetObject(), SlaveGetObjectId(), SlaveIdDisplayToLogical(), SlaveIdGet(), SlaveIdIsValid(), SlaveIdLogicalToDisplay(), SlaveIdNormalize(), SlaveIdSet(), SlaveSQLCompute()
property SlaveId as %Integer;
Property methods: SlaveIdDisplayToLogical(), SlaveIdGet(), SlaveIdIsValid(), SlaveIdLogicalToDisplay(), SlaveIdNormalize(), SlaveIdSet()

Indexes

index (CcUni on DomainId,MasterId,SlaveId) [Unique];
Index methods: CcUniCheck(), CcUniCheckUnique(), CcUniDelete(), CcUniExists(), CcUniIdDisplayToLogical(), CcUniIdFreqExists(), CcUniIdGet(), CcUniIdIsValid(), CcUniIdLogicalToDisplay(), CcUniIdNormalize(), CcUniIdSet(), CcUniIdSpreadExists(), CcUniOpen(), CcUniSQLCheckUnique(), CcUniSQLExists(), CcUniSQLFindPKeyByConstraint(), CcUniSQLFindRowIDByConstraint()
index (CcUniIdFreq on DomainId,CorpusFrequency);
Index methods: CcUniIdFreqExists()
index (CcUniIdSpread on DomainId,CorpusSpread);
Index methods: CcUniIdSpreadExists()
index (PKINDEX on DomainId,CcUniId) [IdKey, PrimaryKey, Type = key, Unique];
Index methods: PKINDEXCheck(), PKINDEXDelete(), PKINDEXExists(), PKINDEXOpen(), PKINDEXSQLCheckUnique(), PKINDEXSQLExists(), PKINDEXSQLFindPKeyByConstraint(), PKINDEXSQLFindRowIDByConstraint()

Inherited Members

Inherited Methods

Storage

Storage Model: CacheSQLStorage

Maps: 4

  • Map number 1 is named CcUni

    thismap.Global: ^ISC.IK.CcUni

  • Map number 2 is named CcUniIdFreq

    thismap.Global: ^ISC.IK.CcUniIdFreq

  • ^ISC.IK.CcUni({DomainId},{MasterId},{SlaveId})
    =
    Node Delimiter Piece Name
    CcUniId
  • Map number 3 is named CcUniIdSpread

    thismap.Global: ^ISC.IK.CcUniIdSpread

  • ^ISC.IK.CcUniIdFreq({DomainId},-{CorpusFrequency},{CcUniId})
    =
  • Map number 4 is named MainMap

    thismap.Global: ^ISC.IK.CcUniId

  • ^ISC.IK.CcUniIdSpread({DomainId},-{CorpusSpread},{CcUniId})
    =
    ^ISC.IK.CcUniId({DomainId},{CcUniId})
    =
    Node Delimiter Piece Name
    1 MasterId
    2 SlaveId
Feedback