Package com.activeviam.builders

Class SimplePreAggregatedMeasureBuilder

java.lang.Object

com.activeviam.builders.SimplePreAggregatedMeasureBuilder

All Implemented Interfaces:

ICanStartBuildingDimensions, ICanStartBuildingQueryCube, ICanHaveFolder<ICanStartBuildingMeasures.ICanBuildPreAggregatedMeasureBuilder>, ICanHaveFormatter<ICanStartBuildingMeasures.ICanBuildPreAggregatedMeasureBuilder>, ICanHaveMeasureGroup<ICanStartBuildingMeasures.ICanBuildPreAggregatedMeasureBuilder>, ICanHaveProperty<ICanStartBuildingMeasures.ICanBuildPreAggregatedMeasureBuilder>, ICanHide<ICanStartBuildingMeasures.ICanBuildPreAggregatedMeasureBuilder>, ICanStartBuildingMeasures, ICanStartBuildingMeasures.ICanBuildPreAggregatedMeasureBuilder, ICanStartBuildingMeasures.IPreAggregatedMeasureBuilder, ICanStartBuildingMeasures.IPreAggregatedMeasureBuilderWithField, ICubeDescriptionBuilder.INamedCubeDescriptionBuilder, IHasAtLeastOneMeasure

public class SimplePreAggregatedMeasureBuilder
extends Object
implements ICanStartBuildingMeasures.IPreAggregatedMeasureBuilder, ICanStartBuildingMeasures.IPreAggregatedMeasureBuilderWithField, ICanStartBuildingMeasures.ICanBuildPreAggregatedMeasureBuilder

Nested Class Summary

Nested classes/interfaces inherited from interface com.activeviam.desc.build.dimensions.ICanStartBuildingDimensions

ICanStartBuildingDimensions.DimensionsAdder

Nested classes/interfaces inherited from interface com.activeviam.desc.build.ICanStartBuildingMeasures

ICanStartBuildingMeasures.BuildablePostProcessorBuilder, ICanStartBuildingMeasures.ICanBuildPreAggregatedMeasureBuilder, ICanStartBuildingMeasures.INativeMeasureBuilder, ICanStartBuildingMeasures.IPostProcessorBuilder, ICanStartBuildingMeasures.IPreAggregatedMeasureBuilder, ICanStartBuildingMeasures.IPreAggregatedMeasureBuilderWithField

Constructor Summary

Constructors

Constructor	Description
SimplePreAggregatedMeasureBuilder(Function<IAggregatedMeasureDescription,IHasAtLeastOneMeasure> resultConsumer)	Constructor for build start.
SimplePreAggregatedMeasureBuilder(Function<IAggregatedMeasureDescription,IHasAtLeastOneMeasure> resultConsumer, BaseMeasureBuilder base, String field, String aggregationFunction, Properties properties)	Constructor for build iterations.

Method Summary

Modifier and Type	Method	Description
IQueryCubeDescriptionBuilder	asQueryCube()	Starts creating a query cube on top of the existing description.
ICanStartBuildingMeasures.ICanBuildPreAggregatedMeasureBuilder	isVisible(boolean visibility)	Changes the visibility of this item.
ICanStartBuildingMeasures.IPreAggregatedMeasureBuilder	withAggregatedMeasure()	Starts building a pre-aggregated measure.
IHasAtLeastOneMeasure	withAggregatedMeasure(IBasicAggregatedMeasureDescription description)	Adds the description for a measure.
ICanStartBuildingMeasures.ICanBuildPreAggregatedMeasureBuilder	withAggregationFunction(String aggregationFunctionPluginKey)	Chooses the aggregation function.
IHasAtLeastOneMeasure	withCalculations(Consumer<ICopperContext> calculations)	Adds multiple measures and hierarchies via the Copper API.
ICanStartBuildingMeasures.INativeMeasureBuilder	withContributorsCount()	Starts customizing the IMeasureHierarchy.COUNT_ID native measure.
IDimensionBuilder	withDimension(String name)	Start building a dimension.
ICanBuildCubeDescription<IActivePivotInstanceDescription>	withDimensions(ICanStartBuildingDimensions.DimensionsAdder adder)	Integrates the dimensions built by a separate function.
ICanStartBuildingMeasures.IPreAggregatedMeasureBuilderWithField	withField(String field)	Chooses the field to aggregate.
ICanStartBuildingMeasures.ICanBuildPreAggregatedMeasureBuilder	withFormatter(String formatter)	Sets the formatter of the component.
ICanStartBuildingMeasures.ICanBuildPreAggregatedMeasureBuilder	withinFolder(String folder)	Sets the folder of the component.
ICanStartBuildingMeasures.ICanBuildPreAggregatedMeasureBuilder	withMeasureGroups(String... groups)	Sets the measure group of the component.
ICanStartBuildingMeasures.ICanBuildPreAggregatedMeasureBuilder	withName(String name)	Change the name of the measure.
IHasAtLeastOneMeasure	withPostProcessor(IPostProcessorDescription description)	Adds the description for a post-processor.
ICanStartBuildingMeasures.IPostProcessorBuilder	withPostProcessor(String name)	Adds the description for a post-processor.
ICanStartBuildingMeasures.ICanBuildPreAggregatedMeasureBuilder	withProperty(String key, String value)	Puts a property to initialize the component.
ICanStartBuildingMeasures.INativeMeasureBuilder	withUpdateTimestamp()	Starts customizing the IMeasureHierarchy.TIMESTAMP_ID native measure.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.activeviam.desc.build.ICanHide

