Package com.activeviam.builders

Class ParentReferenceAggregateProviderDefinitionBuilder<DescriptionT>

java.lang.Object

com.activeviam.builders.ParentReferenceAggregateProviderDefinitionBuilder<DescriptionT>

Type Parameters:

DescriptionT - The type of description built by the parent cube builder.

All Implemented Interfaces:

ICanHaveFactFilter, ICanStartBuildingEpochDimension<DescriptionT>, ICanStartBuildingDataCube, IBuildableAggregateProviderDescriptionBuilder<DescriptionT>, IBuildableAggregateProviderDescriptionBuilder.AggregateProviderBuilder<DescriptionT>, IBuildableAggregateProviderDescriptionBuilder.PropertiedAggregateProviderDescriptionBuilder<DescriptionT>, IBuildableAggregateProviderDescriptionBuilder.TypedAggregateProviderDescriptionBuilder<DescriptionT>, ICanAddSharedContextValue<DescriptionT>, ICanBuildCommonCubeDescription<DescriptionT>, ICanBuildCubeDescription<DescriptionT>, ICanChangeRangeSharing<IBuildableAggregateProviderDescriptionBuilder.PropertiedAggregateProviderDescriptionBuilder<DescriptionT>>, ICanHaveProperty<IBuildableAggregateProviderDescriptionBuilder.PropertiedAggregateProviderDescriptionBuilder<DescriptionT>>, ICanStartBuildingAggregateProvider<DescriptionT>, ICanStartPartialProvider<DescriptionT>, ICanPartition<IBuildableAggregateProviderDescriptionBuilder<DescriptionT>>

public class ParentReferenceAggregateProviderDefinitionBuilder<DescriptionT>
extends Object
implements IBuildableAggregateProviderDescriptionBuilder.AggregateProviderBuilder<DescriptionT>, IBuildableAggregateProviderDescriptionBuilder.TypedAggregateProviderDescriptionBuilder<DescriptionT>, IBuildableAggregateProviderDescriptionBuilder.PropertiedAggregateProviderDescriptionBuilder<DescriptionT>

Nested Class Summary

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

IBuildableAggregateProviderDescriptionBuilder.AggregateProviderBuilder<DescriptionT>, IBuildableAggregateProviderDescriptionBuilder.LevelListBuilder<ParentT>, IBuildableAggregateProviderDescriptionBuilder.PartialBuilder<DescriptionT>, IBuildableAggregateProviderDescriptionBuilder.PartialWithHierarchiesRestrictionBuilder<DescriptionT>, IBuildableAggregateProviderDescriptionBuilder.PartialWithMeasuresRestrictionBuilder<DescriptionT>, IBuildableAggregateProviderDescriptionBuilder.PartialWithoutHierarchiesRestrictionBuilder<RestrictedBuilderT>, IBuildableAggregateProviderDescriptionBuilder.PartialWithoutMeasuresRestrictionBuilder<RestrictedBuilderT>, IBuildableAggregateProviderDescriptionBuilder.PartialWithoutRestrictionsBuilder<DescriptionT>, IBuildableAggregateProviderDescriptionBuilder.PropertiedAggregateProviderDescriptionBuilder<DescriptionT>, IBuildableAggregateProviderDescriptionBuilder.PropertiedPartialBuilder<DescriptionT>, IBuildableAggregateProviderDescriptionBuilder.TypedAggregateProviderDescriptionBuilder<DescriptionT>, IBuildableAggregateProviderDescriptionBuilder.TypedPartialBuilder<DescriptionT>

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

ICanBuildCommonCubeDescription.IAggregationProceduresBuilder

Field Summary

Fields inherited from interface com.activeviam.desc.build.IBuildableAggregateProviderDescriptionBuilder

ADAPTIVE_JIT_PLUGIN_TYPE, BITMAP_PLUGIN_TYPE, JIT_PLUGIN_TYPE, LEAF_PLUGIN_TYPE

