Package cz.o2.proxima.direct.core.view

Class LocalCachedPartitionedView

java.lang.Object

cz.o2.proxima.direct.core.view.LocalCachedPartitionedView

All Implemented Interfaces:

AttributeWriterBase, OnlineAttributeWriter, RandomAccessReader, CachedView, java.io.Closeable, java.lang.AutoCloseable

public class LocalCachedPartitionedView
extends java.lang.Object
implements CachedView

A transformation view from CommitLogReader to CachedView.

Nested Class Summary

Nested classes/interfaces inherited from interface cz.o2.proxima.direct.core.AttributeWriterBase

AttributeWriterBase.Type

Nested classes/interfaces inherited from interface cz.o2.proxima.direct.core.view.CachedView

CachedView.Factory

Nested classes/interfaces inherited from interface cz.o2.proxima.direct.core.randomaccess.RandomAccessReader

RandomAccessReader.GetRequest<T>, RandomAccessReader.Listing, RandomAccessReader.MultiFetch

Constructor Summary

Constructors

Constructor	Description
LocalCachedPartitionedView(EntityDescriptor entity, CommitLogReader reader, OnlineAttributeWriter writer)
LocalCachedPartitionedView(EntityDescriptor entity, CommitLogReader reader, OnlineAttributeWriter writer, long keepCachedDuration)

Method Summary

Modifier and Type	Method	Description
CachedView.Factory	asFactory()	Convert instance of this view to CachedView.Factory suitable for serialization.
void	assign(java.util.Collection<Partition> partitions, BiConsumer<StreamElement,Pair<java.lang.Long,java.lang.Object>> updateCallback, java.time.Duration ttl)	Assign and make given partitions accessible by random reads.
void	cache(StreamElement element)	Cache given StreamElement into local cache without writing it to the underlying writer.
void	close()	Close allocated resources of this writer.
RandomOffset	fetchOffset(RandomAccessReader.Listing type, java.lang.String key)	Construct Offset from string (representing either key of the entity or attribute).
<T> java.util.Optional<KeyValue<T>>	get(java.lang.String key, java.lang.String attribute, AttributeDescriptor<T> desc, long stamp)	Retrieve data stored under given (key, attribute) pair (if any).
java.util.Collection<Partition>	getAssigned()	Retrieve currently assigned partitions.
EntityDescriptor	getEntityDescriptor()	Retrieve entity associated with this reader.
java.util.Optional<ObserveHandle>	getRunningHandle()	Retrieve a running handle (if present).
CommitLogReader	getUnderlyingReader()	Retrieve underlying CommitLogReader.
OnlineAttributeWriter	getUnderlyingWriter()	Retrieve underlying OnlineAttributeWriter.
java.net.URI	getUri()	Retrieve URI of this writer.
void	listEntities(RandomOffset offset, int limit, Consumer<Pair<RandomOffset,java.lang.String>> consumer)	List all entity keys with offset and limit.
protected void	onCache(StreamElement element, boolean overwrite)
<T> void	scanWildcard(java.lang.String key, AttributeDescriptor<T> wildcard, RandomOffset offset, long stamp, int limit, Consumer<KeyValue<T>> consumer)	List data stored for a particular wildcard attribute.
void	scanWildcardAll(java.lang.String key, RandomOffset offset, long stamp, int limit, Consumer<KeyValue<?>> consumer)	Scan all data stored per given key.
void	write(StreamElement data, CommitCallback statusCallback)	Write given serialized attribute value to given entity.

Methods inherited from class java.lang.Object

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

Methods inherited from interface cz.o2.proxima.direct.core.AttributeWriterBase

bulk, online

Methods inherited from interface cz.o2.proxima.direct.core.view.CachedView

assign, assign, assign, getPartitions

Methods inherited from interface cz.o2.proxima.direct.core.OnlineAttributeWriter

getType, isTransactional, rollback, transactional

Methods inherited from interface cz.o2.proxima.direct.core.randomaccess.RandomAccessReader

get, get, get, get, listEntities, multiFetch, scanWildcard, scanWildcard, scanWildcard, scanWildcardAll, scanWildcardAll, scanWildcardAll

Constructor Detail

LocalCachedPartitionedView

public LocalCachedPartitionedView(EntityDescriptor entity,
                                  CommitLogReader reader,
                                  OnlineAttributeWriter writer)

LocalCachedPartitionedView

public LocalCachedPartitionedView(EntityDescriptor entity,
                                  CommitLogReader reader,
                                  OnlineAttributeWriter writer,
                                  long keepCachedDuration)

Method Detail

onCache

protected void onCache(StreamElement element,
                       boolean overwrite)

assign

public void assign(java.util.Collection<Partition> partitions,
                   BiConsumer<StreamElement,Pair<java.lang.Long,java.lang.Object>> updateCallback,
                   @Nullable
                   java.time.Duration ttl)

Description copied from interface: CachedView

Assign and make given partitions accessible by random reads. If the view contains any partitions not listed in the collection, these partitions are dropped.

Specified by:

assign in interface CachedView

Parameters:

partitions - the partitions to cache locally

updateCallback - function that is called when cache gets updated the function takes the new ingest element and pair of the most recent object that was associated with the key and it's currently associated stamp

