Class Reference
IRIS for UNIX 2019.2
InterSystems: The power behind what matters   
Documentation  Search
  [ENSLIB] >  [%DeepSee] >  [CubeManager] >  [RegistryMap]
Private  Storage   

class %DeepSee.CubeManager.RegistryMap extends %RegisteredObject, %XML.Adaptor

The class responsible for organizing the information about the registered state of all cubes on the system.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
9 9


Summary

Properties
BuildStartHour BuildStartMinute Description Disabled
Groups IndependentSync SerialUpdates StorageClass

Methods
%AddToSaveSet %ClassIsLatestVersion %ClassName %ConstructClone
%DispatchClassMethod %DispatchGetModified %DispatchGetProperty %DispatchMethod
%DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty %Extends
%GetParameter %IsA %IsModified %New
%NormalizeObject %ObjectModified %OriginalNamespace %PackageName
%RemoveFromSaveSet %SerializeObject %SetModified %ValidateObject
CreateMapTimeStamp LoadFromClass Print SaveToClass
ToArray Validate XMLDTD XMLExport
XMLExportToStream XMLExportToString XMLNew XMLSchema
XMLSchemaNamespace XMLSchemaType


Properties

• property BuildStartHour  [ InitialExpression = "21" ];
The hour of the acceptable build window for the day, used to construct the timestamp that defines the window when builds may be started.
• property BuildStartMinute  [ InitialExpression = "00" ];
The quater hour of the acceptable build window for the day, used to construct the timestamp that defines the window when builds may be started.
• property Description as %String(MAXLEN=2500);
Description of this registry definition.
• property Disabled as %ZEN.Datatype.boolean;
Disabled = true will suspend the automated Build and Synch tasks for this namespace.
• relationship Groups as %DeepSee.CubeManager.RegistryMapGroup [ Inverse = Map,Cardinality = many ];
The collection of groups that are defined in the overall sysem registry map
• property IndependentSync as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
Controls whether cubes within a group are synchronized based on the relationship dependency (the default) or if it synchronizes solely based on schedule.
• property SerialUpdates as %ZEN.Datatype.boolean [ InitialExpression = 1 ];
If this property is set to 1, the updater tasks will not job off the group update code and will instead run all updates in a single process.
• property StorageClass as %String(XMLPROJECTION="NONE");
When this is loaded into memory, this stores the name of the class the map was loaded from.

Methods

• method CreateMapTimeStamp() as %String
Return the current build time in hh:mm:ss format.
• classmethod LoadFromClass(pClassname As %String, Output pStatus As %Status) as %DeepSee.CubeManager.RegistryMap
Deserialize the XML from the Registry XData block into a RegistryMap model.
• method Print()
Diagnostic method, prints information about the current map.
• method SaveToClass(pClassName="") as %Status
Serializes the current Registry structure into XML inside the XData block in the relevant Registry class.
• method ToArray(ByRef pGroups, ByRef pCubes, ByRef pBuildOrders, ByRef pLookup) as %Status
Converts the current map into an array. If this is the full {registered}U{unregistered} map, the first three arrays will match those returned using the call
%DeepSee.CubeManager.Utils.GetCubeGroups(.pGroups,.pCubes,.pBuildOrders)
This method also returns a special lookup index which can be used to quickly reference the group or cube objects contained in the current map object.
	Set CubeName = "HOLEFOODS"
	Set Map = ##class(%DeepSee.CubeManager.Utils).BuildRegistryMap()
	Do Map.ToArray(.Groups,.Cubes,.BuildOrders,.Lookup)
	Set GroupIdx = $LG(Lookup("cubes",CubeName),1)
	Set CubeIdx = $LG(Lookup("cubes",CubeName),2)
	Set Cube = Map.Groups.GetAt(GroupIdx).Cubes.GetAt(CubeIdx)
• method Validate() as %Status
Perform validation on the Map object to determine if it is ready for save.


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