Constructor Summary

Constructors

Constructor	Description
ParentReferenceAggregateProviderDefinitionBuilder(SimpleCubeDescriptionBuilder<DescriptionT> parent, String pluginKey, ImmutableList<IPartialProviderDefinition> partials, ImmutableMap<String,Object> properties, PartitioningDescriptionBuilder partitioningBuilder, String numaSelector)	Constructor.

Method Summary

Modifier and Type	Method	Description
ParentReferenceAggregateProviderDefinitionBuilder<DescriptionT>	addPartialProvider(IPartialProviderDefinition toAdd)	Add a partial provider to this aggregate provider.
IDataCubeDescriptionBuilder	asDataCube()	Starts creating a data cube on top of the existing description.
DescriptionT	build()	Builds the cube description.
IBuildableAggregateProviderDescriptionBuilder<DescriptionT>	filteredOn(Map<LevelIdentifier,Object> filters)	Filter the partial aggregate provider on certain levels.
IBuildableAggregateProviderDescriptionBuilder.AggregateProviderBuilder<DescriptionT>	withAggregateProvider()	Starts building the aggregate provider description.
ICanBuildCubeDescription<DescriptionT>	withAggregateProvider(IAggregateProviderDefinition definition)	Provide directly an aggregate provider description for this cube.
IAggregatesCacheDescriptionCompleteBuilder.AggregatesCacheDescriptionBuilder<DescriptionT>	withAggregatesCache()	Starts building the IAggregatesCache description.
IPluginDescriptionBuilder<ICanBuildCubeDescription<DescriptionT>>	withAggregatesContinuousQueryEngine()	Starts building the IAggregatesContinuousQueryEngine description.
ICanBuildCommonCubeDescription<DescriptionT>	withAggregationProcedures(Function<ICanBuildCommonCubeDescription.IAggregationProceduresBuilder,ICanBuildCommonCubeDescription.IAggregationProceduresBuilder> builderConsumer)	Defines aggregation procedures on the cube.
ICanBuildCommonCubeDescription<DescriptionT>	withDefaultMeasures(String... measures)	Chooses the default measures of this cube.
IPluginDescriptionBuilder<ICanBuildCubeDescription<DescriptionT>>	withDrillthroughExecutor()	Starts building the IDrillthroughExecutor description.
IEpochDimensionBuilder<DescriptionT>	withEpochDimension()	Enables the epoch dimension for this cube and starts customizing it.
ICanBuildCubeDescription<IActivePivotInstanceDescription>	withFilter(ICondition condition)	Defines the filter condition for the cube.
IBuildableAggregateProviderDescriptionBuilder<DescriptionT>	withModuloPartitioning(int modulo, String... onFields)	Defines a partitioning by hash code on multiple fields.
IBuildableAggregateProviderDescriptionBuilder<DescriptionT>	withModuloPartitioning(String onField, int modulo)	Adds a partitioning by hash code on the given field.
IBuildableAggregateProviderDescriptionBuilder<DescriptionT>	withNumaSelector(String numaSelector)	Chooses the NUMA selector for the partitions of the built aggregate provider.
ICanBuildCubeDescription<DescriptionT>	withoutAutoFactlessHierarchies()	Disables auto-factless hierarchies for this cube.
IBuildableAggregateProviderDescriptionBuilder.PartialBuilder<DescriptionT>	withPartialProvider()	Start building a partial provider description.
IBuildableAggregateProviderDescriptionBuilder<DescriptionT>	withPartitioning(String partitioning)	Defines the partitioning of the store: which kind, on which field and how many partitions.
IPartitioningNodeDescriptionBuilder.ICanHaveSpecialPartitioningRule<IBuildableAggregateProviderDescriptionBuilder<DescriptionT>>	withPartitioningOn(String field)	Defines a hierarchical partitioning with the root node using the given field.
IBuildableAggregateProviderDescriptionBuilder.PropertiedAggregateProviderDescriptionBuilder<DescriptionT>	withProperty(String key, String value)	Puts a property to initialize the component.
IPluginDescriptionBuilder<ICanBuildCubeDescription<DescriptionT>>	withQueryExecutor()	Starts building the IActivePivotQueryExecutor description.
ICanBuildCubeDescription<DescriptionT>	withSharedContextValue(IContextValue value)	Adds a shared context value to the current cube description.
ICanBuildCubeDescription<DescriptionT>	withSharedContextValues(IContextValue... values)	Adds a collection of shared context values to the cube description being currently built.
ICanStartBuildingDrillthroughProperties.IDrillthroughPropertiesBuilder<ICanBuildCubeDescription<DescriptionT>>	withSharedDrillthroughProperties()	Begins defining the drillthrough properties.
ICanStartBuildingMdxContext.IMdxContextBuilder<ICanBuildCubeDescription<DescriptionT>>	withSharedMdxContext()	Begins defining the mdx context.
ICanStartBuildingSubCubeProperties.IEmptyBuilder<ICanBuildCubeDescription<DescriptionT>>	withSharedSubCubeProperties()	Begins defining sub cube properties.
IBuildableAggregateProviderDescriptionBuilder.TypedAggregateProviderDescriptionBuilder<DescriptionT>	withType(String type)	Give the IAggregateProvider type / plugin key.
IBuildableAggregateProviderDescriptionBuilder<DescriptionT>	withValuePartitioningOn(String onField)	Adds a partitioning by value on the onField.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.activeviam.desc.build.IBuildableAggregateProviderDescriptionBuilder.AggregateProviderBuilder

