org.apache.hadoop.hbase.thrift.generated

Class ColumnDescriptor

java.lang.Object

org.apache.hadoop.hbase.thrift.generated.ColumnDescriptor

All Implemented Interfaces:

Serializable, Cloneable, Comparable<ColumnDescriptor>, org.apache.thrift.TBase<ColumnDescriptor,ColumnDescriptor._Fields>

public class ColumnDescriptor
extends Object
implements org.apache.thrift.TBase<ColumnDescriptor,ColumnDescriptor._Fields>, Serializable, Cloneable

An HColumnDescriptor contains information about a column family such as the number of versions, compression settings, etc. It is used as input when creating a table or adding a column.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ColumnDescriptor._Fields The set of fields this struct contains, along with convenience methods for finding and manipulating them.

Field Summary

Fields

Modifier and Type	Field and Description
boolean	blockCacheEnabled
int	bloomFilterNbHashes
String	bloomFilterType
int	bloomFilterVectorSize
String	compression
boolean	inMemory
int	maxVersions
static Map<ColumnDescriptor._Fields,org.apache.thrift.meta_data.FieldMetaData>	metaDataMap
ByteBuffer	name
int	timeToLive

Constructor Summary

Constructors

Constructor and Description
ColumnDescriptor()
ColumnDescriptor(ByteBuffer name, int maxVersions, String compression, boolean inMemory, String bloomFilterType, int bloomFilterVectorSize, int bloomFilterNbHashes, boolean blockCacheEnabled, int timeToLive)
ColumnDescriptor(ColumnDescriptor other) Performs a deep copy on other.

Method Summary

Methods

Modifier and Type	Method and Description
ByteBuffer	bufferForName()
void	clear()
int	compareTo(ColumnDescriptor other)
ColumnDescriptor	deepCopy()
boolean	equals(ColumnDescriptor that)
boolean	equals(Object that)
ColumnDescriptor._Fields	fieldForId(int fieldId)
int	getBloomFilterNbHashes()
String	getBloomFilterType()
int	getBloomFilterVectorSize()
String	getCompression()
Object	getFieldValue(ColumnDescriptor._Fields field)
int	getMaxVersions()
byte[]	getName()
int	getTimeToLive()
int	hashCode()
boolean	isBlockCacheEnabled()
boolean	isInMemory()
boolean	isSet(ColumnDescriptor._Fields field) Returns true if field corresponding to fieldID is set (has been assigned a value) and false otherwise
boolean	isSetBlockCacheEnabled() Returns true if field blockCacheEnabled is set (has been assigned a value) and false otherwise
boolean	isSetBloomFilterNbHashes() Returns true if field bloomFilterNbHashes is set (has been assigned a value) and false otherwise
boolean	isSetBloomFilterType() Returns true if field bloomFilterType is set (has been assigned a value) and false otherwise
boolean	isSetBloomFilterVectorSize() Returns true if field bloomFilterVectorSize is set (has been assigned a value) and false otherwise
boolean	isSetCompression() Returns true if field compression is set (has been assigned a value) and false otherwise
boolean	isSetInMemory() Returns true if field inMemory is set (has been assigned a value) and false otherwise
boolean	isSetMaxVersions() Returns true if field maxVersions is set (has been assigned a value) and false otherwise
boolean	isSetName() Returns true if field name is set (has been assigned a value) and false otherwise
boolean	isSetTimeToLive() Returns true if field timeToLive is set (has been assigned a value) and false otherwise
void	read(org.apache.thrift.protocol.TProtocol iprot)
ColumnDescriptor	setBlockCacheEnabled(boolean blockCacheEnabled)
void	setBlockCacheEnabledIsSet(boolean value)
ColumnDescriptor	setBloomFilterNbHashes(int bloomFilterNbHashes)
void	setBloomFilterNbHashesIsSet(boolean value)
ColumnDescriptor	setBloomFilterType(String bloomFilterType)
void	setBloomFilterTypeIsSet(boolean value)
ColumnDescriptor	setBloomFilterVectorSize(int bloomFilterVectorSize)
void	setBloomFilterVectorSizeIsSet(boolean value)
ColumnDescriptor	setCompression(String compression)
void	setCompressionIsSet(boolean value)
void	setFieldValue(ColumnDescriptor._Fields field, Object value)
ColumnDescriptor	setInMemory(boolean inMemory)
void	setInMemoryIsSet(boolean value)
ColumnDescriptor	setMaxVersions(int maxVersions)
void	setMaxVersionsIsSet(boolean value)
ColumnDescriptor	setName(byte[] name)
ColumnDescriptor	setName(ByteBuffer name)
void	setNameIsSet(boolean value)
ColumnDescriptor	setTimeToLive(int timeToLive)
void	setTimeToLiveIsSet(boolean value)
String	toString()
void	unsetBlockCacheEnabled()
void	unsetBloomFilterNbHashes()
void	unsetBloomFilterType()
void	unsetBloomFilterVectorSize()
void	unsetCompression()
void	unsetInMemory()
void	unsetMaxVersions()
void	unsetName()
void	unsetTimeToLive()
void	validate()
void	write(org.apache.thrift.protocol.TProtocol oprot)

