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

Inheritance diagram for RegistryMap:

[legend]

Collaboration diagram for RegistryMap:

[legend]

Public Member Functions
_.Library.String	CreateMapTimeStamp ()
	Return the current build time in hh:mm:ss format.

	Print ()
	Diagnostic method, prints information about the current map.

_.Library.Status	SaveToClass (pClassName)
	Serializes the current Registry structure into XML inside the. More...

_.Library.Status	ToArray (pGroups, pCubes, pBuildOrders, pLookup)
	Converts the current map into an array. More...

_.Library.Status	Validate ()
	Perform validation on the Map object to determine if it is ready for save.

Public Member Functions inherited from RegisteredObject
_.Library.Status	OnAddToSaveSet (_.Library.Integer depth, _.Library.Integer insert, _.Library.Integer callcount)
	This callback method is invoked when the current object is added to the SaveSet,. More...

_.Library.Status	OnClose ()
	This callback method is invoked by the <METHOD>Close</METHOD> method to. More...

_.Library.Status	OnConstructClone (_.Library.RegisteredObject object, _.Library.Boolean deep, _.Library.String cloned)
	This callback method is invoked by the <METHOD>ConstructClone</METHOD> method to. More...

_.Library.Status	OnNew ()
	This callback method is invoked by the <METHOD>New</METHOD> method to. More...

_.Library.Status	OnValidateObject ()
	This callback method is invoked by the <METHOD>ValidateObject</METHOD> method to. More...

Public Member Functions inherited from Adaptor
_.Library.Status	XMLExport (_.Library.String top, _.Library.String format, _.XML.Namespaces namespaces, attrs, _.Library.String createId, _.Library.String typeAttr, oreflist, idlist, _.Library.String initialIndent, _.Library.Boolean local, _.Net.MIMEPart mimeAttachments)
	Serialize an XML enabled class as an XML document and write. More...

_.Library.Status	XMLExportToStream (_.Stream.Object export, _.Library.String top, _.Library.String format, _.XML.Namespaces namespaces, attrs, _.Library.String createId, _.Library.String typeAttr, oreflist, idlist, _.Library.String initialIndent)
	Serialize an XML enabled class as an XML document and appends it to a stream. More...

_.Library.Status	XMLExportToString (_.Library.String export, _.Library.String top, _.Library.String format, _.XML.Namespaces namespaces, attrs, _.Library.String createId, _.Library.String typeAttr, oreflist, idlist, _.Library.String initialIndent)
	Serialize an XML enabled class as an XML document and write it to a string. More...

Static Public Member Functions
_.DeepSee.CubeManager.RegistryMap	LoadFromClass (_.Library.String pClassname, _.Library.Status pStatus)
	Deserialize the XML from the Registry XData block into a RegistryMap model.

Static Public Member Functions inherited from Adaptor
_.Library.Status	XMLDTD (_.Library.String top, _.Library.String format, _.Library.Boolean input, dtdlist)
	Write the DTD to the current device for this XML enabled class serialized as. More...

_.Library.RegisteredObject	XMLNew (_.XML.Document document, _.Library.Integer node, _.Library.RegisteredObject containerOref)
	Get an instance of an XML enabled class. More...

_.Library.Status	XMLSchema (_.Library.String top, _.Library.String format, _.Library.String namespacePrefix, _.Library.Boolean input, _.Library.Boolean refOnly, schema)
	Write an XML Schema fragment to the current device which describes an XML enabled class and dependent classes. More...

_.Library.String	XMLSchemaNamespace ()
	Get the namespace to which this class belongs for use in schema generation. More...

_.Library.Status	XMLSchemaType (_.XML.Schema schemaInstance, _.XML.Node node, _.Library.String top, _.Library.Boolean encoded, _.Library.Boolean summary, _.Library.Boolean input, _.Library.Boolean refOnly)
	Add a complexType to the schema that is respresented by an <class>XML.Schema</class> instance. More...

Public Attributes
	BuildStartHour
	The hour of the acceptable build window for the day,. More...

	BuildStartMinute
	The quater hour of the acceptable build window for the day,. More...

	Description
	Description of this registry definition. More...

	Disabled
	Disabled = true will suspend the automated Build and Synch tasks for this namespace. More...

	Groups
	The collection of groups that are defined in the overall sysem registry map. More...

	IndependentSync
	Controls whether cubes within a group are synchronized based on the relationship dependency (the default) More...

	SerialUpdates
	If this property is set to 1, the updater tasks will not job off the group update code. More...

	StorageClass
	When this is loaded into memory, this stores the name of the class. More...

