ModuloPartitionFunction (Pinot Segment Service Provider Interface 0.12.1 API)

java.lang.Object
- org.apache.pinot.segment.spi.partition.ModuloPartitionFunction

All Implemented Interfaces:

Serializable, PartitionFunction
```
public class ModuloPartitionFunction
extends Object
implements PartitionFunction
```
Modulo operation based partition function, where:
- partitionId = value % _numPartitions
See Also:

Serialized Form

Constructor Summary

Constructors
Constructor Description

ModuloPartitionFunction(int numPartitions)
Constructor for the class.

Method Summary

Modifier and Type	Method	Description
`String`	`getName()`	Returns the name of the partition function.
`int`	`getNumPartitions()`	Returns the total number of possible partitions.
`int`	`getPartition(Object value)`	Returns partition id for a given value.
`String`	`toString()`

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

Methods inherited from interface org.apache.pinot.segment.spi.partition.PartitionFunction
getFunctionConfig

- Constructor Detail
  - ModuloPartitionFunction
```
public ModuloPartitionFunction(int numPartitions)
```
    Constructor for the class.
    
    Parameters:
    
    numPartitions - Number of partitions.
- Method Detail
  - getPartition
```
public int getPartition(Object value)
```
    Returns partition id for a given value. Assumes that the passed in object is either an Integer, or a string representation of an Integer.
    
    Specified by:
    
    getPartition in interface PartitionFunction
    
    Parameters:
    
    value - Value for which to determine the partition id.
    
    Returns:
    
    Partition id for the given value.
  - getName
```
public String getName()
```
    Description copied from interface: PartitionFunction
    
    Returns the name of the partition function.
    
    Specified by:
    
    getName in interface PartitionFunction
    
    Returns:
    
    Name of the partition function.
  - getNumPartitions
```
public int getNumPartitions()
```
    Description copied from interface: PartitionFunction
    
    Returns the total number of possible partitions.
    
    Specified by:
    
    getNumPartitions in interface PartitionFunction
    
    Returns:
    
    Number of possible partitions.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object