Package com.activeviam.builders

Class SimpleCubeDescriptionBuilder<DescriptionT>

java.lang.Object

com.activeviam.builders.SimpleCubeDescriptionBuilder<DescriptionT>

Type Parameters:

DescriptionT - See ICubeDescriptionBuilder.

All Implemented Interfaces:

ICanHaveFactFilter, ICanStartBuildingEpochDimension<DescriptionT>, ICanStartBuildingDataCube, ICanAddSharedContextValue<DescriptionT>, ICanBuildCommonCubeDescription<DescriptionT>, ICanBuildCubeDescription<DescriptionT>, ICanStartBuildingAggregateProvider<DescriptionT>, ICubeDescriptionBuilder

public class SimpleCubeDescriptionBuilder<DescriptionT>
extends Object
implements ICubeDescriptionBuilder, ICanBuildCubeDescription<DescriptionT>

Simple implementation of ICubeDescriptionBuilder.

Nested Class Summary

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

ICanBuildCommonCubeDescription.IAggregationProceduresBuilder

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

ICubeDescriptionBuilder.INamedCubeDescriptionBuilder

Field Summary

Fields

Modifier and Type	Field	Description
static boolean	DEFAULT_AUTO_FACTLESS_HIERARCHIES	The default value for IActivePivotDescription.isAutoFactlessHierarchies() in the produced description.
static IDimension.DimensionType	DEFAULT_DIMENSION_TYPE	The default value for IAxisDimensionDescription.getDimensionType().
static String	DEFAULT_FOLDER	The default value for IHierarchyDescription.getFolder() and IMeasureMemberDescription.getFolder().
static String	DEFAULT_LEVEL_FORMATTER	The default value for IAxisLevelDescription.getFormatter().
static ILevelInfo.LevelType	DEFAULT_LEVEL_TYPE	The default value for IAxisLevelDescription.getLevelType().
static String	DEFAULT_MEASURE_GROUPS	The default value for IAxisDimensionDescription.getMeasureGroups() and IMeasureMemberDescription.getGroup().
static ImmutableList<IPropertyInfo>	DEFAULT_MEMBER_PROPERTIES	The default value for IAxisLevelDescription.getMemberProperties().
static ImmutableMap<String,Object>	DEFAULT_PROPERTIES	The default properties of built items.
static boolean	DEFAULT_SLICING	The default value used to compute IHierarchyDescription.isAllMembersEnabled().
static boolean	DEFAULT_VIRTUAL	The default virtual value for a hierarchy.
static boolean	DEFAULT_VISIBILITY	The default visibility of built items.

Constructor Summary

Constructors

Constructor	Description
SimpleCubeDescriptionBuilder(Function<IActivePivotInstanceDescription,DescriptionT> resultConsumer)	Constructor for build start.

Method Summary

