org.apache.hadoop.hbase.thrift.generated
Class TScan

java.lang.Object
  extended by org.apache.hadoop.hbase.thrift.generated.TScan
All Implemented Interfaces:
Serializable, Cloneable, Comparable<TScan>, org.apache.thrift.TBase<TScan,TScan._Fields>

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

A Scan object is used to specify scanner parameters when opening a scanner.

See Also:
Serialized Form

Nested Class Summary
static class TScan._Fields
          The set of fields this struct contains, along with convenience methods for finding and manipulating them.
 
Field Summary
 int caching
           
 List<ByteBuffer> columns
           
 ByteBuffer filterString
           
static Map<TScan._Fields,org.apache.thrift.meta_data.FieldMetaData> metaDataMap
           
 ByteBuffer startRow
           
 ByteBuffer stopRow
           
 long timestamp
           
 
Constructor Summary
TScan()
           
TScan(TScan other)
          Performs a deep copy on other.
 
Method Summary
 void addToColumns(ByteBuffer elem)
           
 ByteBuffer bufferForFilterString()
           
 ByteBuffer bufferForStartRow()
           
 ByteBuffer bufferForStopRow()
           
 void clear()
           
 int compareTo(TScan other)
           
 TScan deepCopy()
           
 boolean equals(Object that)
           
 boolean equals(TScan that)
           
 TScan._Fields fieldForId(int fieldId)
           
 int getCaching()
           
 List<ByteBuffer> getColumns()
           
 Iterator<ByteBuffer> getColumnsIterator()
           
 int getColumnsSize()
           
 Object getFieldValue(TScan._Fields field)
           
 byte[] getFilterString()
           
 byte[] getStartRow()
           
 byte[] getStopRow()
           
 long getTimestamp()
           
 int hashCode()
           
 boolean isSet(TScan._Fields field)
          Returns true if field corresponding to fieldID is set (has been assigned a value) and false otherwise
 boolean isSetCaching()
          Returns true if field caching is set (has been assigned a value) and false otherwise
 boolean isSetColumns()
          Returns true if field columns is set (has been assigned a value) and false otherwise
 boolean isSetFilterString()
          Returns true if field filterString is set (has been assigned a value) and false otherwise
 boolean isSetStartRow()
          Returns true if field startRow is set (has been assigned a value) and false otherwise
 boolean isSetStopRow()
          Returns true if field stopRow is set (has been assigned a value) and false otherwise
 boolean isSetTimestamp()
          Returns true if field timestamp is set (has been assigned a value) and false otherwise
 void read(org.apache.thrift.protocol.TProtocol iprot)
           
 TScan setCaching(int caching)
           
 void setCachingIsSet(boolean value)
           
 TScan setColumns(List<ByteBuffer> columns)
           
 void setColumnsIsSet(boolean value)
           
 void setFieldValue(TScan._Fields field, Object value)
           
 TScan setFilterString(byte[] filterString)
           
 TScan setFilterString(ByteBuffer filterString)
           
 void setFilterStringIsSet(boolean value)
           
 TScan setStartRow(byte[] startRow)
           
 TScan setStartRow(ByteBuffer startRow)
           
 void setStartRowIsSet(boolean value)
           
 TScan setStopRow(byte[] stopRow)
           
 TScan setStopRow(ByteBuffer stopRow)
           
 void setStopRowIsSet(boolean value)
           
 TScan setTimestamp(long timestamp)
           
 void setTimestampIsSet(boolean value)
           
 String toString()
           
 void unsetCaching()
           
 void unsetColumns()
           
 void unsetFilterString()
           
 void unsetStartRow()
           
 void unsetStopRow()
           
 void unsetTimestamp()
           
 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

startRow

public ByteBuffer startRow

stopRow

public ByteBuffer stopRow

timestamp

public long timestamp

columns

public List<ByteBuffer> columns

caching

public int caching

filterString

public ByteBuffer filterString

metaDataMap

public static final Map<TScan._Fields,org.apache.thrift.meta_data.FieldMetaData> metaDataMap
Constructor Detail