bitmap, jit, leaf

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

withSharedContextValue

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

withDefaultMeasure

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

withoutRangeSharing, withRangeSharing, withRangeSharing

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

withFilter

Constructor Detail

ParentReferenceAggregateProviderDefinitionBuilder

public ParentReferenceAggregateProviderDefinitionBuilder(SimpleCubeDescriptionBuilder<DescriptionT> parent,
                                                         String pluginKey,
                                                         ImmutableList<IPartialProviderDefinition> partials,
                                                         ImmutableMap<String,Object> properties,
                                                         PartitioningDescriptionBuilder partitioningBuilder,
                                                         String numaSelector)

Constructor.

Parameters:

parent - The parent builder

partials - The partial providers.

properties - The global aggregate provider properties.

partitioningBuilder - The partitioning builder.

numaSelector - The NUMA selector plugin key, can be null.

Method Detail

withType

public IBuildableAggregateProviderDescriptionBuilder.TypedAggregateProviderDescriptionBuilder<DescriptionT> withType(String type)

Description copied from interface: IBuildableAggregateProviderDescriptionBuilder.AggregateProviderBuilder

Give the IAggregateProvider type / plugin key.

Specified by:

withType in interface IBuildableAggregateProviderDescriptionBuilder.AggregateProviderBuilder<DescriptionT>

Parameters:

type - The aggregate provider type.

Returns:

The builder having taken the type into account.

withProperty

public IBuildableAggregateProviderDescriptionBuilder.PropertiedAggregateProviderDescriptionBuilder<DescriptionT> withProperty(String key,
                                                                                                                              String value)

Description copied from interface: ICanHaveProperty

Puts a property to initialize the component.

Specified by:

withProperty in interface ICanHaveProperty<DescriptionT>

Parameters:

key - The property key.

value - The property value.

Returns:

this builder for chaining.

withNumaSelector

public IBuildableAggregateProviderDescriptionBuilder<DescriptionT> withNumaSelector(String numaSelector)

Description copied from interface: IBuildableAggregateProviderDescriptionBuilder

Chooses the NUMA selector for the partitions of the built aggregate provider.

Specified by:

withNumaSelector in interface IBuildableAggregateProviderDescriptionBuilder<DescriptionT>

Parameters:

