FavoredNodesPlan (Apache HBase 1.2.12 API)

java.lang.Object
- org.apache.hadoop.hbase.master.balancer.FavoredNodesPlan

```
@InterfaceAudience.Private
public class FavoredNodesPlan
extends Object
```
This class contains the mapping information between each region and its favored region server list. Used by FavoredNodeLoadBalancer set of classes and from unit tests (hence the class is public) All the access to this class is thread-safe.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class FavoredNodesPlan.Position

Nested Classes
Modifier and Type	Class and Description
`static class`	`FavoredNodesPlan.Position`

Field Summary

Fields
Modifier and Type	Field and Description
`private Map<HRegionInfo,List<ServerName>>`	`favoredNodesMap` the map between each region and its favored region server list
`private static org.apache.commons.logging.Log`	`LOG`

Constructor Summary

Constructors
Constructor and Description

FavoredNodesPlan()

Constructors
Constructor and Description
`FavoredNodesPlan()`

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object o)`
`Map<HRegionInfo,List<ServerName>>`	`getAssignmentMap()`
`List<ServerName>`	`getFavoredNodes(HRegionInfo region)`
`static FavoredNodesPlan.Position`	`getFavoredServerPosition(List<ServerName> favoredNodes, ServerName server)` Return the position of the server in the favoredNodes list.
`int`	`hashCode()`
`void`	`updateAssignmentPlan(HRegionInfo region, List<ServerName> servers)` Add an assignment to the plan
`void`	`updateFavoredNodesMap(HRegionInfo region, List<ServerName> servers)` Add an assignment to the plan

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

LOG

private static final org.apache.commons.logging.Log LOG

favoredNodesMap
```
private Map<HRegionInfo,List<ServerName>> favoredNodesMap
```
the map between each region and its favored region server list

Constructor Detail
- FavoredNodesPlan
```
public FavoredNodesPlan()
```

Method Detail

updateFavoredNodesMap

public void updateFavoredNodesMap(HRegionInfo region,
                         List<ServerName> servers)

Add an assignment to the plan

Parameters:: region -; servers -

getFavoredNodes
```
public List<ServerName> getFavoredNodes(HRegionInfo region)
```
Parameters:
region -

Returns:
the list of favored region server for this region based on the plan

getFavoredServerPosition

public static FavoredNodesPlan.Position getFavoredServerPosition(List<ServerName> favoredNodes,
                                                 ServerName server)

Return the position of the server in the favoredNodes list. Assumes the favoredNodes list is of size 3.

Parameters:: favoredNodes -; server -
Returns:: position

getAssignmentMap
```
public Map<HRegionInfo,List<ServerName>> getAssignmentMap()
```
Returns:
the mapping between each region to its favored region server list

updateAssignmentPlan

public void updateAssignmentPlan(HRegionInfo region,
                        List<ServerName> servers)

Add an assignment to the plan

Parameters:: region -; servers -

equals
```
public boolean equals(Object o)
```
Overrides:

equals in class Object

hashCode
```
public int hashCode()
```
Overrides:

hashCode in class Object

Class FavoredNodesPlan

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LOG

favoredNodesMap

Constructor Detail

FavoredNodesPlan

Method Detail

updateFavoredNodesMap

getFavoredNodes

getFavoredServerPosition

getAssignmentMap

updateAssignmentPlan

equals

hashCode