Working with pplib++ Library

The pplib++ library is used to work with express reports, dashboards, time series databases of mobile application, as well as to present data sources, their dimensions, tables and to work with repositories.

Functions

Use

The pplib++ library uses classes and their "wrappings" with a smart index that deletes objects when they are no longer required. To mark "wrappings", the S character is entered before name of the class, for example, the SPPLDimension wrapping exists for the PPLDimension class.

Connecting the Library

Add the Dashboard, Datasources, ExpressAnalysis and Procedural folders with their contents to the project folder, these folders are contained in the static demo project MobileAnalysisDemo. For example, the Dashboard, ExpressAnalysis and Procedural folders can be retrieved from: components-*/prognoz-mobileappios/Sources/ to the Datasources folder in the following path: components-*/prognoz-mobileappios/Sources/ExpressAnalysis/Datasources.

Replace in the GridDataViewDatasource.m file of static example the code implementing the gridView:valueForHeaderForRow:number: and gridView:valueForHeaderForColumn:number: methods with the code fragment presented in the drop-down menu.

The code fragment to replace for the GridDataViewDataSource.m file

It is also necessary to replace extension of the GridDataViewDatasource.m file with .mm.

- (NSObject *)gridView:(NuGridView *)gridView valueForHeaderForRow:(NSInteger)row number:(NSInteger)number {
    SPPLPivotTableHeader leftTableHeader = m_pivotTable-&gt;leftHeader();
    SPPLPivotTableHeaderElements elements = leftTableHeader-&gt;elements();
    SPPLPivotTableHeaderElement element = elements-&gt;getElementByIndex(row);
    
    if (elements-&gt;isElementInTotals(element)) {
        SPPLPivotTableTotalsHeaderElement totalsElement = element-&gt;qClass&lt;PPLPivotTableTotalsHeaderElement&gt;();
        NSString *pattern = [self namePatternByTotalType:totalsElement-&gt;type()];
        if (totalsElement-&gt;isByLevelsTotals()) {
            NSString *levelText = NSLocalizedString(@&quot;Level&quot;, @&quot;Level&quot;);
            return [NSString stringWithFormat:@&quot;%@ (%@ %d)&quot;, pattern, levelText,totalsElement-&gt;level()];
        }
        else {
            if (element-&gt;correspondingDimensionElements() != NULL &amp;&amp; element-&gt;correspondingDimensionElements()-&gt;count() &gt; 0) {
                SPPLDimensionElement lastParentElement = element-&gt;correspondingDimensionElements()-&gt;lastObject&lt;PPLDimensionElement&gt;();
                return [NSString stringWithFormat:@&quot;%@ (%@)&quot;, pattern, lastParentElement-&gt;name()-&gt;nsString()];
            }
            else {
                return pattern;
            }
        }
    }
    else if (elements-&gt;isElementCalculated(element)) {
        SPPLPivotTableCalculatedHeaderElement calculatedElement = element-&gt;qClass&lt;PPLPivotTableCalculatedHeaderElement&gt;();
        // Get container of settings of calculated series
        SPPLPivotTableCalculatorSettings settings = m_pivotTable-&gt;calculatorSettings();
        if (settings != nil) {
            // Create a copy of container settings of calculated series
            settings = settings-&gt;copy()-&gt;qClass&lt;PPLPivotTableCalculatorSettings&gt;();
            // Delete all settings from the current container of calculated series
            if (settings-&gt;settingsCount() &gt; 0) {
                SPPLPivotTableCalculatorSetting setting = settings-&gt;setting(0);
                settings-&gt;removeSetting(setting);
            }
            } else {
            // Create a new container of calculated series settings
            settings = new PPLPivotTableCalculatorSettings();
        }
        // Add a setting to the container of calculated series settings
        settings-&gt;addSetting(calculatedElement-&gt;calculatorSetting());
        
        NSString *pattern = [self namePatternByCalculatorType:settings-&gt;setting(0)-&gt;type()];
        SPPLPivotTableHeaderElement parentElement = elements-&gt;getParentElement(element);
        SPPLDimensionElement lastParentElement = parentElement-&gt;correspondingDimensionElements()-&gt;lastObject&lt;PPLDimensionElement&gt;();
        return [NSString stringWithFormat:@&quot;%@ (%@)&quot;, pattern, lastParentElement-&gt;name()-&gt;nsString()];
    }
    else {
        SNArray correspondingDimensionElements = element-&gt;correspondingDimensionElements();
        if (correspondingDimensionElements-&gt;count() &gt; number) {
            SPPLDimensionElement dimensionElement = correspondingDimensionElements-&gt;objectAtIndex&lt;PPLDimensionElement&gt;(number);
            return dimensionElement-&gt;name()-&gt;nsString();
        }
        else {
            return nil;
        }
    }
}
- (NSObject *)gridView:(NuGridView *)gridView valueForHeaderForColumn:(NSInteger)column number:(NSInteger)number {
    if (column == SPARKLINE_COLUMN_NUMBER) {
        return NSLocalizedString(@&quot;Sparklines&quot;, @&quot;Sparklines&quot;);
    }
    else {
        SPPLPivotTableHeader topTableHeader = m_pivotTable-&gt;topHeader();
        SPPLPivotTableHeaderElements elements = topTableHeader-&gt;elements();
        SPPLPivotTableHeaderElement element = elements-&gt;getElementByIndex(column);
        
        if (elements-&gt;isElementInTotals(element)) {
            // Create final element of table header
            SPPLPivotTableTotalsHeaderElement qElement = element-&gt;qClass&lt;PPLPivotTableTotalsHeaderElement&gt;();
            SPPLPivotTableTotalsHeaderElement totalsElement = PPLPivotTableTotalsHeaderElement::totalsHeaderElement(element-&gt;correspondingDimensionElements(), NULL, qElement-&gt;type(), qElement-&gt;totalsIndex(), 0, qElement-&gt;level());
            // Get template for naming of final element of table header
            NSString *pattern = [self namePatternByTotalType:totalsElement-&gt;type()];
            // Check if totals are calculated by dimension levels
            if (totalsElement-&gt;isByLevelsTotals()) {
                NSString *levelText = NSLocalizedString(@&quot;Level&quot;, @&quot;Level&quot;);
                return [NSString stringWithFormat:@&quot;%@ (%@ %d)&quot;, pattern, levelText,totalsElement-&gt;level()];
            }
            else {
                if (element-&gt;correspondingDimensionElements() != NULL &amp;&amp; element-&gt;correspondingDimensionElements()-&gt;count() &gt; 0) {
                    SPPLDimensionElement lastParentElement = element-&gt;correspondingDimensionElements()-&gt;lastObject&lt;PPLDimensionElement&gt;();
                    return [NSString stringWithFormat:@&quot;%@ (%@)&quot;, pattern, lastParentElement-&gt;name()-&gt;nsString()];
                }
                else {
                    return pattern;
                }
            }
        }
        else if (elements-&gt;isElementCalculated(element)) {
            // Cast the element to the PPLPivotTableCalculatedHeaderElement type
            SPPLPivotTableCalculatedHeaderElement qElement = element-&gt;qClass&lt;PPLPivotTableCalculatedHeaderElement&gt;();
            // Determine calculated element  settings
            SPPLPivotTableCalculatorMutableSetting calculatorSetting = new PPLPivotTableCalculatorMutableSetting();
            // Set type of calculated series of data table
            calculatorSetting-&gt;setType(qElement-&gt;calculatorSetting()-&gt;type());
            // Set table header element that corresponds to row or column of the calculated series
            calculatorSetting-&gt;setRelatedTableElement(element);
            // Set calculated element index
            calculatorSetting-&gt;setRelatedData(NNumber::numberWithInteger(qElement-&gt;calculatorIndex()));
            // Create a new calculated element of header based on current eleent settings
            SPPLPivotTableCalculatedHeaderElement calculatedElement = PPLPivotTableCalculatedHeaderElement::calculatedHeaderElement(calculatorSetting-&gt;relatedTableElement(), calculatorSetting, calculatorSetting-&gt;relatedData&lt;NNumber&gt;()-&gt;integerValue());
            
            NSString *pattern = [self namePatternByCalculatorType:calculatorSetting-&gt;type()];
            SPPLPivotTableHeaderElement parentElement = elements-&gt;getParentElement(element);
            SPPLDimensionElement lastParentElement = parentElement-&gt;correspondingDimensionElements()-&gt;lastObject&lt;PPLDimensionElement&gt;();
            return [NSString stringWithFormat:@&quot;%@ (%@)&quot;, pattern, lastParentElement-&gt;name()-&gt;nsString()];
        }
        else {
            SNArray correspondingDimensionElements = element-&gt;correspondingDimensionElements();
            if (correspondingDimensionElements-&gt;count() &gt; number) {
                SPPLDimensionElement dimensionElement = correspondingDimensionElements-&gt;objectAtIndex&lt;PPLDimensionElement&gt;(number);
                return dimensionElement-&gt;name()-&gt;nsString();
            }
            else {
                return nil;
            }
        }
    }
}

