TScan (Apache HBase 1.1.7 API)

java.lang.Object
- org.apache.hadoop.hbase.thrift2.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
```
Any timestamps in the columns are ignored, use timeRange to select by timestamp. Max versions defaults to 1.

See Also:
Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class TScan._Fields
The set of fields this struct contains, along with convenience methods for finding and manipulating them.

Nested Classes
Modifier and Type	Class and Description
`static class`	`TScan._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
`Map<ByteBuffer,ByteBuffer>`	`attributes`
`TAuthorization`	`authorizations`
`int`	`batchSize`
`int`	`caching`
`List<TColumn>`	`columns`
`ByteBuffer`	`filterString`
`int`	`maxVersions`
`static Map<TScan._Fields,org.apache.thrift.meta_data.FieldMetaData>`	`metaDataMap`
`boolean`	`reversed`
`ByteBuffer`	`startRow`
`ByteBuffer`	`stopRow`
`TTimeRange`	`timeRange`

Constructor Summary

Constructors
Constructor and Description

TScan()

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

Constructors
Constructor and Description
`TScan()`
`TScan(TScan other)` Performs a deep copy on other.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addToColumns(TColumn 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)`
`Map<ByteBuffer,ByteBuffer>`	`getAttributes()`
`int`	`getAttributesSize()`
`TAuthorization`	`getAuthorizations()`
`int`	`getBatchSize()`
`int`	`getCaching()`
`List<TColumn>`	`getColumns()`
`Iterator<TColumn>`	`getColumnsIterator()`
`int`	`getColumnsSize()`
`Object`	`getFieldValue(TScan._Fields field)`
`byte[]`	`getFilterString()`
`int`	`getMaxVersions()`
`byte[]`	`getStartRow()`
`byte[]`	`getStopRow()`
`TTimeRange`	`getTimeRange()`
`int`	`hashCode()`
`boolean`	`isReversed()`
`boolean`	`isSet(TScan._Fields field)` Returns true if field corresponding to fieldID is set (has been assigned a value) and false otherwise
`boolean`	`isSetAttributes()` Returns true if field attributes is set (has been assigned a value) and false otherwise
`boolean`	`isSetAuthorizations()` Returns true if field authorizations is set (has been assigned a value) and false otherwise
`boolean`	`isSetBatchSize()` Returns true if field batchSize 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`	`isSetMaxVersions()` Returns true if field maxVersions is set (has been assigned a value) and false otherwise
`boolean`	`isSetReversed()` Returns true if field reversed 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`	`isSetTimeRange()` Returns true if field timeRange is set (has been assigned a value) and false otherwise
`void`	`putToAttributes(ByteBuffer key, ByteBuffer val)`
`void`	`read(org.apache.thrift.protocol.TProtocol iprot)`
`TScan`	`setAttributes(Map<ByteBuffer,ByteBuffer> attributes)`
`void`	`setAttributesIsSet(boolean value)`
`TScan`	`setAuthorizations(TAuthorization authorizations)`
`void`	`setAuthorizationsIsSet(boolean value)`
`TScan`	`setBatchSize(int batchSize)`
`void`	`setBatchSizeIsSet(boolean value)`
`TScan`	`setCaching(int caching)`
`void`	`setCachingIsSet(boolean value)`
`TScan`	`setColumns(List<TColumn> 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`	`setMaxVersions(int maxVersions)`
`void`	`setMaxVersionsIsSet(boolean value)`
`TScan`	`setReversed(boolean reversed)`
`void`	`setReversedIsSet(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`	`setTimeRange(TTimeRange timeRange)`
`void`	`setTimeRangeIsSet(boolean value)`
`String`	`toString()`
`void`	`unsetAttributes()`
`void`	`unsetAuthorizations()`
`void`	`unsetBatchSize()`
`void`	`unsetCaching()`
`void`	`unsetColumns()`
`void`	`unsetFilterString()`
`void`	`unsetMaxVersions()`
`void`	`unsetReversed()`
`void`	`unsetStartRow()`
`void`	`unsetStopRow()`
`void`	`unsetTimeRange()`
`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
```

columns
```
public List<TColumn> columns
```

caching
```
public int caching
```

maxVersions
```
public int maxVersions
```

timeRange
```
public TTimeRange timeRange
```

filterString
```
public ByteBuffer filterString
```

batchSize
```
public int batchSize
```

attributes

public Map<ByteBuffer,ByteBuffer> attributes

authorizations
```
public TAuthorization authorizations
```

reversed
```
public boolean reversed
```

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)

getColumnsSize
```
public int getColumnsSize()
```

getColumnsIterator

public Iterator<TColumn> getColumnsIterator()

addToColumns

public void addToColumns(TColumn elem)

getColumns
```
public List<TColumn> getColumns()
```

setColumns

public TScan setColumns(List<TColumn> 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)

getMaxVersions
```
public int getMaxVersions()
```

setMaxVersions

public TScan 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)

getTimeRange
```
public TTimeRange getTimeRange()
```

setTimeRange

public TScan setTimeRange(TTimeRange timeRange)

unsetTimeRange
```
public void unsetTimeRange()
```

isSetTimeRange
```
public boolean isSetTimeRange()
```
Returns true if field timeRange is set (has been assigned a value) and false otherwise

setTimeRangeIsSet

public void setTimeRangeIsSet(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)

getBatchSize
```
public int getBatchSize()
```

setBatchSize

public TScan setBatchSize(int batchSize)

unsetBatchSize
```
public void unsetBatchSize()
```

isSetBatchSize
```
public boolean isSetBatchSize()
```
Returns true if field batchSize is set (has been assigned a value) and false otherwise

setBatchSizeIsSet

public void setBatchSizeIsSet(boolean value)

getAttributesSize
```
public int getAttributesSize()
```

putToAttributes

public void putToAttributes(ByteBuffer key,
                   ByteBuffer val)

getAttributes

public Map<ByteBuffer,ByteBuffer> getAttributes()

setAttributes

public TScan setAttributes(Map<ByteBuffer,ByteBuffer> attributes)

unsetAttributes
```
public void unsetAttributes()
```

isSetAttributes
```
public boolean isSetAttributes()
```
Returns true if field attributes is set (has been assigned a value) and false otherwise

setAttributesIsSet

public void setAttributesIsSet(boolean value)

getAuthorizations

public TAuthorization getAuthorizations()

setAuthorizations

public TScan setAuthorizations(TAuthorization authorizations)

unsetAuthorizations
```
public void unsetAuthorizations()
```

isSetAuthorizations
```
public boolean isSetAuthorizations()
```
Returns true if field authorizations is set (has been assigned a value) and false otherwise

setAuthorizationsIsSet

public void setAuthorizationsIsSet(boolean value)

isReversed
```
public boolean isReversed()
```

setReversed

public TScan setReversed(boolean reversed)

unsetReversed
```
public void unsetReversed()
```

isSetReversed
```
public boolean isSetReversed()
```
Returns true if field reversed is set (has been assigned a value) and false otherwise

setReversedIsSet

public void setReversedIsSet(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

Class TScan

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

startRow

stopRow

columns

caching

maxVersions

timeRange

filterString

batchSize

attributes

authorizations

reversed

metaDataMap

Constructor Detail

TScan

TScan

Method Detail

deepCopy

clear

getStartRow

bufferForStartRow

setStartRow

setStartRow

unsetStartRow

isSetStartRow

setStartRowIsSet

getStopRow

bufferForStopRow

setStopRow

setStopRow

unsetStopRow

isSetStopRow

setStopRowIsSet

getColumnsSize

getColumnsIterator

addToColumns

getColumns

setColumns

unsetColumns

isSetColumns

setColumnsIsSet

getCaching

setCaching

unsetCaching

isSetCaching

setCachingIsSet

getMaxVersions

setMaxVersions

unsetMaxVersions

isSetMaxVersions

setMaxVersionsIsSet

getTimeRange

setTimeRange

unsetTimeRange

isSetTimeRange

setTimeRangeIsSet

getFilterString

bufferForFilterString

setFilterString

setFilterString

unsetFilterString

isSetFilterString

setFilterStringIsSet

getBatchSize

setBatchSize

unsetBatchSize

isSetBatchSize

setBatchSizeIsSet

getAttributesSize

putToAttributes

getAttributes

setAttributes

unsetAttributes

isSetAttributes