org.apache.hadoop.yarn.server.timelineservice.storage.common

Interface Column<T>

All Known Implementing Classes:

ApplicationColumn, EntityColumn, FlowRunColumn, SubApplicationColumn

public interface Column<T>

A Column represents the way to store a fully qualified column in a specific table.

Method Summary

Methods

Modifier and Type	Method and Description
byte[]	getColumnFamilyBytes() Returns column family name(as bytes) associated with this column.
byte[]	getColumnQualifierBytes() Get byte representation for this column qualifier.
ValueConverter	getValueConverter() Returns value converter implementation associated with this column.
Object	readResult(org.apache.hadoop.hbase.client.Result result) Get the latest version of this specified column.
void	store(byte[] rowKey, TypedBufferedMutator<T> tableMutator, Long timestamp, Object inputValue, Attribute... attributes) Sends a Mutation to the table.

Method Detail

store

void store(byte[] rowKey,
         TypedBufferedMutator<T> tableMutator,
         Long timestamp,
         Object inputValue,
         Attribute... attributes)
           throws IOException

Sends a Mutation to the table. The mutations will be buffered and sent over the wire as part of a batch.

Parameters:

rowKey - identifying the row to write. Nothing gets written when null.

tableMutator - used to modify the underlying HBase table. Caller is responsible to pass a mutator for the table that actually has this column.

timestamp - version timestamp. When null the server timestamp will be used.

attributes - Map of attributes for this mutation. used in the coprocessor to set/read the cell tags. Can be null.

inputValue - the value to write to the rowKey and column qualifier. Nothing gets written when null.

Throws:

IOException - if there is any exception encountered during store.

readResult

Object readResult(org.apache.hadoop.hbase.client.Result result)
                  throws IOException

Get the latest version of this specified column. Note: this call clones the value content of the hosting Cell.

Parameters:

result - Cannot be null

Returns:

result object (can be cast to whatever object was written to), or null when result doesn't contain this column.

Throws:

IOException - if there is any exception encountered while reading result.

getColumnFamilyBytes

byte[] getColumnFamilyBytes()

Returns column family name(as bytes) associated with this column.

Returns:

a byte array encoding column family for this column qualifier.

getColumnQualifierBytes

byte[] getColumnQualifierBytes()

Get byte representation for this column qualifier.

Returns:

a byte array representing column qualifier.

getValueConverter

ValueConverter getValueConverter()

Returns value converter implementation associated with this column.

Returns:

a ValueConverter implementation.