Add links to the following platforms and library in the project settings:
- CFNetwork.framework.
- libsqlite3.dylib;.
- MapKit.framework.
- MessageUI.framework.
- MobileAnalysis.framework.
- OpenGLES.framework.
- SystemConfiguration.framework..
NOTE. To connect platforms and libraries, go to the Build Phases tab in project purpose settings, open the Link Binary With Libraries section and add the specified platforms and libraries to the list.
Specify the path to header files of the MobileAnalysis.framework platform in project purpose settings User Header Search Paths (for example, $(SRCROOT)/../Frameworks/MobileAnalysis.framework/Headers).

NOTE. Project purpose settings are located on the Build Settings tab.
In the project purpose settings specify the YES value for the Mismatched Return Type parameter.
In the project purpose settings specify the C++ 11 [-std=c++11] value for the C++ Language Dialect parameter.
In the project purpose settings specify the libc++ (LLVM C++ standard library with C++11 support) value for the C++ Standard Library parameter.
In the project purpose settings specify the YES value for the Enable C++ Exceptions parameter.
In the project purpose settings specify the NO value for the Enable C++ Runtime Types parameter.
Make sure that the Objective-C Automatic Reference Counting option is disabled in the project purpose settings.
Add the following folders with their contents into the project:
- ClassFactory.
- Resources.
In the project purpose specify the -ObjC value in the Other Linker Flags setting.

After the pplib++ library is connected, a set of classes is available. Examples showing work with the library are given in the Examples of pplib++ Library Use section.