edu.iu.dsc.tws.comms.utils

Class LogicalPlanBuilder

java.lang.Object

edu.iu.dsc.tws.comms.utils.LogicalPlanBuilder

public final class LogicalPlanBuilder
extends java.lang.Object

This class can be used to build an instance of LogicalPlan LogicalPlanBuilder can distribute the tasks in 3 modes.

1. Fair distribution : Tasks will be evenly distributed among all workers
2. Fair distribution on Group : Tasks will be evenly distributed among a specified set of workers
3. Custom Distribution : User can provide a custom LogicalPlanBuilder.Distribution logic to distribute the tasks among the workers

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	LogicalPlanBuilder.Distribution

Method Summary

Modifier and Type	Method and Description
LogicalPlan	build() Builds the LogicalPlan
java.util.Set<java.lang.Integer>	getSources() Get the source ids from this logical plan builder
java.util.Set<java.lang.Integer>	getSourcesOnThisWorker() Returns the set of sources scheduled on this worker.
java.util.Set<java.lang.Integer>	getSourcesOnWorker(int workerId) Returns the set of sources scheduled on specified worker.
java.util.Set<java.lang.Integer>	getTargets() Return the targets of this logical plan builder
java.util.Set<java.lang.Integer>	getTargetsOnThisWorker() Returns the set of targets scheduled on this worker.
java.util.Set<java.lang.Integer>	getTargetsOnWorker(int workerId) Returns the set of targets scheduled on specified worker.
static LogicalPlanBuilder	plan(int sources, int targets, WorkerEnvironment workerEnvironment) Create the plan according the the configurations
LogicalPlanBuilder	withCustomSourceDistribution(LogicalPlanBuilder.Distribution distribution) Create plan with custom distribution
LogicalPlanBuilder	withCustomTargetDistribution(LogicalPlanBuilder.Distribution distribution) Create plan with custom distribution
LogicalPlanBuilder	withFairDistribution() This method will fairly distribute all sources and targets among the available workers
LogicalPlanBuilder	withFairDistribution(java.util.Set<java.lang.Integer> groupOfWorkers) This method will fairly distribute all sources and targets among the specified set of workers
LogicalPlanBuilder	withFairSourceDistribution() This method will distribute sources fairly among the available set of workers
LogicalPlanBuilder	withFairSourceDistribution(java.util.Set<java.lang.Integer> groupOfWorkers) This method will distribute targets fairly among the specified group of workers
LogicalPlanBuilder	withFairTargetDistribution() This method will distribute targets fairly among the available set of workers
LogicalPlanBuilder	withFairTargetDistribution(java.util.Set<java.lang.Integer> groupOfWorkers) This method will distribute sources fairly among the specified group of workers

Methods inherited from class java.lang.Object

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

Method Detail

plan

public static LogicalPlanBuilder plan(int sources,
                                      int targets,
                                      WorkerEnvironment workerEnvironment)

Create the plan according the the configurations

Parameters:

sources - number of sources

targets - number of targets

workerEnvironment - the environment

Returns:

a configured LogicalPlanBuilder

getSources

public java.util.Set<java.lang.Integer> getSources()

Get the source ids from this logical plan builder

Returns:

return the set of sources

getTargets

public java.util.Set<java.lang.Integer> getTargets()

Return the targets of this logical plan builder

Returns:

the set of targets

getSourcesOnThisWorker

public java.util.Set<java.lang.Integer> getSourcesOnThisWorker()

Returns the set of sources scheduled on this worker. This method should be called only after doing the distribution

getTargetsOnThisWorker

public java.util.Set<java.lang.Integer> getTargetsOnThisWorker()

Returns the set of targets scheduled on this worker. This method should be called only after doing the distribution.

getSourcesOnWorker

public java.util.Set<java.lang.Integer> getSourcesOnWorker(int workerId)

Returns the set of sources scheduled on specified worker. This method should be called only after doing the distribution.

getTargetsOnWorker

public java.util.Set<java.lang.Integer> getTargetsOnWorker(int workerId)

Returns the set of targets scheduled on specified worker. This method should be called only after doing the distribution.

build

public LogicalPlan build()

Builds the LogicalPlan

withCustomSourceDistribution

public LogicalPlanBuilder withCustomSourceDistribution(LogicalPlanBuilder.Distribution distribution)

Create plan with custom distribution

Parameters:

distribution - the distribution

Returns:

LogicalPlanBuilder

withCustomTargetDistribution

public LogicalPlanBuilder withCustomTargetDistribution(LogicalPlanBuilder.Distribution distribution)

Create plan with custom distribution

Parameters:

distribution - the distribution

Returns:

LogicalPlanBuilder

withFairDistribution

public LogicalPlanBuilder withFairDistribution(java.util.Set<java.lang.Integer> groupOfWorkers)

This method will fairly distribute all sources and targets among the specified set of workers

Returns:

LogicalPlanBuilder

withFairDistribution

public LogicalPlanBuilder withFairDistribution()

This method will fairly distribute all sources and targets among the available workers

Returns:

LogicalPlanBuilder

withFairSourceDistribution

public LogicalPlanBuilder withFairSourceDistribution()

This method will distribute sources fairly among the available set of workers

Returns:

LogicalPlanBuilder

withFairTargetDistribution

public LogicalPlanBuilder withFairTargetDistribution()

This method will distribute targets fairly among the available set of workers

Returns:

LogicalPlanBuilder

withFairSourceDistribution

public LogicalPlanBuilder withFairSourceDistribution(java.util.Set<java.lang.Integer> groupOfWorkers)

This method will distribute targets fairly among the specified group of workers

Returns:

LogicalPlanBuilder

withFairTargetDistribution

public LogicalPlanBuilder withFairTargetDistribution(java.util.Set<java.lang.Integer> groupOfWorkers)

This method will distribute sources fairly among the specified group of workers

Returns:

LogicalPlanBuilder