ttl - maximaul Duration that an update should be kept in the cache NOTE: this is not a hard limit, it is only a signal, that after this time the element can be removed to free up memory

getAssigned

public java.util.Collection<Partition> getAssigned()

Description copied from interface: CachedView

Retrieve currently assigned partitions.

Specified by:

getAssigned in interface CachedView

Returns:

currently assigned partitions

fetchOffset

public RandomOffset fetchOffset(RandomAccessReader.Listing type,
                                java.lang.String key)

Description copied from interface: RandomAccessReader

Construct Offset from string (representing either key of the entity or attribute). The returned offset represents the first element that is following the given key, in case of equality.

Specified by:

fetchOffset in interface RandomAccessReader

Parameters:

type - the type of the key

key - the key of entity or attribute

Returns:

offset representation of the key

get

public <T> java.util.Optional<KeyValue<T>> get(java.lang.String key,
                                               java.lang.String attribute,
                                               AttributeDescriptor<T> desc,
                                               long stamp)

Description copied from interface: RandomAccessReader

Retrieve data stored under given (key, attribute) pair (if any).

Specified by:

get in interface RandomAccessReader

Type Parameters:

T - value type

Parameters:

key - key of the entity

attribute - name of the attribute

desc - the attribute to search for

stamp - timestamp to relatively to which retrieve the data

Returns:

optional KeyValue if present

scanWildcardAll

public void scanWildcardAll(java.lang.String key,
                            RandomOffset offset,
                            long stamp,
                            int limit,
                            Consumer<KeyValue<?>> consumer)

Description copied from interface: RandomAccessReader

Scan all data stored per given key.

Specified by:

scanWildcardAll in interface RandomAccessReader

Parameters:

key - the key whose KeyValues to scan

offset - offset to start from (next key value will be returned)

stamp - timestamp to relatively to which retrieve the data

limit - how many elements to process at most

consumer - consumer to use for scanning

scanWildcard

public <T> void scanWildcard(java.lang.String key,
                             AttributeDescriptor<T> wildcard,
                             RandomOffset offset,
                             long stamp,
                             int limit,
                             Consumer<KeyValue<T>> consumer)

Description copied from interface: RandomAccessReader

List data stored for a particular wildcard attribute.

Specified by:

scanWildcard in interface RandomAccessReader

Type Parameters:

T - value type

Parameters:

key - key of the entity

wildcard - wildcard attribute to scan

offset - name of attribute (including the prefix) to start from

stamp - timestamp to relatively to which retrieve the data

limit - maximal number of items to consume *

consumer - the consumer to stream data to

listEntities

public void listEntities(RandomOffset offset,
                         int limit,
                         Consumer<Pair<RandomOffset,java.lang.String>> consumer)

Description copied from interface: RandomAccessReader

List all entity keys with offset and limit.

Specified by:

listEntities in interface RandomAccessReader

Parameters:

offset - offset of the entities

limit - limit for number of results

consumer - consumer of results

close

public void close()

Description copied from interface: AttributeWriterBase

Close allocated resources of this writer. This is supposed to be idempotent.

Specified by:

close in interface AttributeWriterBase

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface CachedView

Specified by:

close in interface java.io.Closeable

getEntityDescriptor

public EntityDescriptor getEntityDescriptor()

Description copied from interface: RandomAccessReader

Retrieve entity associated with this reader.

Specified by:

getEntityDescriptor in interface RandomAccessReader

Returns:

entity associated with this reader

write

public void write(StreamElement data,
                  CommitCallback statusCallback)

Description copied from interface: OnlineAttributeWriter

Write given serialized attribute value to given entity.

Specified by:

write in interface OnlineAttributeWriter

Parameters:

data - the data to write

statusCallback - callback used to commit data processing

getUri

public java.net.URI getUri()

Description copied from interface: AttributeWriterBase

Retrieve URI of this writer.

Specified by:

getUri in interface AttributeWriterBase

Returns:

URI of this writer

cache

public void cache(StreamElement element)

Description copied from interface: CachedView

Cache given StreamElement into local cache without writing it to the underlying writer. This is used in conjunction with attribute family proxy.

Specified by:

cache in interface CachedView

Parameters:

element - the data to cache

getUnderlyingReader

public CommitLogReader getUnderlyingReader()

Description copied from interface: CachedView

Retrieve underlying CommitLogReader.

Specified by:

getUnderlyingReader in interface CachedView

getUnderlyingWriter

public OnlineAttributeWriter getUnderlyingWriter()

Description copied from interface: CachedView

Retrieve underlying OnlineAttributeWriter. Note that using this write might not update the cache. In most cases, use OnlineAttributeWriter.write(StreamElement, CommitCallback) directly.

Specified by:

getUnderlyingWriter in interface CachedView

getRunningHandle

public java.util.Optional<ObserveHandle> getRunningHandle()

Description copied from interface: CachedView

Retrieve a running handle (if present).

Specified by:

getRunningHandle in interface CachedView

asFactory

public CachedView.Factory asFactory()

Description copied from interface: CachedView

Convert instance of this view to CachedView.Factory suitable for serialization.

Specified by:

asFactory in interface AttributeWriterBase

Specified by:

asFactory in interface CachedView

Specified by:

asFactory in interface OnlineAttributeWriter

Specified by:

asFactory in interface RandomAccessReader

Returns:

the CachedView.Factory representing this view