numaSelector - The plugin key of the selector to use.

Returns:

The builder for chained calls.

filteredOn

public IBuildableAggregateProviderDescriptionBuilder<DescriptionT> filteredOn(Map<LevelIdentifier,Object> filters)

Description copied from interface: IBuildableAggregateProviderDescriptionBuilder

Filter the partial aggregate provider on certain levels.

This allows the provider to only load a slice of data instead of all the members of each level. The filters can be applied on any level handled by the partial provider.

Specified by:

filteredOn in interface IBuildableAggregateProviderDescriptionBuilder<DescriptionT>

withPartialProvider

public IBuildableAggregateProviderDescriptionBuilder.PartialBuilder<DescriptionT> withPartialProvider()

Description copied from interface: ICanStartPartialProvider

Start building a partial provider description.

Specified by:

withPartialProvider in interface ICanStartPartialProvider<DescriptionT>

Returns:

The partial provider description builder.

addPartialProvider

public ParentReferenceAggregateProviderDefinitionBuilder<DescriptionT> addPartialProvider(IPartialProviderDefinition toAdd)

Add a partial provider to this aggregate provider.

Parameters:

toAdd - The partial provider definition to add.

Returns:

The builder for chained calls.

build

public DescriptionT build()

Description copied from interface: ICanBuildCommonCubeDescription

Builds the cube description.

Specified by:

build in interface ICanBuildCommonCubeDescription<DescriptionT>

Returns:

the cube description.

withAggregationProcedures

public ICanBuildCommonCubeDescription<DescriptionT> withAggregationProcedures(Function<ICanBuildCommonCubeDescription.IAggregationProceduresBuilder,ICanBuildCommonCubeDescription.IAggregationProceduresBuilder> builderConsumer)

Description copied from interface: ICanBuildCommonCubeDescription

Defines aggregation procedures on the cube.

Aggregation procedures offer means to support aggregated measures on analysis hierarchies.

Specified by:

withAggregationProcedures in interface ICanBuildCommonCubeDescription<DescriptionT>

Parameters:

builderConsumer - consumer of the builder to define the procedures

Returns:

The builder for chained calls

withAggregateProvider

public IBuildableAggregateProviderDescriptionBuilder.AggregateProviderBuilder<DescriptionT> withAggregateProvider()

Description copied from interface: ICanStartBuildingAggregateProvider

Starts building the aggregate provider description.

Specified by:

withAggregateProvider in interface ICanStartBuildingAggregateProvider<DescriptionT>

Returns:

The aggregate provider description builder.

withAggregateProvider

public ICanBuildCubeDescription<DescriptionT> withAggregateProvider(IAggregateProviderDefinition definition)

Description copied from interface: ICanStartBuildingAggregateProvider

Provide directly an aggregate provider description for this cube.

Specified by:

withAggregateProvider in interface ICanStartBuildingAggregateProvider<DescriptionT>

Parameters:

definition - The aggregate provider definition.

Returns:

The cube builder.

withoutAutoFactlessHierarchies

public ICanBuildCubeDescription<DescriptionT> withoutAutoFactlessHierarchies()

Description copied from interface: ICanBuildCubeDescription

Disables auto-factless hierarchies for this cube.

Specified by:

withoutAutoFactlessHierarchies in interface ICanBuildCubeDescription<DescriptionT>

Returns:

The builder for chained calls.

withDrillthroughExecutor

public IPluginDescriptionBuilder<ICanBuildCubeDescription<DescriptionT>> withDrillthroughExecutor()

Description copied from interface: ICanBuildCommonCubeDescription

Starts building the IDrillthroughExecutor description.

Specified by:

withDrillthroughExecutor in interface ICanBuildCommonCubeDescription<DescriptionT>

Returns:

The builder for the drillthrough executor description.

withQueryExecutor

public IPluginDescriptionBuilder<ICanBuildCubeDescription<DescriptionT>> withQueryExecutor()