hidden

Methods inherited from interface com.activeviam.desc.build.dimensions.ICanStartBuildingDimensions

withSingleLevelDimension, withSingleLevelDimensions, withSingleLevelDimensions

Methods inherited from interface com.activeviam.desc.build.ICanStartBuildingMeasures

withMeasures

Methods inherited from interface com.activeviam.desc.build.ICanStartBuildingMeasures.IPreAggregatedMeasureBuilder

avg, max, min, sum

Methods inherited from interface com.activeviam.desc.build.ICanStartBuildingMeasures.IPreAggregatedMeasureBuilderWithField

avg, grossSum, longSum, max, min, shortSum, squareSum, sum

Constructor Detail

SimplePreAggregatedMeasureBuilder

public SimplePreAggregatedMeasureBuilder(Function<IAggregatedMeasureDescription,IHasAtLeastOneMeasure> resultConsumer)

Constructor for build start.

Parameters:

resultConsumer - The result consumer.

SimplePreAggregatedMeasureBuilder

public SimplePreAggregatedMeasureBuilder(Function<IAggregatedMeasureDescription,IHasAtLeastOneMeasure> resultConsumer,
                                         BaseMeasureBuilder base,
                                         String field,
                                         String aggregationFunction,
                                         Properties properties)

Constructor for build iterations.

Parameters:

resultConsumer - The result consumer.

base - The base attributes holder.

field - The field to be used by the measure.

aggregationFunction - The aggregation function to be used by the measure.

properties - The properties to be used by the measure.

Method Detail

withField

public ICanStartBuildingMeasures.IPreAggregatedMeasureBuilderWithField withField(String field)

Description copied from interface: ICanStartBuildingMeasures.IPreAggregatedMeasureBuilder

Chooses the field to aggregate.

Specified by:

withField in interface ICanStartBuildingMeasures.IPreAggregatedMeasureBuilder

Parameters:

field - The field to aggregate.

Returns:

The builder for chained calls.

withAggregationFunction

public ICanStartBuildingMeasures.ICanBuildPreAggregatedMeasureBuilder withAggregationFunction(String aggregationFunctionPluginKey)

Description copied from interface: ICanStartBuildingMeasures.IPreAggregatedMeasureBuilderWithField

Chooses the aggregation function.

Specified by:

withAggregationFunction in interface ICanStartBuildingMeasures.IPreAggregatedMeasureBuilderWithField

Parameters:

aggregationFunctionPluginKey - The aggregation function plugin key.

Returns:

The builder for chained calls.

withProperty

public ICanStartBuildingMeasures.ICanBuildPreAggregatedMeasureBuilder withProperty(String key,
                                                                                   String value)

Description copied from interface: ICanHaveProperty

Puts a property to initialize the component.

Specified by:

withProperty in interface ICanHaveProperty<ICanStartBuildingMeasures.ICanBuildPreAggregatedMeasureBuilder>

Parameters:

key - The property key.

value - The property value.

Returns:

this builder for chaining.

isVisible

public ICanStartBuildingMeasures.ICanBuildPreAggregatedMeasureBuilder isVisible(boolean visibility)

Description copied from interface: ICanHide

Changes the visibility of this item.

Specified by:

isVisible in interface ICanHide<ICanStartBuildingMeasures.ICanBuildPreAggregatedMeasureBuilder>

Parameters:

visibility - The new visibility of the item.

Returns:

The builder for chained calls.

withinFolder

public ICanStartBuildingMeasures.ICanBuildPreAggregatedMeasureBuilder withinFolder(String folder)

Description copied from interface: ICanHaveFolder

Sets the folder of the component.

Specified by:

withinFolder in interface ICanHaveFolder<ICanStartBuildingMeasures.ICanBuildPreAggregatedMeasureBuilder>

Parameters:

folder - The folder name.

Returns:

The builder for chained calls.

withMeasureGroups

public ICanStartBuildingMeasures.ICanBuildPreAggregatedMeasureBuilder withMeasureGroups(String... groups)
                                                                                 throws IllegalArgumentException

Description copied from interface: ICanHaveMeasureGroup

Sets the measure group of the component.

Specified by:

