IRISLIB database
MonthYear Class Reference

This class implements a Month level within a time dimension. More...

Inheritance diagram for MonthYear:
Collaboration diagram for MonthYear:

Static Public Attributes

 CALENDAR = None
 This class implements a Month level within a time dimension. More...
 
- Static Public Attributes inherited from AbstractLevel
 DIMTYPE = None
 Type reported back to the UI. More...
 
 OPTIONLIST = None
 This is a comma-delimited list of user-settable options for this. More...
 
- 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 Private Member Functions

_.Library.Integer Convert (_.DeepSee.Datatype.dateTime pTime, _.Library.String pTimeOffset)
 Convert a $H value to the logical value used for this level. More...
 
_.Library.Status GetLevelMembers (_.Library.List pList, _.Library.String pCube, _.Library.String pFact, _.Library.Date pStartRange, _.Library.Date pEndRange, _.Library.String pTimeOffset, _.Library.String pFormat)
 Return an array of members of this level.
 
_.Library.String GetName ()
 Return the user-visible name of this level.
 
_.Library.Status GetRelatedKey (_.Library.String pRelatedKey, _.Library.String pCube, _.Library.String pFact, _.Library.String pKey, _.Library.String pRelation, _.Library.Integer pOffset, _.Library.String pEndKey, _.Library.String pTimeOffset)
 Return, via pRelatedKey, a key within this level related to pKey. More...
 
_.Library.Status KeyToBaseRange (_.Library.String pKey, _.Library.Date pStart, _.Library.Date pEnd, _.Library.String pOffset)
 Convert a month-year value (month-year number) into starting and ending. More...
 
_.Library.String KeyToValue (_.Library.Integer pKey, _.Library.String pFormat, _.Library.String pTimeOffset)
 Convert a level key value to a display value.
 
_.Library.Boolean SupportsNOW ()
 Return true if this level supports a NOW member.
 
_.Library.Integer ValueToKey (_.Library.String pValue, _.Library.String pFormat, _.Library.String pOffset)
 Convert a level display value to its corresponding key value. More...
 

Additional Inherited Members

- 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...
 

Detailed Description

This class implements a Month level within a time dimension.

This represents a specific month within a specific year.

Member Function Documentation

◆ Convert()

_.Library.Integer Convert ( _.DeepSee.Datatype.dateTime  pTime,
_.Library.String  pTimeOffset 
)
staticprivate

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 a logical year+month number: That is, Year+Month in the form YYYYMM

Reimplemented from AbstractLevel.

◆ GetRelatedKey()

_.Library.Status GetRelatedKey ( _.Library.String  pRelatedKey,
_.Library.String  pCube,
_.Library.String  pFact,
_.Library.String  pKey,
_.Library.String  pRelation,
_.Library.Integer  pOffset,
_.Library.String  pEndKey,
_.Library.String  pTimeOffset 
)
staticprivate

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


Reimplemented from AbstractLevel.

◆ KeyToBaseRange()

_.Library.Status KeyToBaseRange ( _.Library.String  pKey,
_.Library.Date  pStart,
_.Library.Date  pEnd,
_.Library.String  pOffset 
)
staticprivate

Convert a month-year value (month-year number) into starting and ending.

base values (in $H format).

Reimplemented from AbstractLevel.

◆ ValueToKey()

_.Library.Integer ValueToKey ( _.Library.String  pValue,
_.Library.String  pFormat,
_.Library.String  pOffset 
)
staticprivate

Convert a level display value to its corresponding key value.

Return "" if there is no corresponding key.

Reimplemented from AbstractLevel.

Member Data Documentation

◆ CALENDAR

CALENDAR = None
static

This class implements a Month level within a time dimension.

This represents a specific month within a specific year.