TScan

public TScan()

TScan

public TScan(TScan other)
Performs a deep copy on other.

Method Detail

deepCopy

public TScan deepCopy()
Specified by:
deepCopy in interface org.apache.thrift.TBase<TScan,TScan._Fields>

clear

public void clear()
Specified by:
clear in interface org.apache.thrift.TBase<TScan,TScan._Fields>

getStartRow

public byte[] getStartRow()

bufferForStartRow

public ByteBuffer bufferForStartRow()

setStartRow

public TScan setStartRow(byte[] startRow)

setStartRow

public TScan setStartRow(ByteBuffer startRow)

unsetStartRow

public void unsetStartRow()

isSetStartRow

public boolean isSetStartRow()
Returns true if field startRow is set (has been assigned a value) and false otherwise


setStartRowIsSet

public void setStartRowIsSet(boolean value)

getStopRow

public byte[] getStopRow()

bufferForStopRow

public ByteBuffer bufferForStopRow()

setStopRow

public TScan setStopRow(byte[] stopRow)

setStopRow

public TScan setStopRow(ByteBuffer stopRow)

unsetStopRow

public void unsetStopRow()

isSetStopRow

public boolean isSetStopRow()
Returns true if field stopRow is set (has been assigned a value) and false otherwise


setStopRowIsSet

public void setStopRowIsSet(boolean value)

getTimestamp

public long getTimestamp()

setTimestamp

public TScan setTimestamp(long timestamp)

unsetTimestamp

public void unsetTimestamp()

isSetTimestamp

public boolean isSetTimestamp()
Returns true if field timestamp is set (has been assigned a value) and false otherwise


setTimestampIsSet

public void setTimestampIsSet(boolean value)

getColumnsSize

public int getColumnsSize()

getColumnsIterator

public Iterator<ByteBuffer> getColumnsIterator()

addToColumns

public void addToColumns(ByteBuffer elem)

getColumns

public List<ByteBuffer> getColumns()

setColumns

public TScan setColumns(List<ByteBuffer> columns)

unsetColumns

public void unsetColumns()

isSetColumns

public boolean isSetColumns()
Returns true if field columns is set (has been assigned a value) and false otherwise


setColumnsIsSet

public void setColumnsIsSet(boolean value)

getCaching

public int getCaching()

setCaching

public TScan setCaching(int caching)

unsetCaching

public void unsetCaching()

isSetCaching

public boolean isSetCaching()
Returns true if field caching is set (has been assigned a value) and false otherwise


setCachingIsSet

public void setCachingIsSet(boolean value)

getFilterString

public byte[] getFilterString()

bufferForFilterString

public ByteBuffer bufferForFilterString()

setFilterString

public TScan setFilterString(byte[] filterString)

setFilterString

public TScan setFilterString(ByteBuffer filterString)

unsetFilterString

public void unsetFilterString()

isSetFilterString

public boolean isSetFilterString()
Returns true if field filterString is set (has been assigned a value) and false otherwise


setFilterStringIsSet

public void setFilterStringIsSet(boolean value)

setFieldValue

public void setFieldValue(TScan._Fields field,
                          Object value)
Specified by:
setFieldValue in interface org.apache.thrift.TBase<TScan,TScan._Fields>

getFieldValue

public Object getFieldValue(TScan._Fields field)
Specified by:
getFieldValue in interface org.apache.thrift.TBase<TScan,TScan._Fields>

isSet

public boolean isSet(TScan._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<TScan,TScan._Fields>

equals

public boolean equals(Object that)
Overrides:
equals in class Object

equals

public boolean equals(TScan that)

hashCode

public int hashCode()
Overrides:
hashCode in class Object

compareTo

public int compareTo(TScan other)
Specified by:
compareTo in interface Comparable<TScan>

fieldForId

public TScan._Fields fieldForId(int fieldId)
Specified by:
fieldForId in interface org.apache.thrift.TBase<TScan,TScan._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<TScan,TScan._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<TScan,TScan._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


Copyright © 2012 The Apache Software Foundation. All Rights Reserved.