Package com.activeviam.tech.partitioning.api.builder

Class HierarchicalPartitioningDescriptionBuilder

java.lang.Object

com.activeviam.tech.partitioning.api.builder.PartitioningDescriptionBuilder

com.activeviam.tech.partitioning.api.builder.HierarchicalPartitioningDescriptionBuilder

public final class HierarchicalPartitioningDescriptionBuilder
extends PartitioningDescriptionBuilder

Build a HierarchicalPartitioningDescription.

Author:

ActiveViam

Constructor Summary

Constructors

Constructor	Description
HierarchicalPartitioningDescriptionBuilder(PartitioningDescriptionBuilder srcDesc, List<String> availableKeyFields)	Constructor used when converting a partitioning description into that of a hierarchical partitioning.
HierarchicalPartitioningDescriptionBuilder(List<String> availableKeyFields)	Constructor.

Method Summary

Modifier and Type	Method	Description
HierarchicalPartitioningDescriptionBuilder	addSubPartitioning(String field, IPartitioningFunctionDescription function)	Adds a new partitioning function over a partitioning field.
IPartitioningDescription	build()	Builds the partitioning description.
PartitioningNodeDescriptionBuilder<HierarchicalPartitioningDescriptionBuilder>	withRootNode()	Begins defining the description of the root node of the hierarchy, without a parent builder.
<ParentBuilderT> PartitioningNodeDescriptionBuilder<ParentBuilderT>	withRootNode(Supplier<ParentBuilderT> resultConsumer)	Begins defining the description of the root node of the hierarchy, with a parent builder that can be reached via a consumer.

Methods inherited from class java.lang.Object

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

Constructor Details

HierarchicalPartitioningDescriptionBuilder

public HierarchicalPartitioningDescriptionBuilder(List<String> availableKeyFields)

Constructor.

HierarchicalPartitioningDescriptionBuilder

public HierarchicalPartitioningDescriptionBuilder(PartitioningDescriptionBuilder srcDesc,
 List<String> availableKeyFields)

Constructor used when converting a partitioning description into that of a hierarchical partitioning.

Method Details

build

public IPartitioningDescription build()

Description copied from class: PartitioningDescriptionBuilder

Builds the partitioning description.

Overrides:

build in class PartitioningDescriptionBuilder

Returns:

the partitioning description

withRootNode

public PartitioningNodeDescriptionBuilder<HierarchicalPartitioningDescriptionBuilder> withRootNode()

Begins defining the description of the root node of the hierarchy, without a parent builder.

Returns:

the builder for the root node

withRootNode

public <ParentBuilderT>
PartitioningNodeDescriptionBuilder<ParentBuilderT> withRootNode(Supplier<ParentBuilderT> resultConsumer)

Begins defining the description of the root node of the hierarchy, with a parent builder that can be reached via a consumer.

Type Parameters:

ParentBuilderT - the type of the parent builder

Parameters:

resultConsumer - the result consumer

Returns:

the builder for the root node

addSubPartitioning

public HierarchicalPartitioningDescriptionBuilder addSubPartitioning(String field,
 IPartitioningFunctionDescription function)

Description copied from class: PartitioningDescriptionBuilder

Adds a new partitioning function over a partitioning field.

Overrides:

addSubPartitioning in class PartitioningDescriptionBuilder

Parameters:

field - the partitioning field

function - the partitioning function

Returns:

this builder for chaining