This is documentation for Caché & Ensemble.

For information on converting to InterSystems IRIS, see the InterSystems IRIS Adoption Guide and the InterSystems IRIS In-Place Conversion Guide, both available on the WRC Distributions page (login required).

Home > Class Reference > %SYS namespace > %iFind.Entity

%iFind.Entity

persistent class %iFind.Entity extends %Library.Persistent

SQL Table Name: %iFind.Entity

This table contains all entities identified by iFind Semantic or Analytic indices in this namespace using namespace-wide shared storage (cf the IFINDSHAREDSTORAGELOCATION parameter in %iFind.Index.Basic).

Property Inventory

Method 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 EntityId as %Integer [ Required ];
Property methods: EntityIdDisplayToLogical(), EntityIdGet(), EntityIdIsValid(), EntityIdLogicalToDisplay(), EntityIdNormalize(), EntityIdSet(), EntityIdxCheck(), EntityIdxDelete(), EntityIdxExists(), EntityIdxOpen(), EntityIdxSQLCheckUnique(), EntityIdxSQLExists(), EntityIdxSQLFindPKeyByConstraint(), EntityIdxSQLFindRowIDByConstraint()
property StrippedEntityId as %iFind.Entity [ Calculated ];
Calculated property returning the entity ID of the entity corresponding to this row, with all words stripped of leading and trailing punctuation. If no such entity exists, this record's entity ID is returned.
Property methods: StrippedEntityIdCompute(), StrippedEntityIdGet(), StrippedEntityIdGetObject(), StrippedEntityIdGetObjectId(), StrippedEntityIdSQLCompute()
property Value as %String (COLLATION = "EXACT");
String value for this entity
Property methods: ValueDisplayToLogical(), ValueGet(), ValueIdxCheck(), ValueIdxCheckUnique(), ValueIdxDelete(), ValueIdxExists(), ValueIdxOpen(), ValueIdxSQLCheckUnique(), ValueIdxSQLExists(), ValueIdxSQLFindPKeyByConstraint(), ValueIdxSQLFindRowIDByConstraint(), ValueIsValid(), ValueLogicalToDisplay(), ValueLogicalToOdbc(), ValueNormalize(), ValueSet()

Methods

classmethod GetEntityId(pValue As %String) as %Integer [ SQLProc = GetEntityId ]
Returns the Entity ID corresponding to the supplied string
classmethod GetStrippedEntityId(pEntity As %String, pOriginalId As %Integer = "", pKeepChars As %String = $$$STRIPKEEP) as %Integer [ SQLProc = GetStrippedEntityId ]
Returns the Entity ID corresponding to the supplied string, after stripping off punctuation. If no such entity exists, pOriginalId is returned.

Indexes

index (EntityIdx on EntityId) [IdKey, PrimaryKey, Type = key, Unique];
Index methods: EntityIdxCheck(), EntityIdxDelete(), EntityIdxExists(), EntityIdxOpen(), EntityIdxSQLCheckUnique(), EntityIdxSQLExists(), EntityIdxSQLFindPKeyByConstraint(), EntityIdxSQLFindRowIDByConstraint()
index (ValueIdx on Value) [Type = key, Unique];
Index methods: ValueIdxCheck(), ValueIdxCheckUnique(), ValueIdxDelete(), ValueIdxExists(), ValueIdxOpen(), ValueIdxSQLCheckUnique(), ValueIdxSQLExists(), ValueIdxSQLFindPKeyByConstraint(), ValueIdxSQLFindRowIDByConstraint()

Inherited Members

Inherited Methods

Storage

Storage Model: CacheSQLStorage

Maps: 2

FeedbackOpens in a new window