Class %DeepSee.Time.Decade

class %DeepSee.Time.Decade extends %DeepSee.Time.AbstractLevel

This class implements a Decade level within a time dimension.
A decade is a group of ten years and is displayed in the format:
"1960s", "1990s".
The key value for a decades also has a trailing "s": &[1990s]

Inventory

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
		8

Summary

Methods
%AddToSaveSet	%BaseRangeToKey	%ClassIsLatestVersion	%ClassName
%ConstructClone	%Convert	%Count	%DispatchClassMethod
%DispatchGetModified	%DispatchGetProperty	%DispatchMethod	%DispatchSetModified
%DispatchSetMultidimProperty	%DispatchSetProperty	%Extends	%FormatToZDTCode
%GetAllMembers	%GetCalendar	%GetDimType	%GetLevelMembers
%GetName	%GetNthKey	%GetOptionList	%GetParameter
%GetPeriodLength	%GetRelatedKey	%IsA	%IsIndependent
%IsModified	%KeyToBaseRange	%KeyToValue	%New
%NormalizeObject	%ObjectModified	%OriginalNamespace	%PackageName
%RemoveFromSaveSet	%SerializeObject	%SetModified	%SupportsNOW
%ValidateObject	%ValueToKey

Methods

• classmethod %Convert(pTime As %DeepSee.Datatype.dateTime, pOffset As %String = "") as %Integer

Convert a $H value to the logical value used for this level. This is used within the computed field logic for properties within a fact table based on this level.
. In this case, we convert $H to the decade number. The decade number takes the form: 2000s,2010s.

• classmethod %GetLevelMembers(Output pList As %List, pCube As %String, pFact As %String, pStartRange As %Date, pEndRange As %Date, pTimeOffset As %String = "", pFormat As %String = "") as %Status

Return an array of members of this level.

• classmethod %GetName() as %String

Return the user-visible name of this level.

• classmethod %GetRelatedKey(Output pRelatedKey As %String, pCube As %String, pFact As %String, pKey As %String, pRelation As %String, pOffset As %Integer = "", pEndKey As %String = "", pTimeOffset As %String = "") as %Status

Return, via pRelatedKey a key within this level related to pKey.

• classmethod %KeyToBaseRange(pValue As %String, Output pStart As %Date, Output pEnd As %Date, pOffset As %String = "") as %Status

Convert a decade value (starting year of decade) into starting and ending base values (in $H format).

• classmethod %KeyToValue(pKey As %Integer, pFormat As %String = "", pOffset As %String = "") as %String

Convert a level key value to a display value.

• classmethod %SupportsNOW() as %Boolean

Return true if this level supports a NOW member.

• classmethod %ValueToKey(pValue As %String, pFormat As %String = "", pOffset As %String = "") as %Integer

Convert a level display value to its corresponding key value. Return "" if there is no corresponding key.

Class Reference IRIS for UNIX 2024.1.2
Documentation Search