com.netflix.hollow.core.index

Class HollowSparseIntegerSet

java.lang.Object

com.netflix.hollow.core.index.HollowSparseIntegerSet

All Implemented Interfaces:

HollowTypeStateListener

public class HollowSparseIntegerSet
extends java.lang.Object
implements HollowTypeStateListener

Create hollow integer set for sparse non-negative & unique integer values referenced by fieldPath in a type based on a predicate.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	HollowSparseIntegerSet.IndexPredicate

Field Summary

Fields

Modifier and Type	Field and Description
protected com.netflix.hollow.core.index.HollowSparseIntegerSet.SparseBitSet	sparseBitSetVolatile

Constructor Summary

Constructors

Constructor and Description
HollowSparseIntegerSet(HollowReadStateEngine readStateEngine, java.lang.String type, java.lang.String fieldPath) Create a index for integer values pointed by the given field path.
HollowSparseIntegerSet(HollowReadStateEngine readStateEngine, java.lang.String type, java.lang.String fieldPath, HollowSparseIntegerSet.IndexPredicate predicate) Create a index for integer values based on the given IndexPredicate.

Method Summary

Modifier and Type	Method and Description
void	addedOrdinal(int ordinal) Called once for each record which is added to the registered type.
void	beginUpdate() Called immediately before a delta update is applied to the state engine
protected void	build()
int	cardinality()
protected void	compact()
void	detachFromDeltaUpdates() Stop delta updates for this index.
void	endUpdate() Called immediately after a delta update is applied to the state engine.
boolean	get(int i) Check if the given value is contained in the set (or if the given value satisfies the predicate condition.)
protected void	initSet(int maxValue)
void	listenForDeltaUpdates() Use this method to keep the index updated with delta changes on the read state engine.
void	removedOrdinal(int ordinal) Called once for each record which is removed from the registered type.
protected void	set(int ordinal)
long	size() Estimate the total number of bits used to represent the integer set.

Methods inherited from class java.lang.Object

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

Field Detail

sparseBitSetVolatile

protected volatile com.netflix.hollow.core.index.HollowSparseIntegerSet.SparseBitSet sparseBitSetVolatile

Constructor Detail

HollowSparseIntegerSet

public HollowSparseIntegerSet(HollowReadStateEngine readStateEngine,
                              java.lang.String type,
                              java.lang.String fieldPath)

Create a index for integer values pointed by the given field path.

Parameters:

readStateEngine - the read state

type - the type name

fieldPath - the field path

HollowSparseIntegerSet

public HollowSparseIntegerSet(HollowReadStateEngine readStateEngine,
                              java.lang.String type,
                              java.lang.String fieldPath,
                              HollowSparseIntegerSet.IndexPredicate predicate)

Create a index for integer values based on the given IndexPredicate.

Parameters:

readStateEngine - HollowReadStateEngine to read data set.

type - type which contains the path to integer values for indexing.

fieldPath - path to the integer values

predicate - implementation of IndexPredicate, indicating if the record passes the condition for indexing.

Method Detail

build

protected void build()

initSet

protected void initSet(int maxValue)

set

protected void set(int ordinal)

compact

protected void compact()

get

public boolean get(int i)

Check if the given value is contained in the set (or if the given value satisfies the predicate condition.)

Parameters:

i - the integer value

Returns:

true if the value is present

size

public long size()

Estimate the total number of bits used to represent the integer set.

Returns:

Calculates the total number of bits used by longs in underlying data structure.

cardinality

public int cardinality()

Returns:

the total number of integers added to the set.

listenForDeltaUpdates

public void listenForDeltaUpdates()

Use this method to keep the index updated with delta changes on the read state engine. Remember to call detachFromDeltaUpdates to stop the delta changes. NOTE: Each delta updates creates a new prefix index and swaps the new with current.

detachFromDeltaUpdates

public void detachFromDeltaUpdates()

Stop delta updates for this index.

beginUpdate

public void beginUpdate()

Description copied from interface: HollowTypeStateListener

Called immediately before a delta update is applied to the state engine

Specified by:

beginUpdate in interface HollowTypeStateListener

addedOrdinal

public void addedOrdinal(int ordinal)

Description copied from interface: HollowTypeStateListener

Called once for each record which is added to the registered type.

Specified by:

addedOrdinal in interface HollowTypeStateListener

Parameters:

ordinal - the ordinal of an object that was added

removedOrdinal

public void removedOrdinal(int ordinal)

Description copied from interface: HollowTypeStateListener

Called once for each record which is removed from the registered type.

Specified by:

removedOrdinal in interface HollowTypeStateListener

Parameters:

ordinal - the ordinal of an object that was removed

endUpdate

public void endUpdate()

Description copied from interface: HollowTypeStateListener

Called immediately after a delta update is applied to the state engine.

Specified by:

endUpdate in interface HollowTypeStateListener