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

Interface ColumnPrefix<T>

All Known Implementing Classes:

ApplicationColumnPrefix, AppToFlowColumnPrefix, EntityColumnPrefix, FlowActivityColumnPrefix, FlowRunColumnPrefix, SubApplicationColumnPrefix

public interface ColumnPrefix<T>

Used to represent a partially qualified column, where the actual column name will be composed of a prefix and the remainder of the column qualifier. The prefix can be null, in which case the column qualifier will be completely determined when the values are stored.

Method Summary

Methods

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

Method Detail

store

void store(byte[] rowKey,
         TypedBufferedMutator<T> tableMutator,
         byte[] qualifier,
         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.

qualifier - column qualifier. Nothing gets written when null.

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

attributes - attributes for the mutation that are used by the coprocessor to set/read the cell tags.

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

Throws:

IOException - if there is any exception encountered while doing store operation(sending mutation to the table).

store

void store(byte[] rowKey,
         TypedBufferedMutator<T> tableMutator,
         String qualifier,
         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.

qualifier - column qualifier. Nothing gets written when null.

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

attributes - attributes for the mutation that are used by the coprocessor to set/read the cell tags.

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

Throws:

IOException - if there is any exception encountered while doing store operation(sending mutation to the table).

readResult

Object readResult(org.apache.hadoop.hbase.client.Result result,
                String qualifier)
                  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

qualifier - column qualifier. Nothing gets read when null.

Returns:

result object (can be cast to whatever object was written to) or null when specified column qualifier for this prefix doesn't exist in the result.

Throws:

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

readResults

<K> Map<K,Object> readResults(org.apache.hadoop.hbase.client.Result result,
                            KeyConverter<K> keyConverter)
                          throws IOException

Type Parameters:

K - identifies the type of key converter.

Parameters:

result - from which to read columns.

keyConverter - used to convert column bytes to the appropriate key type

Returns:

the latest values of columns in the column family with this prefix (or all of them if the prefix value is null).

Throws:

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

readResultsWithTimestamps

<K,V> NavigableMap<K,NavigableMap<Long,V>> readResultsWithTimestamps(org.apache.hadoop.hbase.client.Result result,
                                                                   KeyConverter<K> keyConverter)
                                                               throws IOException

Type Parameters:

K - identifies the type of key converter.

V - the type of the values. The values will be cast into that type.

Parameters:

result - from which to reads data with timestamps.

keyConverter - used to convert column bytes to the appropriate key type.

Returns:

the cell values at each respective time in for form {idA={timestamp1->value1}, idA={timestamp2->value2}, idB={timestamp3->value3}, idC={timestamp1->value4}}

Throws:

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

getColumnPrefixBytes

byte[] getColumnPrefixBytes(String qualifierPrefix)

Parameters:

qualifierPrefix - Column qualifier or prefix of qualifier.

Returns:

a byte array encoding column prefix and qualifier/prefix passed.

getColumnPrefixBytes

byte[] getColumnPrefixBytes(byte[] qualifierPrefix)

Parameters:

qualifierPrefix - Column qualifier or prefix of qualifier.

Returns:

a byte array encoding column prefix and qualifier/prefix passed.

getColumnFamilyBytes

byte[] getColumnFamilyBytes()

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

Returns:

a byte array encoding column family for this prefix.

getValueConverter

ValueConverter getValueConverter()

Returns value converter implementation associated with this column prefix.

Returns:

a ValueConverter implementation.