Modifier and Type	Method	Description
SimpleCubeDescriptionBuilder<DescriptionT>	addAggregationProcedure(IAnalysisAggregationProcedureDescription aggregationProcedure)	Adds the description of an IAnalysisAggregationProcedureDescription to the cube description.
SimpleCubeDescriptionBuilder<DescriptionT>	addDimension(IAxisDimensionDescription description)	Adds the description for a dimension.
IDataCubeDescriptionBuilder	asDataCube()	Starts converting this cube to a data cube.
DescriptionT	build()	Builds the cube description.
static void	ensureNoDuplicateName(ImmutableCollection<String> names, String itemErrorPrefix, String parentToString)	Ensure that all the names in a given collection are unique within this collection by throwing otherwise.
static String	joinMeasureGroups(String... values)	Concatenate multiple measure group names in a single string using the standard XMLA separator between them.
IBuildableAggregateProviderDescriptionBuilder.AggregateProviderBuilder<DescriptionT>	withAggregateProvider()	Starts building the aggregate provider description.
SimpleCubeDescriptionBuilder<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.
ICanBuildCubeDescription<DescriptionT>	withDefaultMeasures(String... defaultMeasures)	Chooses the default measures of this cube.
IDimensionBuilder	withDimension(String name)	Starts building a dimension.
ICanBuildCubeDescription<IActivePivotInstanceDescription>	withDimensions(ICanStartBuildingDimensions.DimensionsAdder adder)	Integrates the dimensions built by a separate function.
IPluginDescriptionBuilder<ICanBuildCubeDescription<DescriptionT>>	withDrillthroughExecutor()	Starts building the IDrillthroughExecutor description.
IEpochDimensionBuilder<DescriptionT>	withEpochDimension()	Enables the epoch dimension for this cube and starts customizing it.
SimpleCubeDescriptionBuilder<DescriptionT>	withEpochDimension(IEpochDimensionDescription newEpochDimension)	Changes the epoch dimension description to use in the cube.
ICanBuildCubeDescription<IActivePivotInstanceDescription>	withFilter(ICondition condition)	Defines the filter condition for the cube.
ICubeDescriptionBuilder.INamedCubeDescriptionBuilder	withName(String newId)	Gives a name to the cube to build.
ICanBuildCubeDescription<DescriptionT>	withoutAutoFactlessHierarchies()	Disables auto-factless hierarchies for this cube.
IPluginDescriptionBuilder<ICanBuildCubeDescription<DescriptionT>>	withQueryExecutor()	Starts building the IActivePivotQueryExecutor description.
<NewDescriptionT> SimpleCubeDescriptionBuilder<NewDescriptionT>	withResultConsumer(Function<DescriptionT,NewDescriptionT> newResultConsumer)	Changes our result consumer by chaining a new one.
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.

Methods inherited from class java.lang.Object

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

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.dimensions.ICanHaveFactFilter

withFilter

Field Detail

DEFAULT_AUTO_FACTLESS_HIERARCHIES

public static final boolean DEFAULT_AUTO_FACTLESS_HIERARCHIES

The default value for IActivePivotDescription.isAutoFactlessHierarchies() in the produced description.

See Also:

Constant Field Values

DEFAULT_SLICING

public static final boolean DEFAULT_SLICING

The default value used to compute IHierarchyDescription.isAllMembersEnabled().

See Also:

Constant Field Values

DEFAULT_VIRTUAL

public static final boolean DEFAULT_VIRTUAL

The default virtual value for a hierarchy.

See Also:

Constant Field Values

DEFAULT_VISIBILITY

public static final boolean DEFAULT_VISIBILITY

The default visibility of built items.

See Also:

Constant Field Values

DEFAULT_MEASURE_GROUPS

public static final String DEFAULT_MEASURE_GROUPS

The default value for IAxisDimensionDescription.getMeasureGroups() and IMeasureMemberDescription.getGroup().

DEFAULT_FOLDER

public static final String DEFAULT_FOLDER

The default value for IHierarchyDescription.getFolder() and IMeasureMemberDescription.getFolder().

DEFAULT_LEVEL_FORMATTER

public static final String DEFAULT_LEVEL_FORMATTER

The default value for IAxisLevelDescription.getFormatter().

DEFAULT_DIMENSION_TYPE

public static final IDimension.DimensionType DEFAULT_DIMENSION_TYPE

The default value for IAxisDimensionDescription.getDimensionType().

DEFAULT_LEVEL_TYPE

public static final ILevelInfo.LevelType DEFAULT_LEVEL_TYPE

The default value for IAxisLevelDescription.getLevelType().

DEFAULT_MEMBER_PROPERTIES

public static final ImmutableList<IPropertyInfo> DEFAULT_MEMBER_PROPERTIES

The default value for IAxisLevelDescription.getMemberProperties().

DEFAULT_PROPERTIES

public static final ImmutableMap<String,Object> DEFAULT_PROPERTIES

The default properties of built items.

Constructor Detail

