%iKnow.Objects.EntityUnique

deprecated persistent class %iKnow.Objects.EntityUnique extends %Library.Persistent

SQL Table Name: %iKnow_Objects.EntityUnique

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 Entities.

This class can be used from 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.EntityAPI and other query classes to consult Entity data as the internal global structures are designed to optimize performance for these queries rather than general-purpose access.

Note: the EntUni index only works for entities up to 150 characters.

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.

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 CorpusDominanceAsConcept as %Numeric [ Calculated ];

Property methods: CorpusDominanceAsConceptCompute(), CorpusDominanceAsConceptDisplayToLogical(), CorpusDominanceAsConceptGet(), CorpusDominanceAsConceptIsValid(), CorpusDominanceAsConceptLogicalToDisplay(), CorpusDominanceAsConceptNormalize(), CorpusDominanceAsConceptSQLCompute()

property CorpusDominanceAsRelation as %Numeric [ Calculated ];

Property methods: CorpusDominanceAsRelationCompute(), CorpusDominanceAsRelationDisplayToLogical(), CorpusDominanceAsRelationGet(), CorpusDominanceAsRelationIsValid(), CorpusDominanceAsRelationLogicalToDisplay(), CorpusDominanceAsRelationNormalize(), CorpusDominanceAsRelationSQLCompute()

property CorpusFrequency as %Integer [ Calculated ];

Property methods: CorpusFrequencyCompute(), CorpusFrequencyDisplayToLogical(), CorpusFrequencyGet(), CorpusFrequencyIsValid(), CorpusFrequencyLogicalToDisplay(), CorpusFrequencyNormalize(), CorpusFrequencySQLCompute()

property CorpusFrequencyAsConcept as %Integer [ Calculated ];

Property methods: CorpusFrequencyAsConceptCompute(), CorpusFrequencyAsConceptDisplayToLogical(), CorpusFrequencyAsConceptGet(), CorpusFrequencyAsConceptIsValid(), CorpusFrequencyAsConceptLogicalToDisplay(), CorpusFrequencyAsConceptNormalize(), CorpusFrequencyAsConceptSQLCompute()

property CorpusFrequencyAsRelation as %Integer [ Calculated ];

Property methods: CorpusFrequencyAsRelationCompute(), CorpusFrequencyAsRelationDisplayToLogical(), CorpusFrequencyAsRelationGet(), CorpusFrequencyAsRelationIsValid(), CorpusFrequencyAsRelationLogicalToDisplay(), CorpusFrequencyAsRelationNormalize(), CorpusFrequencyAsRelationSQLCompute()

property CorpusSpread as %Integer [ Calculated ];

Property methods: CorpusSpreadCompute(), CorpusSpreadDisplayToLogical(), CorpusSpreadGet(), CorpusSpreadIsValid(), CorpusSpreadLogicalToDisplay(), CorpusSpreadNormalize(), CorpusSpreadSQLCompute()

property CorpusSpreadAsConcept as %Integer [ Calculated ];

Property methods: CorpusSpreadAsConceptCompute(), CorpusSpreadAsConceptDisplayToLogical(), CorpusSpreadAsConceptGet(), CorpusSpreadAsConceptIsValid(), CorpusSpreadAsConceptLogicalToDisplay(), CorpusSpreadAsConceptNormalize(), CorpusSpreadAsConceptSQLCompute()

property CorpusSpreadAsRelation as %Integer [ Calculated ];

Property methods: CorpusSpreadAsRelationCompute(), CorpusSpreadAsRelationDisplayToLogical(), CorpusSpreadAsRelationGet(), CorpusSpreadAsRelationIsValid(), CorpusSpreadAsRelationLogicalToDisplay(), CorpusSpreadAsRelationNormalize(), CorpusSpreadAsRelationSQLCompute()

property DomainId as %Integer [ Required ];