Methods inherited from class java.lang.Object

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

Field Detail

name

public ByteBuffer name

maxVersions

public int maxVersions

compression

public String compression

inMemory

public boolean inMemory

bloomFilterType

public String bloomFilterType

bloomFilterVectorSize

public int bloomFilterVectorSize

bloomFilterNbHashes

public int bloomFilterNbHashes

blockCacheEnabled

public boolean blockCacheEnabled

timeToLive

public int timeToLive

metaDataMap

public static final Map<ColumnDescriptor._Fields,org.apache.thrift.meta_data.FieldMetaData> metaDataMap

Constructor Detail

ColumnDescriptor

public ColumnDescriptor()

ColumnDescriptor

public ColumnDescriptor(ByteBuffer name,
                int maxVersions,
                String compression,
                boolean inMemory,
                String bloomFilterType,
                int bloomFilterVectorSize,
                int bloomFilterNbHashes,
                boolean blockCacheEnabled,
                int timeToLive)

ColumnDescriptor

public ColumnDescriptor(ColumnDescriptor other)

Performs a deep copy on other.

Method Detail

deepCopy

public ColumnDescriptor deepCopy()

Specified by:

deepCopy in interface org.apache.thrift.TBase<ColumnDescriptor,ColumnDescriptor._Fields>

clear

public void clear()

Specified by:

clear in interface org.apache.thrift.TBase<ColumnDescriptor,ColumnDescriptor._Fields>

getName

public byte[] getName()

bufferForName

public ByteBuffer bufferForName()

setName

public ColumnDescriptor setName(byte[] name)

setName

public ColumnDescriptor setName(ByteBuffer name)

unsetName

public void unsetName()

isSetName

public boolean isSetName()

Returns true if field name is set (has been assigned a value) and false otherwise

setNameIsSet

public void setNameIsSet(boolean value)

getMaxVersions

public int getMaxVersions()

setMaxVersions

public ColumnDescriptor setMaxVersions(int maxVersions)

unsetMaxVersions

public void unsetMaxVersions()

isSetMaxVersions

public boolean isSetMaxVersions()

Returns true if field maxVersions is set (has been assigned a value) and false otherwise

setMaxVersionsIsSet

public void setMaxVersionsIsSet(boolean value)

getCompression

public String getCompression()

setCompression

public ColumnDescriptor setCompression(String compression)

unsetCompression

public void unsetCompression()

isSetCompression

public boolean isSetCompression()

Returns true if field compression is set (has been assigned a value) and false otherwise

setCompressionIsSet

public void setCompressionIsSet(boolean value)

isInMemory

public boolean isInMemory()

setInMemory

public ColumnDescriptor setInMemory(boolean inMemory)

unsetInMemory

public void unsetInMemory()

isSetInMemory

public boolean isSetInMemory()

Returns true if field inMemory is set (has been assigned a value) and false otherwise

setInMemoryIsSet

public void setInMemoryIsSet(boolean value)

getBloomFilterType

public String getBloomFilterType()

setBloomFilterType

public ColumnDescriptor setBloomFilterType(String bloomFilterType)

unsetBloomFilterType

public void unsetBloomFilterType()

isSetBloomFilterType