SimpleCubeDescriptionBuilder

public SimpleCubeDescriptionBuilder(Function<IActivePivotInstanceDescription,DescriptionT> resultConsumer)

Constructor for build start.

Parameters:

resultConsumer - The function processing the built IActivePivotInstanceDescription on build().

Method Detail

withResultConsumer

public <NewDescriptionT> SimpleCubeDescriptionBuilder<NewDescriptionT> withResultConsumer(Function<DescriptionT,NewDescriptionT> newResultConsumer)

Changes our result consumer by chaining a new one.

Type Parameters:

NewDescriptionT - The return type of the new result consumer.

Parameters:

newResultConsumer - The new result consumer to chain to our.

Returns:

The new builder taking into account the new result consumer.

withDimension

public IDimensionBuilder withDimension(String name)

Starts building a dimension.

Parameters:

name - The name of the dimension.

Returns:

The dimension builder.

withDimensions

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

Integrates the dimensions built by a separate function.

Parameters:

adder - The function adding the dimensions.

Returns:

The builder having integrated the function changes.

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.

withEpochDimension

public SimpleCubeDescriptionBuilder<DescriptionT> withEpochDimension(IEpochDimensionDescription newEpochDimension)

Changes the epoch dimension description to use in the cube.

Parameters:

newEpochDimension - The epoch dimension description.

Returns:

The builder for chained calls.

addAggregationProcedure

public SimpleCubeDescriptionBuilder<DescriptionT> addAggregationProcedure(IAnalysisAggregationProcedureDescription aggregationProcedure)

Adds the description of an IAnalysisAggregationProcedureDescription to the cube description.

Parameters:

aggregationProcedure - procedure description

Returns:

the updated builder

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

addDimension

public SimpleCubeDescriptionBuilder<DescriptionT> addDimension(IAxisDimensionDescription description)

Adds the description for a dimension.

Parameters:

description - The description of the dimension.

Returns:

The builder for chained calls.

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.

asDataCube

public IDataCubeDescriptionBuilder asDataCube()

Starts converting this cube to a data cube.

Specified by:

asDataCube in interface ICanStartBuildingDataCube

Returns:

The data cube builder.

withName

public ICubeDescriptionBuilder.INamedCubeDescriptionBuilder withName(String newId)

Description copied from interface: ICubeDescriptionBuilder

Gives a name to the cube to build.

Specified by:

withName in interface ICubeDescriptionBuilder

Parameters:

newId - The cube name, a.k.a. id, a.k.a. pivotId.

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.

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 SimpleCubeDescriptionBuilder<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.

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.

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.

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.

withDefaultMeasures

public ICanBuildCubeDescription<DescriptionT> withDefaultMeasures(String... defaultMeasures)

Description copied from interface: ICanBuildCommonCubeDescription

Chooses the default measures of this cube.

Specified by:

withDefaultMeasures in interface ICanBuildCommonCubeDescription<DescriptionT>

Parameters:

defaultMeasures - The default measures.

Returns:

The builder for chained calls.

See Also:

IMeasuresDescription.getDefaultMeasures()

ensureNoDuplicateName

public static void ensureNoDuplicateName(ImmutableCollection<String> names,
                                         String itemErrorPrefix,
                                         String parentToString)
                                  throws IllegalArgumentException

Ensure that all the names in a given collection are unique within this collection by throwing otherwise.

Parameters:

names - The collection holding the names that should be unique.

itemErrorPrefix - The prefix used in front of the failing name in the thrown exception message.

parentToString - The description of the parent within which unicity is checked, given in the thrown exception message.

Throws:

IllegalArgumentException - If the unicity constraint is not verified.

joinMeasureGroups

public static String joinMeasureGroups(String... values)

Concatenate multiple measure group names in a single string using the standard XMLA separator between them.

Parameters:

values - The groups to concatenate. These strings should not contain any comma.

Returns:

The groups joined representation.