Label (AllMaven4Doc 1.0-SNAPSHOT API)

java.lang.Object
- org.unict.ing.pds.light.utils.Label

```
public class Label
extends Object
```
Represents a Label and all the methods to manage it

Field Summary

Fields
Modifier and Type Field and Description

private BitSet label

private int length

Fields
Modifier and Type	Field and Description
`private BitSet`	`label`
`private int`	`length`

Constructor Summary

Constructors
Modifier	Constructor and Description
`private`	`Label(BitSet bits, int length)`
	`Label(String label)` Returns the corresponding label given the "binary" label.
`private`	`Label(String label, int length)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static int`	`_lowestCommonAncestor(Label label1, Label label2)` Calculates the lowestCommonAncestor between two of Label
`static Set<Label>`	`branchNodesBetweenLabels(Label label, Label region)` Among all branch nodes (i.e., the second children of the ancestors) in the local tree, there exist one or more whose regions overlap the query range.
`boolean`	`equals(Object obj)`
`private BitSet`	`getBitSet()`
`String`	`getLabel()`
`int`	`getLength()`
`Range`	`interval()`
`static Range`	`interval(Label label)` Dual of prefix.
`boolean`	`isLeft()` Returns true if label ends by 0 bit, which means this is the child node on the left
`boolean`	`isRight()` Returns true if label ends by 1 bit, which means this is the child node on the right
`Label`	`leftChild()` Creates a Label that could be mapped as a Left Child in the tree
`static Label`	`lowestCommonAncestor(Label... labels)` Calculates the lowestCommonAncestor between a list of Label
`Label`	`namingFunction()` Apply the naming function to calculate the internal node where the Label (Leaf) is mapped.
`private static Label`	`namingFunction(BitSet bits, int dimentions, int len)` the real static implementation of the NamingFunction
`static Label`	`namingFunction(Label label)` The static implementation of the NamingFunction for 1D-LIGHT
`static Label`	`namingFunction(Label label, int dimentions)` The static implementation of the NamingFunction for MD-LIGHT
`Label`	`nextNamingFunction(int prefixLength, int treeLength)` NextNamingFunction is used to optimize the increments in the Lookup.
`static Label`	`nextNamingFunction(Label label, int prefixLength, int treeLength)` Γ(μ) is the set of possible prefixes of μ Γ(μ, D) set of possibile prefixes with maximum length D Notation: μ = label, x = prefix Locates the first bit in the suffix of μ (with respect to x) that differs from x’s ending bit; the value nextNamingFunction(μ, x) is then the prefix of μ, which ends up with this located bit.
`static Label`	`prefix(int length, long value)` Given the value, returns the prefix label with the specified length.
`Label`	`rightChild()` Creates a Label that could be mapped as a Right Child in the tree
`Key`	`toDataKey()` get the hashed key for the data referenced by this Label
`Label`	`toDHTKey()` get the associated Label for the bucket corresponding with this label it is the Label of an internal node
`Key`	`toKey()` get the Key for the internal node associated with the Label, this is the Hashed key to make lookups in the chord overlay network
`String`	`toString()` Get a binary-readable string of the Label

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

- Field Detail
  - label
```
private final BitSet label
```
  - length
```
private int length
```
- Constructor Detail
  - Label
```
public Label(String label)
```
    Returns the corresponding label given the "binary" label.
    
    Parameters:
    
    label - |
  - Label
```
private Label(String label,
              int length)
```
  - Label
```
private Label(BitSet bits,
              int length)
```
- Method Detail
  - getLabel
```
public String getLabel()
```
  - prefix
```
public static Label prefix(int length,
                           long value)
```
    Given the value, returns the prefix label with the specified length. The label is obtained by iteratively dividing the subranges of the narrowest representable range in two and appending the 0 bit if the value is lower than mid, 1 otherwise.
    
    Parameters:
    
    length - |
    
    value - |
    
    Returns:
    
    |
  - getLength
```
public int getLength()
```
  - toString
```
public String toString()
```
    Get a binary-readable string of the Label
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    |
  - toDHTKey
```
public Label toDHTKey()
```
    get the associated Label for the bucket corresponding with this label it is the Label of an internal node
    
    Returns:
    
    |
  - toKey
```
public Key toKey()
```
    get the Key for the internal node associated with the Label, this is the Hashed key to make lookups in the chord overlay network
    
    Returns:
    
    |
  - toDataKey
