IDimInstance

Assembly: Dimensions;

Description

The IDimInstance interface contains properties and methods used to access dictionary data.

Inheritance Hierarchy

IDimInstance

Comments

Classes of repository objects that support IDimInstance interface:

MetabaseObjectClass.KE_CLASS_ADOMDDIM. ADOMD dictionary.
MetabaseObjectClass.KE_CLASS_METADICTIONARYRDS. Table MDM dictionary.
MetabaseObjectClass.KE_CLASS_RDS_DICTIONARY. MDM dictionary.
MetabaseObjectClass.KE_CLASS_RDS_COMPDICTIONARY. Composite MDM dictionary.
MetabaseObjectClass.KE_CLASS_STDDIM. Table dictionary.
MetabaseObjectClass.KE_CLASS_CLNDIM. Calendar dictionary.
MetabaseObjectClass.KE_CLASS_USERDIM. Calculated dictionary.

To get dictionary data, for the corresponding repository object execute the IMetabaseObjectDescriptor.Open or IMetabaseObjectDescriptor.OpenWithParam method, and cast the execution result to the IDimInstance type.

When working with MDM dictionaries, when they are opened, values of system attributes and attributes used in unique and non-unique keys are loaded for elements. Values of custom attributes are loaded as soon as they are addressed, using properties and methods of the IDimAttributesInstance, IDimElements interfaces. The IDimAttributesInstance.EnsureValuesLoaded method can be used to load attribute values only for a specific element set. The loaded attributes are saved in memory and used for further work with a dictionary instance, which helps avoid repeated DBMS requests.

If attribute-based access control method is enabled in the repository, both system and custom attribute values are loaded on opening MDM dictionaries, except for imported attributes, attributes allowing for multiple values, and displayed values of linked attributes.

Wider opportunities for working with MDM dictionaries are provided by the IRdsDictionary, IRdsDictionaryInstance interfaces.

Properties

	Property name	Brief description
	AttributeHierarchies	The AttributeHierarchies property returns data collection of dictionary alternative hierarchies.
	Attributes	The Attributes property returns an object that contains a collection of dictionary attributes' values.
	Blocks	The Blocks property returns an object that contains a collection of dictionary blocks.
	BuilderException	The BuilderException property returns information on errors that may occur while opening the dictionary.
	DefaultElement	The DefaultElement property returns the default text index.
	Dimension	The Dimension property returns an object containing dictionary structure.
	Elements	The Elements property returns a collection of elements of a dictionary instance.
	ElementsByOrder	The ElementsByOrder property returns iterator to the dictionary element tree built taking into account custom sorting.
	Ident	The Ident property returns identifier of a repository dictionary.
	Indexes	The Indexes property returns an object that contains a collection of dictionary indexes.
	InstanceModel	The InstanceModel property returns a general model of dictionary.
	Key	The Key property returns key of repository dictionary.
	Levels	The Levels property returns an object that contains a collection of dictionary elements' levels.
	MetabaseObject	The MetabaseObject property returns dictionary data as repository object data.
	Name	The Name property returns name of repository dictionary.
	RootElements	The RootElements property returns an object that contains an array of dictionary elements stored at zero level.

Methods

	Method name	Brief description
	CreateSelection	The CreateSelection method creates an object containing dictionary selection.
	NewElement	The NewElement method creates an object that enables to work with a dimension element.
	NewElementsOrderSetup	The NewElementsOrderSetup method returns settings of dictionary elements custom sorting.