DefaultBalanceablePoolModel (Apache Brooklyn)

java.lang.Object
- brooklyn.policy.loadbalancing.DefaultBalanceablePoolModel<ContainerType,ItemType>

All Implemented Interfaces:

BalanceablePoolModel<ContainerType,ItemType>
```
public class DefaultBalanceablePoolModel<ContainerType,ItemType>
extends java.lang.Object
implements BalanceablePoolModel<ContainerType,ItemType>
```
Standard implementation of BalanceablePoolModel, providing essential arithmetic for item and container workrates and thresholds. See subclasses for specific requirements for migrating items.

Constructor Summary

Constructors
Constructor and Description

DefaultBalanceablePoolModel(java.lang.String name)

Constructors
Constructor and Description
`DefaultBalanceablePoolModel(java.lang.String name)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`dumpItemDistribution()`
`void`	`dumpItemDistribution(java.io.PrintStream out)`
`java.util.Map<ContainerType,java.lang.Double>`	`getContainerWorkrates()`
`double`	`getCurrentPoolWorkrate()`
`double`	`getHighThreshold(ContainerType container)`
`java.util.Set<ItemType>`	`getItemsForContainer(ContainerType node)`
`java.lang.Double`	`getItemWorkrate(ItemType item)`
`java.util.Map<ItemType,java.lang.Double>`	`getItemWorkrates(ContainerType node)` contains -1 instead of actual item workrate, for items which cannot be moved
`Location`	`getLocation(ContainerType container)`
`double`	`getLowThreshold(ContainerType container)`
`java.lang.String`	`getName()`
`java.lang.String`	`getName(ContainerType container)`
`ContainerType`	`getParentContainer(ItemType item)`
`java.util.Set<ContainerType>`	`getPoolContents()`
`double`	`getPoolHighThreshold()`
`double`	`getPoolLowThreshold()`
`int`	`getPoolSize()`
`double`	`getTotalWorkrate(ContainerType container)`
`boolean`	`isCold()`
`boolean`	`isHot()`
`boolean`	`isItemAllowedIn(ItemType item, Location location)`
`boolean`	`isItemMoveable(ItemType item)`
`java.lang.String`	`itemDistributionToString()` Warning: this can be an expensive (time and memory) operation if there are a lot of items/containers.
`void`	`onContainerAdded(ContainerType newContainer, double lowThreshold, double highThreshold)`
`void`	`onContainerRemoved(ContainerType oldContainer)`
`void`	`onItemAdded(ItemType item, ContainerType parentContainer)`
`void`	`onItemAdded(ItemType item, ContainerType parentContainer, boolean immovable)`
`void`	`onItemMoved(ItemType item, ContainerType newNode)`
`void`	`onItemRemoved(ItemType item)`
`void`	`onItemWorkrateUpdated(ItemType item, double newValue)`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - DefaultBalanceablePoolModel
```
public DefaultBalanceablePoolModel(java.lang.String name)
```
- Method Detail
  - getParentContainer
```
public ContainerType getParentContainer(ItemType item)
```
  - getItemsForContainer
```
public java.util.Set<ItemType> getItemsForContainer(ContainerType node)
```
  - getItemWorkrate
```
public java.lang.Double getItemWorkrate(ItemType item)
```
  - getPoolLowThreshold
```
public double getPoolLowThreshold()
```
    Specified by:
    
    getPoolLowThreshold in interface BalanceablePoolModel<ContainerType,ItemType>
  - getPoolHighThreshold
```
public double getPoolHighThreshold()
```
    Specified by:
    
    getPoolHighThreshold in interface BalanceablePoolModel<ContainerType,ItemType>
  - getCurrentPoolWorkrate
```
public double getCurrentPoolWorkrate()
```
    Specified by:
    
    getCurrentPoolWorkrate in interface BalanceablePoolModel<ContainerType,ItemType>
  - isHot
```
public boolean isHot()
```
    Specified by:
    
    isHot in interface BalanceablePoolModel<ContainerType,ItemType>
  - isCold
```
public boolean isCold()
```
    Specified by:
    
    isCold in interface BalanceablePoolModel<ContainerType,ItemType>
  - getName
```
public java.lang.String getName()
```
    Specified by:
    
    getName in interface BalanceablePoolModel<ContainerType,ItemType>
  - getPoolSize
```
public int getPoolSize()
```
    Specified by:
    
    getPoolSize in interface BalanceablePoolModel<ContainerType,ItemType>
  - getPoolContents
```
public java.util.Set<ContainerType> getPoolContents()
```
    Specified by:
    
    getPoolContents in interface BalanceablePoolModel<ContainerType,ItemType>
  - getName
```
public java.lang.String getName(ContainerType container)
```
    Specified by:
    
    getName in interface BalanceablePoolModel<ContainerType,ItemType>
  - getLocation
```
public Location getLocation(ContainerType container)
```
    Specified by:
    
    getLocation in interface BalanceablePoolModel<ContainerType,ItemType>
  - getLowThreshold
```
public double getLowThreshold(ContainerType container)
```
    Specified by:
    
    getLowThreshold in interface BalanceablePoolModel<ContainerType,ItemType>
  - getHighThreshold
```
public double getHighThreshold(ContainerType container)
```
    Specified by:
    
    getHighThreshold in interface BalanceablePoolModel<ContainerType,ItemType>
  - getTotalWorkrate
```
public double getTotalWorkrate(ContainerType container)
```
    Specified by:
    
    getTotalWorkrate in interface BalanceablePoolModel<ContainerType,ItemType>
  - getContainerWorkrates
```
public java.util.Map<ContainerType,java.lang.Double> getContainerWorkrates()
```
    Specified by:
    
    getContainerWorkrates in interface BalanceablePoolModel<ContainerType,ItemType>
  - getItemWorkrates
```
public java.util.Map<ItemType,java.lang.Double> getItemWorkrates(ContainerType node)
```
    Description copied from interface: BalanceablePoolModel
    
    contains -1 instead of actual item workrate, for items which cannot be moved
    
    Specified by:
    
    getItemWorkrates in interface BalanceablePoolModel<ContainerType,ItemType>
  - isItemMoveable
```
public boolean isItemMoveable(ItemType item)
```
    Specified by:
    
    isItemMoveable in interface BalanceablePoolModel<ContainerType,ItemType>
  - isItemAllowedIn
```
public boolean isItemAllowedIn(ItemType item,
                      Location location)