withMeasureGroups in interface ICanHaveMeasureGroup<ICanStartBuildingMeasures.ICanBuildPreAggregatedMeasureBuilder>

Parameters:

groups - The measure group to use. They should not contain the ',' character since this is the separator used between multiple measure groups enforced by XMLA.

Returns:

The builder for chained calls.

Throws:

IllegalArgumentException - If one of the measure groups contains a comma.

withFormatter

public ICanStartBuildingMeasures.ICanBuildPreAggregatedMeasureBuilder withFormatter(String formatter)

Description copied from interface: ICanHaveFormatter

Sets the formatter of the component.

Specified by:

withFormatter in interface ICanHaveFormatter<ICanStartBuildingMeasures.ICanBuildPreAggregatedMeasureBuilder>

Parameters:

formatter - The formatter plugin key.

Returns:

The builder for chained calls.

withName

public ICanStartBuildingMeasures.ICanBuildPreAggregatedMeasureBuilder withName(String name)

Description copied from interface: ICanStartBuildingMeasures.ICanBuildPreAggregatedMeasureBuilder

Change the name of the measure.

Specified by:

withName in interface ICanStartBuildingMeasures.ICanBuildPreAggregatedMeasureBuilder

Parameters:

name - The new name of the measure.

Returns:

The builder for chained calls.

withContributorsCount

public ICanStartBuildingMeasures.INativeMeasureBuilder withContributorsCount()

Description copied from interface: ICanStartBuildingMeasures

Starts customizing the IMeasureHierarchy.COUNT_ID native measure.

Specified by:

withContributorsCount in interface ICanStartBuildingMeasures

Returns:

The native measure customization builder.

withUpdateTimestamp

public ICanStartBuildingMeasures.INativeMeasureBuilder withUpdateTimestamp()

Description copied from interface: ICanStartBuildingMeasures

Starts customizing the IMeasureHierarchy.TIMESTAMP_ID native measure.

Specified by:

withUpdateTimestamp in interface ICanStartBuildingMeasures

Returns:

The native measure customization builder.

withAggregatedMeasure

public ICanStartBuildingMeasures.IPreAggregatedMeasureBuilder withAggregatedMeasure()

Description copied from interface: ICanStartBuildingMeasures

Starts building a pre-aggregated measure.

Specified by:

withAggregatedMeasure in interface ICanStartBuildingMeasures

Returns:

The pre-aggregated measure builder.

withAggregatedMeasure

public IHasAtLeastOneMeasure withAggregatedMeasure(IBasicAggregatedMeasureDescription description)

Description copied from interface: ICanStartBuildingMeasures

Adds the description for a measure.

Specified by:

withAggregatedMeasure in interface ICanStartBuildingMeasures

Parameters:

description - The description of the measure.

Returns:

this builder for chaining.

withPostProcessor

public ICanStartBuildingMeasures.IPostProcessorBuilder withPostProcessor(String name)

Description copied from interface: ICanStartBuildingMeasures

Adds the description for a post-processor.

Specified by:

withPostProcessor in interface ICanStartBuildingMeasures

Parameters:

name - The name of the post-processor.

Returns:

builder for the post-processor description.

withPostProcessor

public IHasAtLeastOneMeasure withPostProcessor(IPostProcessorDescription description)

Description copied from interface: ICanStartBuildingMeasures

Adds the description for a post-processor.

Specified by:

withPostProcessor in interface ICanStartBuildingMeasures

Parameters:

description - The description of the post-processor.

Returns:

this builder for chaining.

withCalculations

public IHasAtLeastOneMeasure withCalculations(Consumer<ICopperContext> calculations)

Description copied from interface: ICanStartBuildingMeasures

Adds multiple measures and hierarchies via the Copper API.

Specified by:

withCalculations in interface ICanStartBuildingMeasures

Parameters:

calculations - the measure and hierarchy creation function

Returns:

The builder for chained calls.

withDimension

public IDimensionBuilder withDimension(String name)

Description copied from interface: ICanStartBuildingDimensions

Start building a dimension.

Specified by:

withDimension in interface ICanStartBuildingDimensions

Parameters:

name - The dimension name.

Returns:

The dimension builder.

withDimensions

public ICanBuildCubeDescription<IActivePivotInstanceDescription> withDimensions(ICanStartBuildingDimensions.DimensionsAdder adder)

Description copied from interface: ICanStartBuildingDimensions

Integrates the dimensions built by a separate function.

Specified by:

withDimensions in interface ICanStartBuildingDimensions

Parameters:

adder - The function adding the dimensions.

Returns:

The builder having integrated the function changes.

asQueryCube

public IQueryCubeDescriptionBuilder asQueryCube()

Description copied from interface: ICanStartBuildingQueryCube

Starts creating a query cube on top of the existing description.

Specified by:

asQueryCube in interface ICanStartBuildingQueryCube

Returns:

The builder for chained calls.