A node representing the named cube groupings within the registry. More...

Inheritance diagram for RegistryMapGroup:

[legend]

Collaboration diagram for RegistryMapGroup:

[legend]

Public Member Functions
_.Library.Status	ToArray (pGroup, pCubes, pBuildOrders)
	Convert this group object to array form. More...

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
_.Library.Status	BuildGroup (pGroupIndex, _.Library.Boolean pAsync, _.Library.Boolean pVerbose, _.Library.Boolean pIndexOnly, _.Library.Integer pMaxFacts, _.Library.Boolean pTracking, pUpdateAll, pBuildStats)
	This method walks through all cubes contained in the group and. More...

_.Library.Status	SynchronizeGroup (pGroupIndex, _.Library.Boolean pVerbose, _.Library.Integer pFactsUpdated, pUpdateAll, pSynchronizeStats, _.Library.Boolean pReadCommitted, _.Library.Boolean pCheckReferences, _.Library.Boolean pAsync)
	This method walks through all cubes contained in the group and. More...

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
	BuildAsynch
	GROUP DEFAULT - Flag which allows the user to select whether the build executes. More...

	BuildDayOfMonth
	If Month is selected as the BuildTimeUnit, this will allow the user to pick which day. More...

	BuildDayOfWeek
	If week is selected for the BuildTimeUnit, this will allow the user to pick which day. More...

	BuildFrequency
	GROUP DEFAULT - Indicates how often the cube is to be built, in units of. More...

	BuildTimeUnit
	GROUP DEFAULT - Base unit of time for cube builds. More...

	Cubes
	The collection of cubes that are a part of this group. More...

	Disabled
	GROUP DEFAULT - Disabled = 1 will block all automatic updates while leaving the. More...

	GroupName
	Display Name for the group. More...

	IsRegistered
	More...

	IsValid
	This group is checked for validity and the result is stored in this property. More...

	Map
	Reference to the parent map. More...

	SynchFrequency
	GROUP DEFAULT - Indicates how often the cube is to be synched, in units of. More...

	SynchTimeUnit
	GROUP DEFAULT - Base unit of time for cube synchs. More...

	UpdatePlan
	GROUP DEFAULT - Plan for how the cube is to be managed by the build/synch tasks. More...

Private Member Functions
_.Library.Status	OnNew (pRegGroupName)
	This callback automatically performs some of the property. 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

A node representing the named cube groupings within the registry.

Member Function Documentation

◆ OnNew()

_.Library.Status OnNew ( pRegGroupName )

private

This callback automatically performs some of the property.

settings as it is created for the RegistryMap

◆ BuildGroup()

_.Library.Status BuildGroup	(		pGroupIndex,
		_.Library.Boolean	pAsync,
		_.Library.Boolean	pVerbose,
		_.Library.Boolean	pIndexOnly,
		_.Library.Integer	pMaxFacts,
		_.Library.Boolean	pTracking,
			pUpdateAll,
			pBuildStats
	)

static

This method walks through all cubes contained in the group and.

checks to see if it should be updated. Prior to running the synchronize, this method will run the cube's Pre-Synch Code if present.
The cube will be built if any of these conditions are met:

The cube has not been built within the scheduled time period
It is the day of the week/month scheduled for the cube build
A cube is dependent on another cube that has been built in this cycle<br>
The pUpdateAll flag is set to 1

◆ SynchronizeGroup()

_.Library.Status SynchronizeGroup	(		pGroupIndex,
		_.Library.Boolean	pVerbose,
		_.Library.Integer	pFactsUpdated,
			pUpdateAll,
			pSynchronizeStats,
		_.Library.Boolean	pReadCommitted,
		_.Library.Boolean	pCheckReferences,
		_.Library.Boolean	pAsync
	)

static

This method walks through all cubes contained in the group and.

checks to see if it should be updated.
The cube will be synchronized if either of these conditions are met:

the cube has not been synchronized within the scheduled time period
a cube is dependent on another cube that has been synchronized in this cycle
The pUpdateAll flag is set to 1
and the Pre-Synchronization Code has not set the $$$AbortSynch token to 1

◆ ToArray()

_.Library.Status ToArray	(	pGroup,
		pCubes,
		pBuildOrders
	)

Convert this group object to array form.

This will match the index arrays returned using the call

<method>DeepSee.CubeManager.Utils.GetCubeGroups</method>(.pGroups,.pCubes,.pBuildOrders)
trimmed to the subset of only the cubes in this group

Member Data Documentation

◆ BuildAsynch

BuildAsynch

GROUP DEFAULT - Flag which allows the user to select whether the build executes.

synchronously or asynchronously. Asynchronous build is the default.

◆ BuildDayOfMonth

BuildDayOfMonth

If Month is selected as the BuildTimeUnit, this will allow the user to pick which day.

of the month this build should take place.

◆ BuildDayOfWeek

BuildDayOfWeek

If week is selected for the BuildTimeUnit, this will allow the user to pick which day.

of the week the build should take place.

◆ BuildFrequency

BuildFrequency

GROUP DEFAULT - Indicates how often the cube is to be built, in units of.

BuidTimeUnit

◆ BuildTimeUnit

BuildTimeUnit

GROUP DEFAULT - Base unit of time for cube builds.

◆ Cubes

Cubes

The collection of cubes that are a part of this group.

◆ Disabled

Disabled

GROUP DEFAULT - Disabled = 1 will block all automatic updates while leaving the.

cube visible in the registry.

◆ GroupName

GroupName

Display Name for the group.

◆ IsRegistered

IsRegistered

◆ IsValid

IsValid

This group is checked for validity and the result is stored in this property.

◆ Map

Map

Reference to the parent map.

◆ SynchFrequency

SynchFrequency

GROUP DEFAULT - Indicates how often the cube is to be synched, in units of.

SynchTimeUnit

◆ SynchTimeUnit

SynchTimeUnit

GROUP DEFAULT - Base unit of time for cube synchs.

◆ UpdatePlan

UpdatePlan

GROUP DEFAULT - Plan for how the cube is to be managed by the build/synch tasks.

Public Member Functions

Static Public Member Functions

Public Attributes

Private Member Functions

Additional Inherited Members