org.apache.samza.table.descriptors

Class GuavaCacheTableDescriptor<K,V>

java.lang.Object

org.apache.samza.table.descriptors.BaseTableDescriptor<K,V,GuavaCacheTableDescriptor<K,V>>

org.apache.samza.table.descriptors.GuavaCacheTableDescriptor<K,V>

Type Parameters:

K - type of the key in the cache

V - type of the value in the cache

All Implemented Interfaces:

TableDescriptor<K,V,GuavaCacheTableDescriptor<K,V>>

public class GuavaCacheTableDescriptor<K,V>
extends BaseTableDescriptor<K,V,GuavaCacheTableDescriptor<K,V>>

Table descriptor for Guava-based caching table.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	GUAVA_CACHE
static java.lang.String	PROVIDER_FACTORY_CLASS_NAME

Fields inherited from class org.apache.samza.table.descriptors.BaseTableDescriptor

config, tableId

Constructor Summary

Constructors

Constructor and Description
GuavaCacheTableDescriptor(java.lang.String tableId) Constructs a table descriptor instance

Method Summary

Modifier and Type	Method and Description
java.lang.String	getProviderFactoryClassName() Return the fully qualified class name of the TableProviderFactory
java.util.Map<java.lang.String,java.lang.String>	toConfig(Config jobConfig) Generate configuration for this table descriptor, the generated configuration should be the complete configuration for this table that can be directly included in the job configuration.
protected void	validate() Validate that this table descriptor is constructed properly; this method is used internally.
GuavaCacheTableDescriptor	withCache(com.google.common.cache.Cache<K,V> cache) Specify a pre-configured Guava cache instance to be used for caching table.

Methods inherited from class org.apache.samza.table.descriptors.BaseTableDescriptor

addTableConfig, getTableId, withConfig

Methods inherited from class java.lang.Object

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

Field Detail

PROVIDER_FACTORY_CLASS_NAME

public static final java.lang.String PROVIDER_FACTORY_CLASS_NAME

See Also:

Constant Field Values

GUAVA_CACHE

public static final java.lang.String GUAVA_CACHE

See Also:

Constant Field Values

Constructor Detail

GuavaCacheTableDescriptor

public GuavaCacheTableDescriptor(java.lang.String tableId)

Constructs a table descriptor instance

Parameters:

tableId - Id of the table, it must conform to pattern [\\d\\w-_]+

Method Detail

withCache

public GuavaCacheTableDescriptor withCache(com.google.common.cache.Cache<K,V> cache)

Specify a pre-configured Guava cache instance to be used for caching table.

Parameters:

cache - Guava cache instance

Returns:

this descriptor

getProviderFactoryClassName

public java.lang.String getProviderFactoryClassName()

Description copied from class: BaseTableDescriptor

Return the fully qualified class name of the TableProviderFactory

Specified by:

getProviderFactoryClassName in class BaseTableDescriptor<K,V,GuavaCacheTableDescriptor<K,V>>

Returns:

class name of the TableProviderFactory

toConfig

public java.util.Map<java.lang.String,java.lang.String> toConfig(Config jobConfig)

Description copied from interface: TableDescriptor

Generate configuration for this table descriptor, the generated configuration should be the complete configuration for this table that can be directly included in the job configuration. Note: although the serdes may have already been set in this instance, their corresponding configuration needs to be generated centrally for consistency and efficiency reasons. Therefore the serde configuration for this table is expected to have already been generated and stored in the jobConfig.

Specified by:

toConfig in interface TableDescriptor<K,V,GuavaCacheTableDescriptor<K,V>>

Overrides:

toConfig in class BaseTableDescriptor<K,V,GuavaCacheTableDescriptor<K,V>>

Parameters:

jobConfig - job configuration

Returns:

table configuration

validate

protected void validate()

Description copied from class: BaseTableDescriptor

Validate that this table descriptor is constructed properly; this method is used internally.

Specified by:

validate in class BaseTableDescriptor<K,V,GuavaCacheTableDescriptor<K,V>>