com.netflix.hollow.core.read.engine

Class HollowReadStateEngine

java.lang.Object

com.netflix.hollow.core.read.engine.HollowReadStateEngine

All Implemented Interfaces:

HollowDataset, HollowStateEngine, HollowDataAccess

public class HollowReadStateEngine
extends java.lang.Object
implements HollowStateEngine, HollowDataAccess

A HollowReadStateEngine is our main handle to the current state of a Hollow dataset as a data consumer.

A dataset changes over time. A core concept in Hollow is that the timeline for a changing dataset can be broken down into discrete data states, each of which is a complete snapshot of the data at a particular point in time. Data consumers handle data states with a HollowReadStateEngine.

Constructor Summary

Constructors

Constructor and Description
HollowReadStateEngine()
HollowReadStateEngine(ArraySegmentRecycler recycler)
HollowReadStateEngine(boolean listenToAllPopulatedOrdinals)
HollowReadStateEngine(HollowObjectHashCodeFinder hashCodeFinder)
HollowReadStateEngine(HollowObjectHashCodeFinder hashCodeFinder, boolean listenToAllPopulatedOrdinals, ArraySegmentRecycler recycler)

Method Summary

Methods

Modifier and Type	Method and Description
void	addTypeListener(java.lang.String typeName, HollowTypeStateListener listener) Add a HollowTypeStateListener to a type.
protected void	addTypeState(HollowTypeReadState typeState)
protected void	afterInitialization()
java.util.Collection<java.lang.String>	getAllTypes()
long	getCurrentRandomizedTag()
HollowObjectHashCodeFinder	getHashCodeFinder()
java.lang.String	getHeaderTag(java.lang.String name)
java.util.Map<java.lang.String,java.lang.String>	getHeaderTags()
ArraySegmentRecycler	getMemoryRecycler()
MissingDataHandler	getMissingDataHandler()
HollowSchema	getSchema(java.lang.String type)
java.util.List<HollowSchema>	getSchemas()
HollowTypeDataAccess	getTypeDataAccess(java.lang.String type)
HollowTypeDataAccess	getTypeDataAccess(java.lang.String type, int ordinal)
HollowTypeReadState	getTypeState(java.lang.String type)
java.util.Collection<HollowTypeReadState>	getTypeStates()
java.util.Set<java.lang.String>	getTypesWithDefinedHashCodes()
boolean	hasSampleResults()
void	invalidate()
boolean	isListenToAllPopulatedOrdinals()
void	resetSampling()
void	setCurrentRandomizedTag(long currentRandomizedTag)
void	setHeaderTags(java.util.Map<java.lang.String,java.lang.String> headerTags)
void	setMissingDataHandler(MissingDataHandler handler)
boolean	updatedLastCycle()

Methods inherited from class java.lang.Object

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

Constructor Detail

HollowReadStateEngine

public HollowReadStateEngine()

HollowReadStateEngine

public HollowReadStateEngine(HollowObjectHashCodeFinder hashCodeFinder)

HollowReadStateEngine

public HollowReadStateEngine(boolean listenToAllPopulatedOrdinals)

HollowReadStateEngine

public HollowReadStateEngine(ArraySegmentRecycler recycler)

HollowReadStateEngine

public HollowReadStateEngine(HollowObjectHashCodeFinder hashCodeFinder,
                     boolean listenToAllPopulatedOrdinals,
                     ArraySegmentRecycler recycler)

Method Detail

getHashCodeFinder

public HollowObjectHashCodeFinder getHashCodeFinder()

Specified by:

getHashCodeFinder in interface HollowDataAccess

addTypeState

protected void addTypeState(HollowTypeReadState typeState)

addTypeListener

public void addTypeListener(java.lang.String typeName,
                   HollowTypeStateListener listener)

Add a HollowTypeStateListener to a type.

getTypeDataAccess

public HollowTypeDataAccess getTypeDataAccess(java.lang.String type)

Specified by:

getTypeDataAccess in interface HollowDataAccess

Returns:

The handle to data for a specific type in this dataset.

getTypeDataAccess

public HollowTypeDataAccess getTypeDataAccess(java.lang.String type,
                                     int ordinal)

Specified by:

getTypeDataAccess in interface HollowDataAccess

Parameters:

type - The type name

ordinal - optional parameter. When known, may provide a more optimal data access implementation for traversal of historical data access.

Returns:

The handle to data for a specific type in this dataset.

getAllTypes

public java.util.Collection<java.lang.String> getAllTypes()

Specified by:

getAllTypes in interface HollowDataAccess

Returns:

The names of all types in this dataset

getTypeState

public HollowTypeReadState getTypeState(java.lang.String type)

getTypeStates

public java.util.Collection<HollowTypeReadState> getTypeStates()

getMemoryRecycler

public ArraySegmentRecycler getMemoryRecycler()

isListenToAllPopulatedOrdinals

public boolean isListenToAllPopulatedOrdinals()

getSchemas

public java.util.List<HollowSchema> getSchemas()

Specified by:

getSchemas in interface HollowDataset

Specified by:

getSchemas in interface HollowStateEngine

Specified by:

getSchemas in interface HollowDataAccess

Returns:

the schemas for all types in this dataset.

getSchema

public HollowSchema getSchema(java.lang.String type)

Specified by:

getSchema in interface HollowDataset

Specified by:

getSchema in interface HollowStateEngine

Specified by:

getSchema in interface HollowDataAccess

Returns:

the schema for the specified type in this dataset.

afterInitialization

protected void afterInitialization()

setMissingDataHandler

public void setMissingDataHandler(MissingDataHandler handler)

getMissingDataHandler

public MissingDataHandler getMissingDataHandler()

Specified by:

getMissingDataHandler in interface HollowDataAccess

setHeaderTags

public void setHeaderTags(java.util.Map<java.lang.String,java.lang.String> headerTags)

getHeaderTags

public java.util.Map<java.lang.String,java.lang.String> getHeaderTags()

Specified by:

getHeaderTags in interface HollowStateEngine

getHeaderTag

public java.lang.String getHeaderTag(java.lang.String name)

Specified by:

getHeaderTag in interface HollowStateEngine

invalidate

public void invalidate()

resetSampling

public void resetSampling()

Specified by:

resetSampling in interface HollowDataAccess

hasSampleResults

public boolean hasSampleResults()

Specified by:

hasSampleResults in interface HollowDataAccess

updatedLastCycle

public boolean updatedLastCycle()

getTypesWithDefinedHashCodes

public java.util.Set<java.lang.String> getTypesWithDefinedHashCodes()

getCurrentRandomizedTag

public long getCurrentRandomizedTag()

setCurrentRandomizedTag

public void setCurrentRandomizedTag(long currentRandomizedTag)