Property methods: DomainIdDisplayToLogical(), DomainIdGet(), DomainIdIsValid(), DomainIdLogicalToDisplay(), DomainIdNormalize(), DomainIdSet()

property EntUniId as %Integer [ Required ];

Property methods: EntUniIdDisplayToLogical(), EntUniIdGet(), EntUniIdIsValid(), EntUniIdLogicalToDisplay(), EntUniIdNormalize(), EntUniIdSet()

property EntityValue as %String (MAXLEN = 2000);

Property methods: EntityValueDisplayToLogical(), EntityValueGet(), EntityValueIsValid(), EntityValueLogicalToDisplay(), EntityValueLogicalToOdbc(), EntityValueNormalize(), EntityValueSet()

Indexes

index (EntUni on DomainId,EntityValue) [Unique];

This Index only works for strings of up to 150 ($$$IKHASHIZE) characters

Index methods: EntUniCheck(), EntUniCheckUnique(), EntUniDelete(), EntUniExists(), EntUniFreqConExists(), EntUniFreqRelExists(), EntUniIdDisplayToLogical(), EntUniIdGet(), EntUniIdIsValid(), EntUniIdLogicalToDisplay(), EntUniIdNormalize(), EntUniIdSet(), EntUniOpen(), EntUniSQLCheckUnique(), EntUniSQLExists(), EntUniSQLFindPKeyByConstraint(), EntUniSQLFindRowIDByConstraint(), EntUniSpreadConExists(), EntUniSpreadRelExists()

index (EntUniFreqCon on DomainId,CorpusFrequencyAsConcept);

Index methods: EntUniFreqConExists()

index (EntUniFreqRel on DomainId,CorpusFrequencyAsRelation);

Index methods: EntUniFreqRelExists()

index (EntUniSpreadCon on DomainId,CorpusSpreadAsConcept);

Index methods: EntUniSpreadConExists()

index (EntUniSpreadRel on DomainId,CorpusSpreadAsRelation);

Index methods: EntUniSpreadRelExists()

index (PKINDEX on DomainId,EntUniId) [IdKey, PrimaryKey, Type = key, Unique];

Index methods: PKINDEXCheck(), PKINDEXDelete(), PKINDEXExists(), PKINDEXOpen(), PKINDEXSQLCheckUnique(), PKINDEXSQLExists(), PKINDEXSQLFindPKeyByConstraint(), PKINDEXSQLFindRowIDByConstraint()

Inherited Members

Inherited Methods

Storage

Storage Model: SQLStorage

Maps: 6

Map number 1 is named EntUni

thismap.Global: ^IRIS.IK.EntUni
Map number 2 is named EntUniFreqCon

thismap.Global: ^IRIS.IK.EntUniIdFreq

^IRIS.IK.EntUni({DomainId}," "_{EntityValue})

Node	Delimiter	Piece	Name
			EntUniId

Map number 3 is named EntUniFreqRel

thismap.Global: ^IRIS.IK.EntUniIdFreq

^IRIS.IK.EntUniIdFreq({DomainId},0,-{CorpusFrequencyAsConcept},{EntUniId})

Map number 4 is named EntUniSpreadCon

thismap.Global: ^IRIS.IK.EntUniIdSpread

^IRIS.IK.EntUniIdFreq({DomainId},1,-{CorpusFrequencyAsRelation},{EntUniId})

Map number 5 is named EntUniSpreadRel

thismap.Global: ^IRIS.IK.EntUniIdSpread

^IRIS.IK.EntUniIdSpread({DomainId},0,-{CorpusSpreadAsConcept},{EntUniId})

Map number 6 is named MainMap

thismap.Global: ^IRIS.IK.EntUniId

^IRIS.IK.EntUniIdSpread({DomainId},1,-{CorpusSpreadAsRelation},{EntUniId})

^IRIS.IK.EntUniId({DomainId},{EntUniId})

Node	Delimiter	Piece	Name
			EntityValue