Additional Inherited Members
Static Public Attributes inherited from RegisteredObject
	CAPTION = None
	Optional name used by the Form Wizard for a class when generating forms. More...

	JAVATYPE = None
	The Java type to be used when exported.

	PROPERTYVALIDATION = None
	This parameter controls the default validation behavior for the object. More...

Static Public Attributes inherited from Adaptor
	ATTRIBUTEQUALIFIED = None
	ATTRIBUTEQUALIFIED controls the format of exported XML by controlling whether attributes. More...

	ELEMENTQUALIFIED = None
	ELEMENTQUALIFIED controls the format of exported XML. More...

	NAMESPACE = None
	NAMESPACE specifies the XML namespace to be used when projecting the. More...

	SUPPRESSTYPEPREFIX = None
	SUPPRESSTYPEPREFIX allows the type name that refers to this class. More...

	XMLDEFAULTREFERENCE = None
	XMLDEFAULTREFERENCE specifies the default value of the XMLREFERENCE property parameter. More...

	XMLENABLED = None
	If this parameter is true then XML-enabling methods. More...

	XMLFORMAT = None
	The XMLFORMAT parameter controls the generation of the XMLExport and XMLImport. More...

	XMLIGNOREINVALIDATTRIBUTE = None
	The XMLIGNOREINVALIDATTRIBUTE parameter allows the programmer to control handling of unexpected. More...

	XMLIGNOREINVALIDTAG = None
	The XMLIGNOREINVALIDTAG parameter allows the programmer to control handling of unexpected. More...

	XMLIGNORENULL = None
	XMLIGNORENULL allows the programmer to override the default XML handling. More...

	XMLINCLUDEINGROUP = None
	XMLINCLUDEINGROUP allows the programmer to control whether a class is included. More...

	XMLINHERITANCE = None
	If the XMLINHERITANCE parameter is set to "LEFT", then in the case of multiple. More...

	XMLNAME = None
	This parameter provides the default XMLNAME for the class. More...

	XMLNIL = None
	The XMLNIL class parameter controls the use of xsi:nil by XMLExport. More...

	XMLNILNOOBJECT = None
	The XMLNILNOOBJECT parameter allows creation of an object to be skipped for elements. More...

	XMLPREFIX = None
	The XMLPREFIX parameter controls the prefix to be used for the XML namespace that. More...

	XMLSEQUENCE = None
	If the XMLSEQUENCE = 1, then the order of the XML elements must match the. More...

	XMLSUMMARY = None
	The summary fields to be used when an object is referenced are specified. More...

	XMLTYPE = None
	This parameter provides the default XMLTYPE for the class. More...

	XMLUNSWIZZLE = None
	If the XMLUNSWIZZLE parameter is set to 1, then single object. More...

	XMLUSEEMPTYELEMENT = None
	If the XMLUSEEMPTYELEMENT parameter is set to 1, then the empty element shorthand (<tag>) More...

Static Public Attributes inherited from Adaptor
	JSONENABLED
	If this parameter is true then JSON-enabling methods will be generated. More...

	JSONIGNOREINVALIDFIELD
	The JSONIGNOREINVALIDFIELD parameter allows the programmer to control handling of unexpected fields in the JSON input. More...

	JSONIGNORENULL
	JSONIGNORENULL allows the programmer to override the default handling of empty strings for string properties. More...

	JSONNULL
	If JSONNULL is true (=1), then unspecified properties are exported as the null value. More...

	JSONREFERENCE
	JSONREFERENCE specifies the default value of the JSONREFERENCE property parameter that specifies how to More...

Detailed Description

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

Member Function Documentation

◆ SaveToClass()

_.Library.Status SaveToClass ( pClassName )

Serializes the current Registry structure into XML inside the.

XData block in the relevant Registry class.

◆ ToArray()

_.Library.Status ToArray	(	pGroups,
		pCubes,
		pBuildOrders,
		pLookup
	)

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
<method>DeepSee.CubeManager.Utils.GetCubeGroups</method>(.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)

Member Data Documentation

◆ BuildStartHour

BuildStartHour

The hour of the acceptable build window for the day,.

used to construct the timestamp that defines the window when builds may be started.

◆ BuildStartMinute

BuildStartMinute

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.

◆ Description

Description

Description of this registry definition.

◆ Disabled

Disabled

Disabled = true will suspend the automated Build and Synch tasks for this namespace.

◆ Groups

Groups

The collection of groups that are defined in the overall sysem registry map.

◆ IndependentSync

IndependentSync

Controls whether cubes within a group are synchronized based on the relationship dependency (the default)

or if it synchronizes solely based on schedule.

◆ SerialUpdates

SerialUpdates

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.

◆ StorageClass

StorageClass

When this is loaded into memory, this stores the name of the class.

the map was loaded from.

Public Member Functions

Static Public Member Functions

Public Attributes

Additional Inherited Members