public boolean isSetBloomFilterType()

Returns true if field bloomFilterType is set (has been assigned a value) and false otherwise

setBloomFilterTypeIsSet

public void setBloomFilterTypeIsSet(boolean value)

getBloomFilterVectorSize

public int getBloomFilterVectorSize()

setBloomFilterVectorSize

public ColumnDescriptor setBloomFilterVectorSize(int bloomFilterVectorSize)

unsetBloomFilterVectorSize

public void unsetBloomFilterVectorSize()

isSetBloomFilterVectorSize

public boolean isSetBloomFilterVectorSize()

Returns true if field bloomFilterVectorSize is set (has been assigned a value) and false otherwise

setBloomFilterVectorSizeIsSet

public void setBloomFilterVectorSizeIsSet(boolean value)

getBloomFilterNbHashes

public int getBloomFilterNbHashes()

setBloomFilterNbHashes

public ColumnDescriptor setBloomFilterNbHashes(int bloomFilterNbHashes)

unsetBloomFilterNbHashes

public void unsetBloomFilterNbHashes()

isSetBloomFilterNbHashes

public boolean isSetBloomFilterNbHashes()

Returns true if field bloomFilterNbHashes is set (has been assigned a value) and false otherwise

setBloomFilterNbHashesIsSet

public void setBloomFilterNbHashesIsSet(boolean value)

isBlockCacheEnabled

public boolean isBlockCacheEnabled()

setBlockCacheEnabled

public ColumnDescriptor setBlockCacheEnabled(boolean blockCacheEnabled)

unsetBlockCacheEnabled

public void unsetBlockCacheEnabled()

isSetBlockCacheEnabled

public boolean isSetBlockCacheEnabled()

Returns true if field blockCacheEnabled is set (has been assigned a value) and false otherwise

setBlockCacheEnabledIsSet

public void setBlockCacheEnabledIsSet(boolean value)

getTimeToLive

public int getTimeToLive()

setTimeToLive

public ColumnDescriptor setTimeToLive(int timeToLive)

unsetTimeToLive

public void unsetTimeToLive()

isSetTimeToLive

public boolean isSetTimeToLive()

Returns true if field timeToLive is set (has been assigned a value) and false otherwise

setTimeToLiveIsSet

public void setTimeToLiveIsSet(boolean value)

setFieldValue

public void setFieldValue(ColumnDescriptor._Fields field,
                 Object value)

Specified by:

setFieldValue in interface org.apache.thrift.TBase<ColumnDescriptor,ColumnDescriptor._Fields>

getFieldValue

public Object getFieldValue(ColumnDescriptor._Fields field)

Specified by:

getFieldValue in interface org.apache.thrift.TBase<ColumnDescriptor,ColumnDescriptor._Fields>

isSet

public boolean isSet(ColumnDescriptor._Fields field)

Returns true if field corresponding to fieldID is set (has been assigned a value) and false otherwise

Specified by:

isSet in interface org.apache.thrift.TBase<ColumnDescriptor,ColumnDescriptor._Fields>

equals

public boolean equals(Object that)

Overrides:

equals in class Object

equals

public boolean equals(ColumnDescriptor that)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

compareTo

public int compareTo(ColumnDescriptor other)

Specified by:

compareTo in interface Comparable<ColumnDescriptor>

fieldForId

public ColumnDescriptor._Fields fieldForId(int fieldId)

Specified by:

fieldForId in interface org.apache.thrift.TBase<ColumnDescriptor,ColumnDescriptor._Fields>

read

public void read(org.apache.thrift.protocol.TProtocol iprot)
          throws org.apache.thrift.TException

Specified by:

read in interface org.apache.thrift.TBase<ColumnDescriptor,ColumnDescriptor._Fields>

Throws:

org.apache.thrift.TException

write

public void write(org.apache.thrift.protocol.TProtocol oprot)
           throws org.apache.thrift.TException

Specified by:

write in interface org.apache.thrift.TBase<ColumnDescriptor,ColumnDescriptor._Fields>

Throws:

org.apache.thrift.TException

toString

public String toString()

Overrides:

toString in class Object

validate

public void validate()
              throws org.apache.thrift.TException

Throws:

org.apache.thrift.TException