MSIModelData.h

Go to the documentation of this file.

//
//  ModelData.h
//  MicroStrategyMobile
//
//  Created by changlei pan on 7/30/12.
//  Copyright (c) 2012 MicroStrategy Inc. All rights reserved.
//

#import <Foundation/Foundation.h>
#import "DataProviderProtocol.h"
#import "Enums.h"
#import "MSTRHandler.h"
#import "Header.h"


typedef enum _DataProviderType{
    TabularDataType = 0, CrosstabDataType,RWControlDataType
}DPType;

@class MSIHeaderValue;
@class MSIMetricValue;
@class ThresholdSliderData;
@class MSIPropertyGroup;
@class MSIMetricValue;
@class MSIDataElement;
@class MSIDisplayInfo;

@interface TemplateMetricsPlaceHolder : MSIHeader
{
}
@property(nonatomic, assign) NSInteger depth;
@end


@protocol ModelDataProtocol<MSIDataProviderProtocol>
@optional
- (NSString*) getRowDisplayHTMLStringAtRow:(NSInteger)rowIndex columnTitleIndex:(NSInteger)titleIndex withDelimiter:(NSString*)delimeter;
- (NSString*) getRowDisplayStringAtRow:(NSInteger)rowIndex columnTitleIndex:(NSInteger)titleIndex withDelimiter:(NSString*)delimeter;
- (NSString*) getColDisplayStringAtColumn:(NSInteger)colIndex rowTitleIndex:(NSInteger)titleIndex withDelimiter:(NSString*)delimeter;
- (NSString*) getEntireColDisplayStringAtColumn:(NSInteger)colIndex withDelimiter:(NSString *)delimeter;
- (NSString*) getRowTitleDisplayString:(NSInteger)index;
- (NSString*) getColTitleDisplayString:(NSInteger)index;
- (MSIHeader*) getHeader:(MSIDataElement*)iDataElement;
@end


@interface MSIModelData : NSObject<ModelDataProtocol,MSTRHandler>
{
}

@property (nonatomic, assign) BOOL isFormatInfoShared;

@property (nonatomic, readonly) NSMutableArray* rowHeaderArray;
@property (nonatomic, readonly) NSMutableArray* rowTemplateUnitArray;
@property (nonatomic, readonly) NSMutableArray* colHeaderArray;
@property (nonatomic, readonly) NSMutableArray* colTemplateUnitArray;
@property (nonatomic, readonly) NSMutableArray* metricHeaderArray;
@property (nonatomic, readonly) NSMutableArray* arrayWithRowOffset;
@property (nonatomic, readonly) NSMutableArray* arrayWithColOffset;
@property (nonatomic, readonly) NSMutableArray* arrayWithRowOffsetForUnit;
@property (nonatomic, readonly) NSMutableArray* arrayWithColOffsetForUnit;



- (id)initWithIterator:(void*)ipIterator;
- (id)initWithIterator:(void *)ipIterator withSliceCountOnRow:(int)sliceCountOnRow andSliceCountOnCol:(int)sliceCountOnCol;

-(NSDictionary *) getVisualizationProperties;
- (MSIMetricValue*) allocMetricValueAtRow:(NSInteger)rowIndex atColumn:(NSInteger)colIndex;

- (MSIHeaderValue*) allocHeaderValueByAxisType:(AxisType)type andRowIndex:(NSInteger)row andColumnIndex:(NSInteger)col;

- (NSMutableArray*)arrayWithHeaderValueOfWholeRowByAxisType:(AxisType)iAxis andRowIndex:(NSInteger)row;

- (BOOL) isSubtotalCell:(MSIHeaderValue*)headerValue;

- (BOOL) isSubtotalRowWithAxisType:(AxisType)type andRowIndex:(NSInteger)row;

- (MSIHeader*) headerObjectByAxisType:(AxisType)type andColumnIndex:(NSInteger)col;
//- (Header*) headerObjectByIndex:(NSInteger)colIndex;
//- (Header*) headerObjectByColAxisIndex:(NSInteger)colIndex;

- (NSInteger)indexOfHeaderObject:(MSIHeader *)headerObject;

- (NSInteger)colAxisIndexOfHeaderObject:(MSIHeader *)headerObject;


- (NSInteger)rowCount;

- (NSInteger)columnCount;

- (NSInteger)metricColumnCount;

- (NSInteger)metricCount;

- (NSInteger) rowAxisHeaderCount;

- (NSInteger) rowAxisTemplateUnitCount;

- (NSInteger) colAxisHeaderCount;

- (NSInteger) colAxisTemplateUnitCount;

- (BOOL)isMetricInRowAxis;

- (BOOL) isTransactionEnabled;

- (BOOL) rowMarkedForTransactions;


- (BOOL) isEditableWithAxisType:(AxisType)AxisType RowIndex:(NSInteger)rowIndex columnIndex:(NSInteger)columnIndex;




- (NSString*) formatMetricValue:(double)iValue withMetricIndex:(int)iIndex;

// Returns the formatted metric value for the given index and column info without applying the threshold defined on it,colIndex count from the first metricColumn
//- (NSString*) formatRawMetricValueAtRowIndex:(NSInteger)row atColIndex:(NSInteger)col;
- (NSArray*)getThresholdsByMetricIndex:(int)index thresholdsSemanticType:(BaseFormSemanticType)SemanticType;
- (ThresholdSliderData*) getThresholdInfo:(NSString*)iMetricID defaultIndex:(int)index threshold:(BOOL*)oHasThresholdInfo;

/*TQMS 993032, for the case of threshold type = rank_top and rank_bottom, whether to ignore Subtotal rows maters when determining the max value of threshold. In Heatmap, we should not consider the subtotal rows, so I add an additional method here.
 */
- (ThresholdSliderData*) getThresholdInfo:(NSString*)iMetricID defaultIndex:(int)index threshold:(BOOL*)oHasThresholdInfo withIgnoreTotal:(BOOL)ignoreTotal;

- (MSIHeader*)headerObject:(MSIDisplayInfo*)object;

- (MSIDisplayInfo*) objectByID:(NSString*) objID;

//- (Header*) getHeader:(MSIDataElement*)iDataElement;

- (BOOL)isElementEqualWithAxisType:(int)iAxisType AtRow:(NSInteger)rowIndex andColumn:(NSInteger)colIndex withElement:(void*)element;

- (MSIHeaderValue *) getFirstHeaderElement:(MSIHeader*)iHeader;


- (NSString*) getDisplayStringWithAxisType:(AxisType)type AtRow:(NSInteger)rowIndex columnDepth:(NSInteger)depth withDelimiter:(NSString*)delimeter;

- (NSString*) getEntireColDisplayStringAtColumn:(NSInteger)colIndex withDelimiter:(NSString *)delimeter;

- (void) resetIterator:(void*) iterator;
- (BOOL) isSubtotalCellWithAxisType:(AxisType) iAxisType withOrdinal:(int) iOrdinal withDepth:(int) iDepth;

- (MSIHeaderValue*) allocHeaderValueAtRow:(NSInteger)rowIndex atColumn:(NSInteger)colIndex;//lishan manipulation

- (void)clearCachedData;

- (void) updateDataElementInCacheAtAxisType:(AxisType)type andRowIndex:(NSInteger)row andColumnIndex:(NSInteger)col;

/*
 D3 Widget Color By Attribute support
 */
- (void*) getDropZoneSet;
- (NSString*) getAttributeElementID:(AxisType)type withOrdinal:(NSInteger)rowIndex withDepth:(NSInteger)titleIndex;

@end