```
    Specified by:
    
    isItemAllowedIn in interface BalanceablePoolModel<ContainerType,ItemType>
  - onItemMoved
```
public void onItemMoved(ItemType item,
               ContainerType newNode)
```
    Specified by:
    
    onItemMoved in interface BalanceablePoolModel<ContainerType,ItemType>
  - onContainerAdded
```
public void onContainerAdded(ContainerType newContainer,
                    double lowThreshold,
                    double highThreshold)
```
    Specified by:
    
    onContainerAdded in interface BalanceablePoolModel<ContainerType,ItemType>
  - onContainerRemoved
```
public void onContainerRemoved(ContainerType oldContainer)
```
    Specified by:
    
    onContainerRemoved in interface BalanceablePoolModel<ContainerType,ItemType>
  - onItemAdded
```
public void onItemAdded(ItemType item,
               ContainerType parentContainer)
```
    Specified by:
    
    onItemAdded in interface BalanceablePoolModel<ContainerType,ItemType>
  - onItemAdded
```
public void onItemAdded(ItemType item,
               ContainerType parentContainer,
               boolean immovable)
```
    Specified by:
    
    onItemAdded in interface BalanceablePoolModel<ContainerType,ItemType>
  - onItemRemoved
```
public void onItemRemoved(ItemType item)
```
    Specified by:
    
    onItemRemoved in interface BalanceablePoolModel<ContainerType,ItemType>
  - onItemWorkrateUpdated
```
public void onItemWorkrateUpdated(ItemType item,
                         double newValue)
```
    Specified by:
    
    onItemWorkrateUpdated in interface BalanceablePoolModel<ContainerType,ItemType>
  - itemDistributionToString
```
public java.lang.String itemDistributionToString()
```
    Warning: this can be an expensive (time and memory) operation if there are a lot of items/containers.
  - dumpItemDistribution
```
public void dumpItemDistribution()
```
  - dumpItemDistribution
```
public void dumpItemDistribution(java.io.PrintStream out)
```

Class DefaultBalanceablePoolModel<ContainerType,ItemType>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DefaultBalanceablePoolModel

Method Detail

getParentContainer

getItemsForContainer

getItemWorkrate

getPoolLowThreshold

getPoolHighThreshold

getCurrentPoolWorkrate

isHot

isCold

getName

getPoolSize

getPoolContents

getName

getLocation

getLowThreshold

getHighThreshold

getTotalWorkrate

getContainerWorkrates

getItemWorkrates

isItemMoveable

isItemAllowedIn

onItemMoved

onContainerAdded

onContainerRemoved

onItemAdded

onItemAdded

onItemRemoved

onItemWorkrateUpdated

itemDistributionToString

dumpItemDistribution

dumpItemDistribution