Description copied from interface: ICanBuildCommonCubeDescription

Starts building the IActivePivotQueryExecutor description.

Specified by:

withQueryExecutor in interface ICanBuildCommonCubeDescription<DescriptionT>

Returns:

The builder for the query executor description.

withAggregatesContinuousQueryEngine

public IPluginDescriptionBuilder<ICanBuildCubeDescription<DescriptionT>> withAggregatesContinuousQueryEngine()

Description copied from interface: ICanBuildCommonCubeDescription

Starts building the IAggregatesContinuousQueryEngine description.

Specified by:

withAggregatesContinuousQueryEngine in interface ICanBuildCommonCubeDescription<DescriptionT>

Returns:

The builder for the aggregates continuous query engine description.

withAggregatesCache

public IAggregatesCacheDescriptionCompleteBuilder.AggregatesCacheDescriptionBuilder<DescriptionT> withAggregatesCache()

Description copied from interface: ICanBuildCommonCubeDescription

Starts building the IAggregatesCache description.

Specified by:

withAggregatesCache in interface ICanBuildCommonCubeDescription<DescriptionT>

Returns:

The builder for the aggregates cache.

withDefaultMeasures

public ICanBuildCommonCubeDescription<DescriptionT> withDefaultMeasures(String... measures)

Description copied from interface: ICanBuildCommonCubeDescription

Chooses the default measures of this cube.

Specified by:

withDefaultMeasures in interface ICanBuildCommonCubeDescription<DescriptionT>

Parameters:

measures - The default measures.

Returns:

The builder for chained calls.

See Also:

IMeasuresDescription.getDefaultMeasures()

withSharedContextValue

public ICanBuildCubeDescription<DescriptionT> withSharedContextValue(IContextValue value)

Description copied from interface: ICanAddSharedContextValue

Adds a shared context value to the current cube description.

Specified by:

withSharedContextValue in interface ICanAddSharedContextValue<DescriptionT>

Parameters:

value - The value to add to the cube shared context.

Returns:

The builder for chained calls.

withSharedContextValues

public ICanBuildCubeDescription<DescriptionT> withSharedContextValues(IContextValue... values)

Description copied from interface: ICanAddSharedContextValue

Adds a collection of shared context values to the cube description being currently built. This is sugar syntax for repetitive calls to ICanAddSharedContextValue.withSharedContextValue(IContextValue).

Specified by:

withSharedContextValues in interface ICanAddSharedContextValue<DescriptionT>

Parameters:

values - the context values to add

Returns:

The builder for chained calls.

withSharedMdxContext

public ICanStartBuildingMdxContext.IMdxContextBuilder<ICanBuildCubeDescription<DescriptionT>> withSharedMdxContext()

Description copied from interface: ICanAddSharedContextValue

Begins defining the mdx context.

Specified by:

withSharedMdxContext in interface ICanAddSharedContextValue<DescriptionT>

Returns:

this builder for chaining.

withSharedDrillthroughProperties

public ICanStartBuildingDrillthroughProperties.IDrillthroughPropertiesBuilder<ICanBuildCubeDescription<DescriptionT>> withSharedDrillthroughProperties()

Description copied from interface: ICanAddSharedContextValue

Begins defining the drillthrough properties.

Specified by:

withSharedDrillthroughProperties in interface ICanAddSharedContextValue<DescriptionT>

Returns:

this builder for chaining.

withSharedSubCubeProperties

public ICanStartBuildingSubCubeProperties.IEmptyBuilder<ICanBuildCubeDescription<DescriptionT>> withSharedSubCubeProperties()

Description copied from interface: ICanAddSharedContextValue

Begins defining sub cube properties.

Specified by:

withSharedSubCubeProperties in interface ICanAddSharedContextValue<DescriptionT>

Returns:

this builder for chaining.

withFilter

public ICanBuildCubeDescription<IActivePivotInstanceDescription> withFilter(ICondition condition)

