IRISLIB database
QuarterNumber Class Reference

This class implements a Quarter number level within a time dimension. More...

Inheritance diagram for QuarterNumber:
Collaboration diagram for QuarterNumber:

Static Public Attributes

 CALENDAR = None
 This class implements a Quarter number 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 partial date value to the logical value used for this level. More...
 
_.Library.Integer Count (_.Library.String pCube, _.Library.Integer pDimNo, _.Library.Integer pHierNo, _.Library.Integer pLevelNo)
 Return the total number of members within 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. More...
 
_.Library.Boolean IsIndependent ()
 Return true if this time level is independent of the actual date.
 
_.Library.Status KeyToBaseRange (_.Library.String pValue, _.Library.Date pStart, _.Library.Date pEnd, _.Library.String pOffset)
 Convert a quarter value (year number) into starting and ending. More...
 
_.Library.String KeyToValue (_.Library.Integer pKey, _.Library.String pFormat, _.Library.String pOffset)
 Convert a level key value to a display value. More...
 
_.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 (Qn) 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 Quarter number level within a time dimension.

This represents the Quarter number (period of 3 months) independent of year.

Member Function Documentation

◆ Convert()

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

Convert a partial date 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 yyyy-mm-dd to a quarter period number: That is convert to 0,1,2,3, or 4.

Reimplemented from AbstractLevel.

◆ Count()

_.Library.Integer Count ( _.Library.String  pCube,
_.Library.Integer  pDimNo,
_.Library.Integer  pHierNo,
_.Library.Integer  pLevelNo 
)
staticprivate

Return the total number of members within this level.


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  pValue,
_.Library.Date  pStart,
_.Library.Date  pEnd,
_.Library.String  pOffset 
)
staticprivate

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

base values (in partial date format).
As this dimension is independent of year, we use year 2000 as the basis of calculations.

Reimplemented from AbstractLevel.

◆ KeyToValue()

_.Library.String KeyToValue ( _.Library.Integer  pKey,
_.Library.String  pFormat,
_.Library.String  pOffset 
)
staticprivate

Convert a level key value to a display value.

E.g., Q1

Reimplemented from AbstractLevel.

◆ ValueToKey()

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

Convert a level display value (Qn) 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 Quarter number level within a time dimension.

This represents the Quarter number (period of 3 months) independent of year.