Package com.activeviam.activepivot.copper.api

Interface CopperParentValueMeasure

All Superinterfaces:

CopperElement, CopperMeasure, ICanHaveFolder<CopperMeasure>, ICanHaveFormatter<CopperMeasure>, ICanHide<CopperMeasure>, Publishable<CopperMeasure>

All Known Implementing Classes:

DrillupMeasure

public interface CopperParentValueMeasure
extends CopperMeasure

Interface for representing a CopperMeasure which returns the value of its underlying measure for the parent member on the given hierarchy. It gives access to specific methods.

See Also:

• CopperMeasure.parentValueOn(CopperHierarchy, int)

Method Summary

Modifier and Type	Method	Description
CopperMeasure	nullAtTopLevels()	Returns a modified measure that will return null when the shift operation is performed above the top levels.

Methods inherited from interface com.activeviam.activepivot.copper.api.CopperMeasure

as, divide, filter, grandTotal, grandTotalExcluding, map, mapToBoolean, mapToDouble, mapToFloat, mapToInt, mapToLong, minus, multiply, parentValueOn, parentValueOn, per, plus, shift, totalOn, visible, withDescription, withMeasureGroup, withName, withXmlaAggregator

Methods inherited from interface com.activeviam.activepivot.core.intf.api.description.builder.ICanHaveFolder

withinFolder

Methods inherited from interface com.activeviam.activepivot.core.intf.api.description.builder.ICanHaveFormatter

withFormatter

Methods inherited from interface com.activeviam.activepivot.core.intf.api.description.builder.ICanHide

hidden, isVisible

Methods inherited from interface com.activeviam.activepivot.core.intf.api.copper.Publishable

publish

Method Details

nullAtTopLevels

CopperMeasure nullAtTopLevels()

Returns a modified measure that will return null when the shift operation is performed above the top levels.

The measure will return the parent value on the given hierarchy, but will return null when the read location of the parentValue measure is situated one or more degrees above the top level of the shifted hierarchy.

As an example, let us consider a slicing Date hierarchy containing three levels Year, Month, Day:

 ┌────────────────┬───────┬───────────────┬────────────────────────┐
 │ Year/Month/Day │ m.SUM │ parent(m.SUM) │ parent(m.SUM)nullAtTop │
 ├────────────────┼───────┼───────────────┼────────────────────────┤
 │2019            │    75 │            75 │                   null │
 │       7        │    35 │            75 │                     75 │
 │           2    │    20 │            35 │                     35 │
 │           1    │    15 │            35 │                     35 │
 │       6        │    40 │            75 │                     75 │
 │           1    │    25 │            40 │                     40 │
 │           2    │    15 │            40 │                     40 │
 │2018            │    35 │            75 │                   null │
 │       7        │    15 │            35 │                     35 │
 │           1    │     5 │            15 │                     15 │
 │           2    │    10 │            15 │                     15 │
 │       6        │    20 │            35 │                     35 │
 │           1    │    15 │            20 │                     20 │
 │           2    │     5 │            20 │                     20 │
 └────────────────┴───────┴───────────────┴────────────────────────┘
 

Returns:

The modified parent value measure