Description copied from interface: ICanHaveFactFilter

Defines the filter condition for the cube.

Specified by:

withFilter in interface ICanHaveFactFilter

Parameters:

condition - The condition of the filter.

Returns:

The cube builder for chaining.

asDataCube

public IDataCubeDescriptionBuilder asDataCube()

Description copied from interface: ICanStartBuildingDataCube

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

Specified by:

asDataCube in interface ICanStartBuildingDataCube

Returns:

The builder for chained calls.

withPartitioning

public IBuildableAggregateProviderDescriptionBuilder<DescriptionT> withPartitioning(String partitioning)

Description copied from interface: ICanPartition

Defines the partitioning of the store: which kind, on which field and how many partitions.

Example: withPartitioning("hash16(id)|value(date)") means partitioning by hash on id and by value on date, so that the partition id of a record r will (only) depend on r.readInt(id) % 16 and r.readInt(date).

Specified by:

withPartitioning in interface ICanPartition<DescriptionT>

Parameters:

partitioning - the definition of the partitioning, of the form hash64(FIELD_NAME), where hash is the type of partitioning, 64 the number of partitions, and FIELD_NAME the name of the field on which to partition

Returns:

the builder

withValuePartitioningOn

public IBuildableAggregateProviderDescriptionBuilder<DescriptionT> withValuePartitioningOn(String onField)

Description copied from interface: ICanPartition

Adds a partitioning by value on the onField. The partition id of a record r will depend (among other factor) on r.readInt(onField).

Specified by:

withValuePartitioningOn in interface ICanPartition<DescriptionT>

Parameters:

onField - the field to partition by value

Returns:

the builder

withModuloPartitioning

public IBuildableAggregateProviderDescriptionBuilder<DescriptionT> withModuloPartitioning(String onField,
                                                                                          int modulo)

Description copied from interface: ICanPartition

Adds a partitioning by hash code on the given field. The partition id of a record r will depend (among other factor) on r.readInt(onField) % modulo.

Specified by:

withModuloPartitioning in interface ICanPartition<DescriptionT>

Parameters:

onField - the field whose value's hash code determine the partition

modulo - the modulo

Returns:

the builder

withModuloPartitioning

public IBuildableAggregateProviderDescriptionBuilder<DescriptionT> withModuloPartitioning(int modulo,
                                                                                          String... onFields)

Description copied from interface: ICanPartition

Defines a partitioning by hash code on multiple fields.

For a record, the partition id is computed by taking the hashCode of the given fields, combining them in a single integer and taking the modulo of this integer.

As opposed to ICanPartition.withModuloPartitioning(String, int), calling this method results in using a multiple field modulo partitioning on the store while the other may result in a single field partitioning or partitioning by Cartesian product, depending on the number of partitioning fields selected for the store.

Calling this method with only one field will throw a ConfigurationException.

Specified by:

withModuloPartitioning in interface ICanPartition<DescriptionT>

Parameters:

modulo - the modulo

onFields - the fields whose value determines the partition, having at least two elements

Returns:

the builder

withPartitioningOn

public IPartitioningNodeDescriptionBuilder.ICanHaveSpecialPartitioningRule<IBuildableAggregateProviderDescriptionBuilder<DescriptionT>> withPartitioningOn(String field)

Description copied from interface: ICanPartition

Defines a hierarchical partitioning with the root node using the given field.

Specified by:

withPartitioningOn in interface ICanPartition<DescriptionT>

Parameters:

field - the partitioning field

Returns:

the builder for the partitioning node

withEpochDimension

public IEpochDimensionBuilder<DescriptionT> withEpochDimension()

Description copied from interface: ICanStartBuildingEpochDimension

Enables the epoch dimension for this cube and starts customizing it.

Specified by:

withEpochDimension in interface ICanStartBuildingEpochDimension<DescriptionT>

Returns:

The builder to start customizing the epoch dimension.