org.apache.hadoop.hbase.io.hfile

Class HFileContext

java.lang.Object

org.apache.hadoop.hbase.io.hfile.HFileContext

All Implemented Interfaces:

Cloneable, HeapSize

@InterfaceAudience.Private
public class HFileContext
extends Object
implements HeapSize, Cloneable

Read-only HFile Context Information. Meta data that is used by HFileWriter/Readers and by HFileBlocks. Create one using the HFileContextBuilder (See HFileInfo and the HFile Trailer class).

See Also:

HFileContextBuilder

Field Summary

Fields

Modifier and Type	Field and Description
static long	FIXED_OVERHEAD

Constructor Summary

Constructors

Constructor and Description
HFileContext()
HFileContext(HFileContext context) Copy constructor

Method Summary

Modifier and Type	Method and Description
HFileContext	clone()
int	getBlocksize()
int	getBytesPerChecksum()
CellComparator	getCellComparator()
ChecksumType	getChecksumType()
byte[]	getColumnFamily()
Compression.Algorithm	getCompression()
DataBlockEncoding	getDataBlockEncoding()
Encryption.Context	getEncryptionContext()
long	getFileCreateTime()
String	getHFileName()
IndexBlockEncoding	getIndexBlockEncoding()
byte[]	getTableName()
long	heapSize() HeapSize implementation.
boolean	isCompressedOrEncrypted() Returns true when on-disk blocks are compressed, and/or encrypted; false otherwise.
boolean	isCompressTags()
boolean	isIncludesMvcc()
boolean	isIncludesTags()
boolean	isUseHBaseChecksum()
void	setCompressTags(boolean compressTags)
void	setEncryptionContext(Encryption.Context cryptoContext)
void	setFileCreateTime(long fileCreateTime)
void	setIncludesMvcc(boolean includesMvcc)
void	setIncludesTags(boolean includesTags)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

FIXED_OVERHEAD

public static final long FIXED_OVERHEAD

Constructor Detail

HFileContext

public HFileContext()

HFileContext

public HFileContext(HFileContext context)

Copy constructor

Method Detail

isCompressedOrEncrypted

public boolean isCompressedOrEncrypted()

Returns true when on-disk blocks are compressed, and/or encrypted; false otherwise.

getCompression

public Compression.Algorithm getCompression()

isUseHBaseChecksum

public boolean isUseHBaseChecksum()

isIncludesMvcc

public boolean isIncludesMvcc()

setIncludesMvcc

public void setIncludesMvcc(boolean includesMvcc)

isIncludesTags

public boolean isIncludesTags()

setIncludesTags

public void setIncludesTags(boolean includesTags)

setFileCreateTime

public void setFileCreateTime(long fileCreateTime)

isCompressTags

public boolean isCompressTags()

setCompressTags

public void setCompressTags(boolean compressTags)

getChecksumType

public ChecksumType getChecksumType()

getBytesPerChecksum

public int getBytesPerChecksum()

getBlocksize

public int getBlocksize()

getFileCreateTime

public long getFileCreateTime()

getDataBlockEncoding

public DataBlockEncoding getDataBlockEncoding()

getIndexBlockEncoding

public IndexBlockEncoding getIndexBlockEncoding()

getEncryptionContext

public Encryption.Context getEncryptionContext()

setEncryptionContext

public void setEncryptionContext(Encryption.Context cryptoContext)

getHFileName

public String getHFileName()

getColumnFamily

public byte[] getColumnFamily()

getTableName

public byte[] getTableName()

getCellComparator

public CellComparator getCellComparator()

heapSize

public long heapSize()

HeapSize implementation. NOTE : The heap size should be altered when new state variable are added.

Specified by:

heapSize in interface HeapSize

Returns:

heap size of the HFileContext

clone

public HFileContext clone()

Overrides:

clone in class Object

toString

public String toString()

Overrides:

toString in class Object