io.rtr.alchemy.identities

Class Identity

java.lang.Object

io.rtr.alchemy.identities.Identity

public abstract class Identity
extends Object

Identifies a unique entity whose hash code is used for treatments allocation

Field Summary

Fields

Modifier and Type	Field and Description
protected static Set<String>	EMPTY

Constructor Summary

Constructors

Constructor and Description
Identity()

Method Summary

Methods

Modifier and Type	Method and Description
protected AttributesMap.Builder	attributes() Convenience method for getting an attributes map builder
abstract AttributesMap	computeAttributes() generates a list of attributes that describe this identity for filtering
long	computeHash(int seed, Set<String> hashAttributes, AttributesMap attributes) generates a hash code used to assign identity to treatment
static <T extends Identity> Set<String>	getSupportedAttributes(Class<T> clazz) Get a list of possible attribute values that can be returned by this identity
protected IdentityBuilder	identity(int seed) Convenience method for getting an identity builder given a seed

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY

protected static final Set<String> EMPTY

Constructor Detail

Identity

public Identity()

Method Detail

computeHash

public long computeHash(int seed,
               Set<String> hashAttributes,
               AttributesMap attributes)

generates a hash code used to assign identity to treatment

Parameters:

seed - a seed value to randomize the resulting hash from experiment to experiment for the same identity

hashAttributes - a set of attributes that should be used to compute the hash code

attributes - a map of attribute values

computeAttributes

public abstract AttributesMap computeAttributes()

generates a list of attributes that describe this identity for filtering

identity

protected IdentityBuilder identity(int seed)

Convenience method for getting an identity builder given a seed

attributes

protected AttributesMap.Builder attributes()

Convenience method for getting an attributes map builder

getSupportedAttributes

public static <T extends Identity> Set<String> getSupportedAttributes(Class<T> clazz)

Get a list of possible attribute values that can be returned by this identity