Package org.apache.cassandra.dht

Class RandomPartitioner

java.lang.Object

org.apache.cassandra.dht.RandomPartitioner

All Implemented Interfaces:

IPartitioner

public class RandomPartitioner
extends Object
implements IPartitioner

This class generates a BigIntegerToken using MD5 hash.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RandomPartitioner.BigIntegerToken

Field Summary

Fields

Modifier and Type	Field	Description
static final RandomPartitioner	instance
static final BigInteger	MAXIMUM
static final int	MAXIMUM_TOKEN_SIZE
static final RandomPartitioner.BigIntegerToken	MINIMUM
static final PartitionerDefinedOrder	partitionOrdering
static final BigInteger	ZERO

Constructor Summary

Constructors

Constructor	Description
RandomPartitioner()

Method Summary

Modifier and Type	Method	Description
DecoratedKey	decorateKey(ByteBuffer key)	Transform key to object representation of the on-disk format.
Map<Token,Float>	describeOwnership(List<Token> sortedTokens)	Calculate the deltas between tokens in the ring in order to compare relative sizes.
Token	getMaximumToken()	The biggest token for this partitioner, unlike getMinimumToken, this token is actually used and users wanting to include all tokens need to do getMaximumToken().maxKeyBound() Not implemented for the ordered partitioners
int	getMaxTokenSize()
RandomPartitioner.BigIntegerToken	getMinimumToken()
RandomPartitioner.BigIntegerToken	getRandomToken()
RandomPartitioner.BigIntegerToken	getRandomToken(Random random)
RandomPartitioner.BigIntegerToken	getToken(ByteBuffer key)
Token.TokenFactory	getTokenFactory()
AbstractType<?>	getTokenValidator()
Token	midpoint(Token ltoken, Token rtoken)	Calculate a Token representing the approximate "middle" of the given range.
AbstractType<?>	partitionOrdering()
AbstractType<?>	partitionOrdering(AbstractType<?> partitionKeyType)	Abstract type that orders the same way as DecoratedKeys provided by this partitioner.
boolean	preservesOrder()
Token	split(Token ltoken, Token rtoken, double ratioToLeft)	Calculate a Token which take approximate 0 <= ratioToLeft <= 1 ownership of the given range.
Optional<Splitter>	splitter()

Methods inherited from class java.lang.Object

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

Field Details

ZERO

public static final BigInteger ZERO

MINIMUM

public static final RandomPartitioner.BigIntegerToken MINIMUM

MAXIMUM

public static final BigInteger MAXIMUM

MAXIMUM_TOKEN_SIZE

public static final int MAXIMUM_TOKEN_SIZE

instance

public static final RandomPartitioner instance

partitionOrdering

public static final PartitionerDefinedOrder partitionOrdering

Constructor Details

RandomPartitioner

public RandomPartitioner()

Method Details

decorateKey

public DecoratedKey decorateKey(ByteBuffer key)

Description copied from interface: IPartitioner

Transform key to object representation of the on-disk format.

Specified by:

decorateKey in interface IPartitioner

Parameters:

key - the raw, client-facing key

Returns:

decorated version of key

midpoint

public Token midpoint(Token ltoken,
 Token rtoken)

Description copied from interface: IPartitioner

Calculate a Token representing the approximate "middle" of the given range.

Specified by:

midpoint in interface IPartitioner

Returns:

The approximate midpoint between left and right.

split

public Token split(Token ltoken,
 Token rtoken,
 double ratioToLeft)

Description copied from interface: IPartitioner

Calculate a Token which take approximate 0 <= ratioToLeft <= 1 ownership of the given range.

Specified by:

split in interface IPartitioner

getMinimumToken

public RandomPartitioner.BigIntegerToken getMinimumToken()

Specified by:

getMinimumToken in interface IPartitioner

Returns:

A Token smaller than all others in the range that is being partitioned. Not legal to assign to a node or key. (But legal to use in range scans.)

getRandomToken

public RandomPartitioner.BigIntegerToken getRandomToken()

Specified by:

getRandomToken in interface IPartitioner

Returns:

a randomly generated token

getRandomToken

public RandomPartitioner.BigIntegerToken getRandomToken(Random random)

Specified by:

getRandomToken in interface IPartitioner

Parameters:

random - instance of Random to use when generating the token

Returns:

a randomly generated token

getTokenFactory

public Token.TokenFactory getTokenFactory()

Specified by:

getTokenFactory in interface IPartitioner

preservesOrder

public boolean preservesOrder()

Specified by:

preservesOrder in interface IPartitioner

Returns:

True if the implementing class preserves key order in the Tokens it generates.

getToken

public RandomPartitioner.BigIntegerToken getToken(ByteBuffer key)

Specified by:

getToken in interface IPartitioner

Returns:

a Token that can be used to route a given key (This is NOT a method to create a Token from its string representation; for that, use TokenFactory.fromString.)

getMaxTokenSize

public int getMaxTokenSize()

Specified by:

getMaxTokenSize in interface IPartitioner

describeOwnership

public Map<Token,Float> describeOwnership(List<Token> sortedTokens)

Description copied from interface: IPartitioner

Calculate the deltas between tokens in the ring in order to compare relative sizes.

Specified by:

describeOwnership in interface IPartitioner

Parameters:

sortedTokens - a sorted List of Tokens

Returns:

the mapping from 'token' to 'percentage of the ring owned by that token'.

getMaximumToken

public Token getMaximumToken()

Description copied from interface: IPartitioner

The biggest token for this partitioner, unlike getMinimumToken, this token is actually used and users wanting to include all tokens need to do getMaximumToken().maxKeyBound() Not implemented for the ordered partitioners

Specified by:

getMaximumToken in interface IPartitioner

getTokenValidator

public AbstractType<?> getTokenValidator()

Specified by:

getTokenValidator in interface IPartitioner

partitionOrdering

public AbstractType<?> partitionOrdering()

Specified by:

partitionOrdering in interface IPartitioner

partitionOrdering

public AbstractType<?> partitionOrdering(AbstractType<?> partitionKeyType)

Description copied from interface: IPartitioner

Abstract type that orders the same way as DecoratedKeys provided by this partitioner. Used by secondary indices.

Specified by:

partitionOrdering in interface IPartitioner

Parameters:

partitionKeyType - partition key type for PartitionerDefinedOrder

splitter

public Optional<Splitter> splitter()

Specified by:

splitter in interface IPartitioner