org.apache.samza.table.descriptors

Class BaseTableDescriptor<K,V,D extends BaseTableDescriptor<K,V,D>>

java.lang.Object

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

Type Parameters:

K - the type of the key in this table

V - the type of the value in this table

D - the type of the concrete table descriptor

All Implemented Interfaces:

TableDescriptor<K,V,D>

Direct Known Subclasses:

GuavaCacheTableDescriptor, HybridTableDescriptor, LocalTableDescriptor, RemoteTableDescriptor

public abstract class BaseTableDescriptor<K,V,D extends BaseTableDescriptor<K,V,D>>
extends java.lang.Object
implements TableDescriptor<K,V,D>

Base class for all table descriptor implementations.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<java.lang.String,java.lang.String>	config
protected java.lang.String	tableId

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BaseTableDescriptor(java.lang.String tableId) Constructs a table descriptor instance

Method Summary

Modifier and Type	Method and Description
protected void	addTableConfig(java.lang.String key, java.lang.String value, java.util.Map<java.lang.String,java.lang.String> tableConfig) Helper method to add a config item to table configuration
abstract java.lang.String	getProviderFactoryClassName() Return the fully qualified class name of the TableProviderFactory
java.lang.String	getTableId() Get the id of the table
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 abstract void	validate() Validate that this table descriptor is constructed properly; this method is used internally.
D	withConfig(java.lang.String key, java.lang.String value) Add a configuration entry for the table

Methods inherited from class java.lang.Object

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

Field Detail

tableId

protected final java.lang.String tableId

config

protected final java.util.Map<java.lang.String,java.lang.String> config

Constructor Detail

BaseTableDescriptor

protected BaseTableDescriptor(java.lang.String tableId)

Constructs a table descriptor instance

Parameters:

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

Method Detail

withConfig

public D withConfig(java.lang.String key,
                    java.lang.String value)

Add a configuration entry for the table

Parameters:

key - the key

value - the value

Returns:

this table descriptor instance

getTableId

public java.lang.String getTableId()

Description copied from interface: TableDescriptor

Get the id of the table

Specified by:

getTableId in interface TableDescriptor<K,V,D extends BaseTableDescriptor<K,V,D>>

Returns:

id of the table

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,D extends BaseTableDescriptor<K,V,D>>

Parameters:

jobConfig - job configuration

Returns:

table configuration

getProviderFactoryClassName

public abstract java.lang.String getProviderFactoryClassName()

Return the fully qualified class name of the TableProviderFactory

Returns:

class name of the TableProviderFactory

validate

protected abstract void validate()

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

addTableConfig

protected void addTableConfig(java.lang.String key,
                              java.lang.String value,
                              java.util.Map<java.lang.String,java.lang.String> tableConfig)

Helper method to add a config item to table configuration

Parameters:

key - key of the config item

value - value of the config item

tableConfig - table configuration