```
public Key toDataKey()
```
    get the hashed key for the data referenced by this Label
    
    Returns:
    
    |
  - namingFunction
```
public Label namingFunction()
```
    Apply the naming function to calculate the internal node where the Label (Leaf) is mapped. See the references to LIGHT
    
    Returns:
    
    |
  - nextNamingFunction
```
public Label nextNamingFunction(int prefixLength,
                                int treeLength)
```
    NextNamingFunction is used to optimize the increments in the Lookup. See the references to LIGHT
    
    Parameters:
    
    treeLength - |
    
    prefixLength - |
    
    Returns:
    
    |
  - interval
```
public Range interval()
```
  - isRight
```
public boolean isRight()
```
    Returns true if label ends by 1 bit, which means this is the child node on the right
    
    Returns:
    
    | boolean
  - isLeft
```
public boolean isLeft()
```
    Returns true if label ends by 0 bit, which means this is the child node on the left
    
    Returns:
    
    | boolean
  - leftChild
```
public Label leftChild()
```
    Creates a Label that could be mapped as a Left Child in the tree
    
    Returns:
    
    |
  - rightChild
```
public Label rightChild()
```
    Creates a Label that could be mapped as a Right Child in the tree
    
    Returns:
    
    |
  - getBitSet
```
private BitSet getBitSet()
```
  - interval
```
public static Range interval(Label label)
```
    Dual of prefix. Given a label, this function returns the range it represents.
    
    Parameters:
    
    label - |
    
    Returns:
    
    |
  - namingFunction
```
public static Label namingFunction(Label label)
```
    The static implementation of the NamingFunction for 1D-LIGHT
    
    Parameters:
    
    label - |
    
    Returns:
    
    |
  - namingFunction
```
public static Label namingFunction(Label label,
                                   int dimentions)
```
    The static implementation of the NamingFunction for MD-LIGHT
    
    Parameters:
    
    label - |
    
    dimentions - |
    
    Returns:
    
    |
  - namingFunction
```
private static Label namingFunction(BitSet bits,
                                    int dimentions,
                                    int len)
```
    the real static implementation of the NamingFunction
    
    Parameters:
    
    bits - |
    
    dimentions - |
    
    len - |
    
    Returns:
    
    |
  - nextNamingFunction
```
public static Label nextNamingFunction(Label label,
                                       int prefixLength,
                                       int treeLength)
```
    Γ(μ) is the set of possible prefixes of μ Γ(μ, D) set of possibile prefixes with maximum length D Notation: μ = label, x = prefix Locates the first bit in the suffix of μ (with respect to x) that differs from x’s ending bit; the value nextNamingFunction(μ, x) is then the prefix of μ, which ends up with this located bit. fnn(x, μ) = p00∗1 ∈ Γ(μ) if x = p0, p11∗0 ∈ Γ(μ) if x = p1. Intuitively, fnn locates the first bit in the suffix of μ (with respect to x) that differs from x’s ending bit; the value nextNamingFunction(μ, x) is then the prefix of μ, which ends up with this located bit.
    
    Parameters:
    
    label - |
    
    prefixLength - |
    
    treeLength - |
    
    Returns:
    
    |
  - lowestCommonAncestor
```
public static Label lowestCommonAncestor(Label... labels)
```
    Calculates the lowestCommonAncestor between a list of Label
    
    Parameters:
    
    labels - |
    
    Returns:
    
    |
  - _lowestCommonAncestor
```
public static int _lowestCommonAncestor(Label label1,
                                        Label label2)
```
    Calculates the lowestCommonAncestor between two of Label
    
    Parameters:
    
    label1 - |
    
    label2 - |
    
    Returns:
    
    |
  - branchNodesBetweenLabels
```
public static Set<Label> branchNodesBetweenLabels(Label label,
                                                  Label region)
```
    Among all branch nodes (i.e., the second children of the ancestors) in the local tree, there exist one or more whose regions overlap the query range. This function returns all those nodes.
    
    Parameters:
    
    label - |
    
    region - |
    
    Returns:
    
    |
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object

Class Label

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

label

length

Constructor Detail

Label

Label

Label

Method Detail

getLabel

prefix

getLength

toString

toDHTKey

toKey

toDataKey

namingFunction

nextNamingFunction

interval

isRight

isLeft

leftChild

rightChild

getBitSet

interval

namingFunction

namingFunction

namingFunction

nextNamingFunction

lowestCommonAncestor

_lowestCommonAncestor

branchNodesBetweenLabels

equals