org.apache.hadoop.hbase.io.hfile

Class HFile.FileInfo

java.lang.Object

org.apache.hadoop.hbase.io.hfile.HFile.FileInfo

All Implemented Interfaces:

Map<byte[],byte[]>, SortedMap<byte[],byte[]>

Enclosing class:

HFile

public static class HFile.FileInfo
extends Object
implements SortedMap<byte[],byte[]>

Metadata for this file. Conjured by the writer. Read in by the reader.

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Field Summary

Fields

Modifier and Type	Field and Description
(package private) static byte[]	AVG_KEY_LEN
(package private) static byte[]	AVG_VALUE_LEN
(package private) static byte[]	COMPARATOR
(package private) static byte[]	CREATE_TIME_TS
(package private) static byte[]	LASTKEY
private SortedMap<byte[],byte[]>	map
static byte[]	MAX_TAGS_LEN
(package private) static String	RESERVED_PREFIX
(package private) static byte[]	RESERVED_PREFIX_BYTES
(package private) static byte[]	TAGS_COMPRESSED

Constructor Summary

Constructors

Constructor and Description
FileInfo()

Method Summary

Modifier and Type	Method and Description
HFile.FileInfo	append(byte[] k, byte[] v, boolean checkPrefix) Append the given key/value pair to the file info, optionally checking the key prefix.
void	clear()
Comparator<? super byte[]>	comparator()
boolean	containsKey(Object key)
boolean	containsValue(Object value)
Set<Map.Entry<byte[],byte[]>>	entrySet()
boolean	equals(Object o)
byte[]	firstKey()
byte[]	get(Object key)
int	hashCode()
SortedMap<byte[],byte[]>	headMap(byte[] toKey)
boolean	isEmpty()
Set<byte[]>	keySet()
byte[]	lastKey()
(package private) void	parsePB(org.apache.hadoop.hbase.shaded.protobuf.generated.HFileProtos.FileInfoProto fip) Fill our map with content of the pb we read off disk
(package private) void	parseWritable(DataInputStream in) Now parse the old Writable format.
byte[]	put(byte[] key, byte[] value)
void	putAll(Map<? extends byte[],? extends byte[]> m)
(package private) void	read(DataInputStream in) Populate this instance with what we find on the passed in in stream.
byte[]	remove(Object key)
int	size()
SortedMap<byte[],byte[]>	subMap(byte[] fromKey, byte[] toKey)
SortedMap<byte[],byte[]>	tailMap(byte[] fromKey)
Collection<byte[]>	values()
(package private) void	write(DataOutputStream out) Write out this instance on the passed in out stream.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Field Detail

RESERVED_PREFIX

static final String RESERVED_PREFIX

See Also:

Constant Field Values

RESERVED_PREFIX_BYTES

static final byte[] RESERVED_PREFIX_BYTES

LASTKEY

static final byte[] LASTKEY

AVG_KEY_LEN

static final byte[] AVG_KEY_LEN

AVG_VALUE_LEN

static final byte[] AVG_VALUE_LEN

CREATE_TIME_TS

static final byte[] CREATE_TIME_TS

COMPARATOR

static final byte[] COMPARATOR

TAGS_COMPRESSED

static final byte[] TAGS_COMPRESSED

MAX_TAGS_LEN

public static final byte[] MAX_TAGS_LEN

map

private final SortedMap<byte[],byte[]> map

Constructor Detail

FileInfo

public FileInfo()

Method Detail

append

public HFile.FileInfo append(byte[] k,
                             byte[] v,
                             boolean checkPrefix)
                      throws IOException

Append the given key/value pair to the file info, optionally checking the key prefix.

Parameters:

k - key to add

v - value to add

checkPrefix - whether to check that the provided key does not start with the reserved prefix

Returns:

this file info object

Throws:

IOException - if the key or value is invalid

clear

public void clear()

Specified by:

clear in interface Map<byte[],byte[]>

comparator

public Comparator<? super byte[]> comparator()

Specified by:

comparator in interface SortedMap<byte[],byte[]>

containsKey

public boolean containsKey(Object key)

Specified by:

containsKey in interface Map<byte[],byte[]>

containsValue

public boolean containsValue(Object value)

Specified by:

containsValue in interface Map<byte[],byte[]>

entrySet

public Set<Map.Entry<byte[],byte[]>> entrySet()

Specified by:

entrySet in interface Map<byte[],byte[]>

Specified by:

entrySet in interface SortedMap<byte[],byte[]>

equals

public boolean equals(Object o)

Specified by:

equals in interface Map<byte[],byte[]>

Overrides:

equals in class Object

firstKey

public byte[] firstKey()

Specified by:

firstKey in interface SortedMap<byte[],byte[]>

get

public byte[] get(Object key)

Specified by:

get in interface Map<byte[],byte[]>

hashCode

public int hashCode()

Specified by:

hashCode in interface Map<byte[],byte[]>

Overrides:

hashCode in class Object

headMap

public SortedMap<byte[],byte[]> headMap(byte[] toKey)

Specified by:

headMap in interface SortedMap<byte[],byte[]>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Map<byte[],byte[]>

keySet

public Set<byte[]> keySet()

Specified by:

keySet in interface Map<byte[],byte[]>

Specified by:

keySet in interface SortedMap<byte[],byte[]>

lastKey

public byte[] lastKey()

Specified by:

lastKey in interface SortedMap<byte[],byte[]>

put

public byte[] put(byte[] key,
                  byte[] value)

Specified by:

put in interface Map<byte[],byte[]>

putAll

public void putAll(Map<? extends byte[],? extends byte[]> m)

Specified by:

putAll in interface Map<byte[],byte[]>

remove

public byte[] remove(Object key)

Specified by:

remove in interface Map<byte[],byte[]>

size

public int size()

Specified by:

size in interface Map<byte[],byte[]>

subMap

public SortedMap<byte[],byte[]> subMap(byte[] fromKey,
                                       byte[] toKey)

Specified by:

subMap in interface SortedMap<byte[],byte[]>

tailMap

public SortedMap<byte[],byte[]> tailMap(byte[] fromKey)

Specified by:

tailMap in interface SortedMap<byte[],byte[]>

values

public Collection<byte[]> values()

Specified by:

values in interface Map<byte[],byte[]>

Specified by:

values in interface SortedMap<byte[],byte[]>

write

void write(DataOutputStream out)
    throws IOException

Write out this instance on the passed in out stream. We write it as a protobuf.

Parameters:

out -

Throws:

IOException

See Also:

read(DataInputStream)

read

void read(DataInputStream in)
   throws IOException

Populate this instance with what we find on the passed in in stream. Can deserialize protobuf of old Writables format.

Parameters:

in -

Throws:

IOException

See Also:

write(DataOutputStream)

parseWritable

void parseWritable(DataInputStream in)
            throws IOException

Now parse the old Writable format. It was a list of Map entries. Each map entry was a key and a value of a byte []. The old map format had a byte before each entry that held a code which was short for the key or value type. We know it was a byte [] so in below we just read and dump it.

Throws:

IOException

parsePB

void parsePB(org.apache.hadoop.hbase.shaded.protobuf.generated.HFileProtos.FileInfoProto fip)

Fill our map with content of the pb we read off disk

Parameters:

fip - protobuf message to read