Class Reference
IRIS for UNIX 2024.1.2
InterSystems: The power behind what matters   
Documentation  Search
  [USER] >  [%DeepSee] >  [Model] >  [relationship]
Private  Storage   

class %DeepSee.Model.relationship extends %DeepSee.Model.node, %DeepSee.Model.source

Meta-data for a cube-to-cube relationship within a DeepSee cube.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
7 1


Summary

Properties
additionalDescription cardinality cube dependsOn
description disabled displayName factName
factNumber factSelectivity inverse isModified
linkClass linkProperty name nullReplacement
relatedCube sourceExpression sourceProperty

Methods
%AddToSaveSet %AtScaleConvertAggregate %AtScaleConvertTimeFunction %AtScaleConvertType
%AtScaleCreateMessageObj %AtScaleExport %AtScaleInitIndex %AtScaleProcessSourceRef
%AtScaleProduceAttribute %AtScaleProduceDataSet %BindExport %ClassIsLatestVersion
%ClassName %ConstructClone %DispatchClassMethod %DispatchGetModified
%DispatchGetProperty %DispatchMethod %DispatchSetModified %DispatchSetMultidimProperty
%DispatchSetProperty %Extends %GetParameter %IsA
%IsModified %New %NormalizeObject %ObjectModified
%OriginalNamespace %PackageName %QuoteList %QuoteValue
%QuoteValueL10N %RemoveFromSaveSet %SerializeObject %SetModified
%Validate %ValidateObject XMLDTD XMLExport
XMLExportToStream XMLExportToString XMLNew XMLSchema
XMLSchemaNamespace XMLSchemaType


Properties

• property cardinality as %DeepSee.Datatype.string(VALUELIST=",one,many",XMLPROJECTION="attribute");
Cardinality of this relationship.
If "one", then this relationship refers to one fact within the related cube.
If "many", then this relationship refers to many facts within the related cube.
• relationship cube as %DeepSee.Model.cube(XMLPROJECTION="none") [ Inverse = relationships,Cardinality = one ];
Cube that this relationship belongs to.
• property dependsOn as %DeepSee.Datatype.string(MAXLEN=32000,XMLPROJECTION="attribute");
If defined, this is an MDX expression identifying another level/relationship within this cube that this relationship depends on, e.g., "[Outlet].[H1].[City]"
This causes the following changes to this cube.
  1. An additional index is created based on the "master" level's fact and this relationship's fact.
  2. When the set of members for this level is produced it is filtered using this index.
• property factNumber as %DeepSee.Datatype.string(XMLPROJECTION="attribute");
Define a stable fact number for this relatinonship
• property inverse as %DeepSee.Datatype.entityName(XMLPROJECTION="attribute");
Name of the inverse relationship within the related cube.
• property nullReplacement as %DeepSee.Datatype.string(XMLPROJECTION="attribute");
Optional. If defined, this is used as the display value for any records that have no related item.
The nullReplacement property for the entire cube is ignored by relationships.
If not defined, then missing members will not be listed by queries.
• property relatedCube as %DeepSee.Datatype.entityName(XMLPROJECTION="attribute");
(Logical) Name of the cube this relationship refers to.

Methods

• method %Validate() as %Status
Test if this relationship's definition is valid.


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