AnyScan (abacus-da 1.9.29 API)

java.lang.Object
- com.landawn.abacus.da.hbase.AnyScan

```
public final class AnyScan
extends Object
```
It's a wrapper of Scan in HBase to reduce the manual conversion between bytes and String/Object.

Since:

0.8

See Also:

http://hbase.apache.org/devapidocs/index.html, Scan

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`AnyScan`	`addColumn(byte[] family, byte[] qualifier)` Adds the column.
`AnyScan`	`addColumn(String family, String qualifier)` Adds the column.
`AnyScan`	`addFamily(byte[] family)` Adds the family.
`AnyScan`	`addFamily(String family)` Adds the family.
`static AnyScan`	`create()`
`static AnyScan`	`createScanFromCursor(org.apache.hadoop.hbase.client.Cursor cursor)` Creates the scan from cursor.
`boolean`	`doLoadColumnFamiliesOnDemand()` Get the logical value indicating whether on-demand CF loading should be allowed.
`boolean`	`equals(Object obj)`
`byte[]`	`getACL()` Gets the acl.
`boolean`	`getAllowPartialResults()` Gets the allow partial results.
`byte[]`	`getAttribute(String name)` Gets the attribute.
`Map<String,byte[]>`	`getAttributesMap()` Gets the attributes map.
`org.apache.hadoop.hbase.security.visibility.Authorizations`	`getAuthorizations()` Gets the authorizations.
`int`	`getBatch()` Gets the batch.
`boolean`	`getCacheBlocks()` Gets the cache blocks.
`int`	`getCaching()` Gets the caching.
`Map<byte[],org.apache.hadoop.hbase.io.TimeRange>`	`getColumnFamilyTimeRange()` Gets the column family time range.
`org.apache.hadoop.hbase.client.Consistency`	`getConsistency()` Returns the consistency level for this operation.
`byte[][]`	`getFamilies()` Gets the families.
`Map<byte[],NavigableSet<byte[]>>`	`getFamilyMap()` Gets the family map.
`org.apache.hadoop.hbase.filter.Filter`	`getFilter()` Gets the filter.
`Map<String,Object>`	`getFingerprint()` Gets the fingerprint.
`String`	`getId()` This method allows you to retrieve the identifier for the operation if one was set.
`org.apache.hadoop.hbase.client.IsolationLevel`	`getIsolationLevel()` Gets the isolation level.
`int`	`getLimit()` Gets the limit.
`Boolean`	`getLoadColumnFamiliesOnDemandValue()` Get the raw loadColumnFamiliesOnDemand setting; if it's not set, can be null.
`long`	`getMaxResultSize()` Gets the max result size.
`int`	`getMaxResultsPerColumnFamily()` Gets the max results per column family.
`int`	`getMaxVersions()` Gets the max versions.
`int`	`getPriority()` Gets the priority.
`org.apache.hadoop.hbase.client.Scan.ReadType`	`getReadType()` Gets the read type.
`int`	`getReplicaId()` Returns region replica id where Query will fetch data from.
`int`	`getRowOffsetPerColumnFamily()` Gets the row offset per column family.
`org.apache.hadoop.hbase.client.metrics.ScanMetrics`	`getScanMetrics()` Deprecated. Use `ResultScanner.getScanMetrics()` instead. And notice that, please do not use this method and `ResultScanner.getScanMetrics()` together, the metrics will be messed up.
`byte[]`	`getStartRow()` Gets the start row.
`byte[]`	`getStopRow()` Gets the stop row.
`org.apache.hadoop.hbase.io.TimeRange`	`getTimeRange()` Gets the time range.
`boolean`	`hasFamilies()` Checks for families.
`boolean`	`hasFilter()` Checks for filter.
`int`	`hashCode()`
`boolean`	`includeStartRow()` Include start row.
`boolean`	`includeStopRow()` Include stop row.
`Boolean`	`isAsyncPrefetch()` Checks if is async prefetch.
`boolean`	`isGetScan()` Checks if is gets the scan.
`boolean`	`isNeedCursorResult()` Checks if is need cursor result.
`boolean`	`isRaw()` Checks if is raw.
`boolean`	`isReversed()` Checks if is reversed.
`boolean`	`isScanMetricsEnabled()` Checks if is scan metrics enabled.
`boolean`	`isSmall()` Deprecated. since 2.0.0. See the comment of `setSmall(boolean)`
`int`	`numFamilies()`
`static AnyScan`	`of(org.apache.hadoop.hbase.client.Get get)`
`static AnyScan`	`of(Object startRow)` Deprecated. use `new Scan().withStartRow(startRow)` instead.
`static AnyScan`	`of(Object startRow, org.apache.hadoop.hbase.filter.Filter filter)` Deprecated. use `new Scan().withStartRow(startRow).setFilter(filter)` instead.
`static AnyScan`	`of(Object startRow, Object stopRow)` Deprecated. use `new Scan().withStartRow(startRow).withStopRow(stopRow)` instead.
`static AnyScan`	`of(org.apache.hadoop.hbase.client.Scan scan)`
`AnyScan`	`readAllVersions()` Read all versions.
`AnyScan`	`readVersions(int maxVersions)`
`AQ`	`setACL(Map<String,org.apache.hadoop.hbase.security.access.Permission> perms)` Sets the ACL.
`AQ`	`setACL(String user, org.apache.hadoop.hbase.security.access.Permission perms)` Sets the ACL.
`AnyScan`	`setAllowPartialResults(boolean allowPartialResults)` Sets the allow partial results.
`AnyScan`	`setAsyncPrefetch(boolean asyncPrefetch)` Sets the async prefetch.
`AOWA`	`setAttribute(String name, Object value)` Sets the attribute.
`AQ`	`setAuthorizations(org.apache.hadoop.hbase.security.visibility.Authorizations authorizations)` Sets the authorizations to be used by this Query.
`AnyScan`	`setBatch(int batch)` Sets the batch.
`AnyScan`	`setCacheBlocks(boolean cacheBlocks)` Sets the cache blocks.
`AnyScan`	`setCaching(int caching)` Sets the caching.
`AnyScan`	`setColumnFamilyTimeRange(byte[] family, long minTimestamp, long maxTimestamp)` Sets the column family time range.
`AnyScan`	`setColumnFamilyTimeRange(String family, long minTimestamp, long maxTimestamp)` Sets the column family time range.
`AQ`	`setConsistency(org.apache.hadoop.hbase.client.Consistency consistency)` Sets the consistency level for this operation.
`AnyScan`	`setFamilyMap(Map<byte[],NavigableSet<byte[]>> familyMap)` Sets the family map.
`AQ`	`setFilter(org.apache.hadoop.hbase.filter.Filter filter)` Apply the specified server-side filter when performing the Query.
`AOWA`	`setId(String id)` This method allows you to set an identifier on an operation.
`AQ`	`setIsolationLevel(org.apache.hadoop.hbase.client.IsolationLevel level)` Set the isolation level for this query.
`AnyScan`	`setLimit(int limit)` Sets the limit.
`AQ`	`setLoadColumnFamiliesOnDemand(boolean value)` Set the value indicating whether loading CFs on demand should be allowed (cluster default is false).
`AnyScan`	`setMaxResultSize(long maxResultSize)` Sets the max result size.
`AnyScan`	`setMaxResultsPerColumnFamily(int limit)` Sets the max results per column family.
`AnyScan`	`setMaxVersions()` Deprecated. It is easy to misunderstand with column family's max versions, so use `readAllVersions()` instead.
`AnyScan`	`setMaxVersions(int maxVersions)` Deprecated. It is easy to misunderstand with column family's max versions, so use `readAllVersions()` instead.
`AnyScan`	`setNeedCursorResult(boolean needCursorResult)` Sets the need cursor result.
`AnyScan`	`setOneRowLimit()` Sets the one row limit.
`AOWA`	`setPriority(int priority)` Sets the priority.
`AnyScan`	`setRaw(boolean raw)` Sets the raw.
`AnyScan`	`setReadType(org.apache.hadoop.hbase.client.Scan.ReadType readType)` Set the read type for this scan.
`AQ`	`setReplicaId(int id)` Specify region replica id where Query will fetch data from.
`AnyScan`	`setReversed(boolean reversed)` Sets the reversed.
`AnyScan`	`setRowOffsetPerColumnFamily(int offset)` Sets the row offset per column family.
`AnyScan`	`setRowPrefixFilter(Object rowPrefix)` Sets the row prefix filter.
`AnyScan`	`setScanMetricsEnabled(boolean enabled)` Sets the scan metrics enabled.
`AnyScan`	`setSmall(boolean small)` Deprecated. since 2.0.0. Use `setLimit(int)` and `setReadType(ReadType)` instead. And for the one rpc optimization, now we will also fetch data when openScanner, and if the number of rows reaches the limit then we will close the scanner automatically which means we will fall back to one rpc.
`AnyScan`	`setStartRow(Object startRow)` Deprecated. use `withStartRow(byte[])` instead. This method may change the inclusive of the stop row to keep compatible with the old behavior.
`AnyScan`	`setStopRow(Object stopRow)` Deprecated. use `withStopRow(byte[])` instead. This method may change the inclusive of the stop row to keep compatible with the old behavior.
`AnyScan`	`setTimeRange(long minStamp, long maxStamp)` Sets the time range.
`AnyScan`	`setTimestamp(long timestamp)` Sets the timestamp.
`AnyScan`	`setTimeStamp(long timestamp)` Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0. Use `setTimestamp(long)` instead
`String`	`toJSON()`
`String`	`toJSON(int maxCols)`
`Map<String,Object>`	`toMap()`
`Map<String,Object>`	`toMap(int maxCols)`
`String`	`toString()`
`String`	`toString(int maxCols)`
`org.apache.hadoop.hbase.client.Scan`	`val()`
`AnyScan`	`withStartRow(Object startRow)` With start row.
`AnyScan`	`withStartRow(Object startRow, boolean inclusive)` With start row.
`AnyScan`	`withStopRow(Object stopRow)` With stop row.
`AnyScan`	`withStopRow(Object stopRow, boolean inclusive)` With stop row.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Method Detail
  - create
```
public static AnyScan create()
```
  - createScanFromCursor
```
public static AnyScan createScanFromCursor(org.apache.hadoop.hbase.client.Cursor cursor)
```
    Creates the scan from cursor.
    
    Parameters:
    
    cursor -
    
    Returns:
  - of
```
@Deprecated
public static AnyScan of(Object startRow)
```
    Deprecated. use new Scan().withStartRow(startRow) instead.
    
    Create a Scan operation starting at the specified row.
    If the specified row does not exist, the Scanner will start from the next closest row after the specified row.
    
    Parameters:
    
    startRow - row to start scanner at or after
    
    Returns:
  - of
```
@Deprecated
public static AnyScan of(Object startRow,
                                      Object stopRow)
```
    Deprecated. use new Scan().withStartRow(startRow).withStopRow(stopRow) instead.
    
    Create a Scan operation for the range of rows specified.
    
    Parameters:
    
    startRow - row to start scanner at or after (inclusive)
    
    stopRow - row to stop scanner before (exclusive)
    
    Returns:
  - of
```
@Deprecated
public static AnyScan of(Object startRow,
                                      org.apache.hadoop.hbase.filter.Filter filter)
```
    Deprecated. use new Scan().withStartRow(startRow).setFilter(filter) instead.
    
    Parameters:
    
    startRow -
    
    filter -
    
    Returns:
  - of
```
public static AnyScan of(org.apache.hadoop.hbase.client.Scan scan)
```
    Parameters:
    
    scan -
    
    Returns:
  - of
```
public static AnyScan of(org.apache.hadoop.hbase.client.Get get)
```
    Parameters:
    
    get -
    
    Returns:
  - val
```
public org.apache.hadoop.hbase.client.Scan val()
```
  - isGetScan
```
public boolean isGetScan()
```
    Checks if is gets the scan.
    
    Returns:
    
    true, if is gets the scan
  - hasFamilies
```
public boolean hasFamilies()
```
    Checks for families.
    
    Returns:
    
    true, if successful
  - numFamilies
```
public int numFamilies()
```
  - getFamilies
```
public byte[][] getFamilies()
```
    Gets the families.
    
    Returns:
  - addFamily
```
public AnyScan addFamily(String family)
```
    Adds the family.
    
    Parameters:
    
    family -
    
    Returns:
  - addFamily
```
public AnyScan addFamily(byte[] family)
```
    Adds the family.
    
    Parameters:
    
    family -
    
    Returns:
  - getFamilyMap
```
public Map<byte[],NavigableSet<byte[]>> getFamilyMap()
```
    Gets the family map.
    
    Returns:
  - setFamilyMap
```
public AnyScan setFamilyMap(Map<byte[],NavigableSet<byte[]>> familyMap)
```
    Sets the family map.
    
    Parameters:
    
    familyMap -
    
    Returns:
  - setColumnFamilyTimeRange
```
public AnyScan setColumnFamilyTimeRange(String family,
                                        long minTimestamp,
                                        long maxTimestamp)
```
    Sets the column family time range.
    
    Parameters:
    
    family -
    
    minTimestamp -
    
    maxTimestamp -
    
    Returns:
  - setColumnFamilyTimeRange
```
public AnyScan setColumnFamilyTimeRange(byte[] family,
                                        long minTimestamp,
                                        long maxTimestamp)
```
    Sets the column family time range.
    
    Parameters:
    
    family -
    
    minTimestamp -
    
    maxTimestamp -
    
    Returns:
  - addColumn
```
public AnyScan addColumn(String family,
                         String qualifier)
```
    Adds the column.
    
    Parameters:
    
    family -
    
    qualifier -
    
    Returns:
  - addColumn
```
public AnyScan addColumn(byte[] family,
                         byte[] qualifier)
```
    Adds the column.
    
    Parameters:
    
    family -
    
    qualifier -
    
    Returns:
  - getTimeRange
```
public org.apache.hadoop.hbase.io.TimeRange getTimeRange()
```
    Gets the time range.
    
    Returns:
  - setTimeRange
```
public AnyScan setTimeRange(long minStamp,
                            long maxStamp)
```
    Sets the time range.
    
    Parameters:
    
    minStamp -
    
    maxStamp -
    
    Returns:
  - setTimestamp
```
public AnyScan setTimestamp(long timestamp)
```
    Sets the timestamp.
    
    Parameters:
    
    timestamp -
    
    Returns:
  - setTimeStamp
```
@Deprecated
public AnyScan setTimeStamp(long timestamp)
```
    Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0. Use setTimestamp(long) instead
    
    Get versions of columns with the specified timestamp. Note, default maximum versions to return is 1. If your time range spans more than one version and you want all versions returned, up the number of versions beyond the defaut.
    
    Parameters:
    
    timestamp - version timestamp
    
    Returns:
    
    this
    
    See Also:
    
    Scan.setMaxVersions(), Scan.setMaxVersions(int)
  - includeStartRow
```
public boolean includeStartRow()
```
    Include start row.
    
    Returns:
    
    true, if successful
  - getStartRow
```
public byte[] getStartRow()
```
    Gets the start row.
    
    Returns:
  - setStartRow
```
@Deprecated
public AnyScan setStartRow(Object startRow)
```
    Deprecated. use withStartRow(byte[]) instead. This method may change the inclusive of the stop row to keep compatible with the old behavior.
    
    Set the start row of the scan.
    If the specified row does not exist, the Scanner will start from the next closest row after the specified row.
    
    Parameters:
    
    startRow - row to start scanner at or after
    
    Returns:
    
    this
    
    Throws:
    
    IllegalArgumentException - if startRow does not meet criteria for a row key (when length exceeds HConstants.MAX_ROW_LENGTH)
  - withStartRow
```
public AnyScan withStartRow(Object startRow)
```
    With start row.
    
    Parameters:
    
    startRow -
    
    Returns:
  - withStartRow
```
public AnyScan withStartRow(Object startRow,
                            boolean inclusive)
```
    With start row.
    
    Parameters:
    
    startRow -
    
    inclusive -
    
    Returns:
  - includeStopRow
```
public boolean includeStopRow()
```
    Include stop row.
    
    Returns:
    
    true, if successful
  - getStopRow
```
public byte[] getStopRow()
```
    Gets the stop row.
    
    Returns:
  - setStopRow
```
@Deprecated
public AnyScan setStopRow(Object stopRow)
```
    Deprecated. use withStopRow(byte[]) instead. This method may change the inclusive of the stop row to keep compatible with the old behavior.
    
    Set the stop row of the scan.
    The scan will include rows that are lexicographically less than the provided stopRow.
    Note: When doing a filter for a rowKey Prefix use setRowPrefixFilter(byte[]). The 'trailing 0' will not yield the desired result.
    
    Parameters:
    
    stopRow - row to end at (exclusive)
    
    Returns:
    
    this
    
    Throws:
    
    IllegalArgumentException - if stopRow does not meet criteria for a row key (when length exceeds HConstants.MAX_ROW_LENGTH)
  - withStopRow
```
public AnyScan withStopRow(Object stopRow)
```
    With stop row.
    
    Parameters:
    
    stopRow -
    
    Returns:
  - withStopRow
```
public AnyScan withStopRow(Object stopRow,
                           boolean inclusive)
```
    With stop row.
    
    Parameters:
    
    stopRow -
    
    inclusive -
    
    Returns:
  - setRowPrefixFilter
```
public AnyScan setRowPrefixFilter(Object rowPrefix)
```
    Sets the row prefix filter.
    
    Parameters:
    
    rowPrefix -
    
    Returns:
  - getMaxVersions
```
public int getMaxVersions()
```
    Gets the max versions.
    
    Returns:
  - setMaxVersions
```
@Deprecated
public AnyScan setMaxVersions(int maxVersions)
```
    Deprecated. It is easy to misunderstand with column family's max versions, so use readAllVersions() instead.
    
    Get all available versions.
    
    Parameters:
    
    maxVersions -
    
    Returns:
    
    this
  - setMaxVersions
```
@Deprecated
public AnyScan setMaxVersions()
```
    Deprecated. It is easy to misunderstand with column family's max versions, so use readAllVersions() instead.
    
    Get all available versions.
    
    Returns:
    
    this
  - readVersions
```
public AnyScan readVersions(int maxVersions)
```
    Parameters:
    
    maxVersions -
    
    Returns:
  - readAllVersions
```
public AnyScan readAllVersions()
```
    Read all versions.
    
    Returns:
  - getBatch
```
public int getBatch()
```
    Gets the batch.
    
    Returns:
  - setBatch
```
public AnyScan setBatch(int batch)
```
    Sets the batch.
    
    Parameters:
    
    batch -
    
    Returns:
  - getMaxResultsPerColumnFamily
```
public int getMaxResultsPerColumnFamily()
```
    Gets the max results per column family.
    
    Returns:
  - setMaxResultsPerColumnFamily
```
public AnyScan setMaxResultsPerColumnFamily(int limit)
```
    Sets the max results per column family.
    
    Parameters:
    
    limit -
    
    Returns:
  - getRowOffsetPerColumnFamily
```
public int getRowOffsetPerColumnFamily()
```
    Gets the row offset per column family.
    
    Returns:
  - setRowOffsetPerColumnFamily
```
public AnyScan setRowOffsetPerColumnFamily(int offset)
```
    Sets the row offset per column family.
    
    Parameters:
    
    offset -
    
    Returns:
  - getCaching
```
public int getCaching()
```
    Gets the caching.
    
    Returns:
  - setCaching
```
public AnyScan setCaching(int caching)
```
    Sets the caching.
    
    Parameters:
    
    caching -
    
    Returns:
  - getCacheBlocks
```
public boolean getCacheBlocks()
```
    Gets the cache blocks.
    
    Returns:
  - setCacheBlocks
```
public AnyScan setCacheBlocks(boolean cacheBlocks)
```
    Sets the cache blocks.
    
    Parameters:
    
    cacheBlocks -
    
    Returns:
  - getMaxResultSize
```
public long getMaxResultSize()
```
    Gets the max result size.
    
    Returns:
  - setMaxResultSize
```
public AnyScan setMaxResultSize(long maxResultSize)
```
    Sets the max result size.
    
    Parameters:
    
    maxResultSize -
    
    Returns:
  - getLimit
```
public int getLimit()
```
    Gets the limit.
    
    Returns:
  - setLimit
```
public AnyScan setLimit(int limit)
```
    Sets the limit.
    
    Parameters:
    
    limit -
    
    Returns:
  - setOneRowLimit
```
public AnyScan setOneRowLimit()
```
    Sets the one row limit.
    
    Returns:
  - hasFilter
```
public boolean hasFilter()
```
    Checks for filter.
    
    Returns:
    
    true, if successful
  - isReversed
```
public boolean isReversed()
```
    Checks if is reversed.
    
    Returns:
    
    true, if is reversed
  - setReversed
```
public AnyScan setReversed(boolean reversed)
```
    Sets the reversed.
    
    Parameters:
    
    reversed -
    
    Returns:
  - getAllowPartialResults
```
public boolean getAllowPartialResults()
```
    Gets the allow partial results.
    
    Returns:
  - setAllowPartialResults
```
public AnyScan setAllowPartialResults(boolean allowPartialResults)
```
    Sets the allow partial results.
    
    Parameters:
    
    allowPartialResults -
    
    Returns:
  - isRaw
```
public boolean isRaw()
```
    Checks if is raw.
    
    Returns:
    
    true, if is raw
  - setRaw
```
public AnyScan setRaw(boolean raw)
```
    Sets the raw.
    
    Parameters:
    
    raw -
    
    Returns:
  - isSmall
```
@Deprecated
public boolean isSmall()
```
    Deprecated. since 2.0.0. See the comment of setSmall(boolean)
    
    Get whether this scan is a small scan.
    
    Returns:
    
    true if small scan
  - setSmall
```
@Deprecated
public AnyScan setSmall(boolean small)
```
    Deprecated. since 2.0.0. Use setLimit(int) and setReadType(ReadType) instead. And for the one rpc optimization, now we will also fetch data when openScanner, and if the number of rows reaches the limit then we will close the scanner automatically which means we will fall back to one rpc.
    
    Set whether this scan is a small scan
    Small scan should use pread and big scan can use seek + read seek + read is fast but can cause two problem (1) resource contention (2) cause too much network io [89-fb] Using pread for non-compaction read request https://issues.apache.org/jira/browse/HBASE-7266 On the other hand, if setting it true, we would do openScanner,next,closeScanner in one RPC call. It means the better performance for small scan. [HBASE-9488]. Generally, if the scan range is within one data block(64KB), it could be considered as a small scan.
    
    Parameters:
    
    small -
    
    Returns:
    
    See Also:
    
    Scan.setLimit(int), Scan.setReadType(ReadType)
  - isScanMetricsEnabled
```
public boolean isScanMetricsEnabled()
```
    Checks if is scan metrics enabled.
    
    Returns:
    
    true, if is scan metrics enabled
  - setScanMetricsEnabled
```
public AnyScan setScanMetricsEnabled(boolean enabled)
```
    Sets the scan metrics enabled.
    
    Parameters:
    
    enabled -
    
    Returns:
  - getScanMetrics
```
@Deprecated
public org.apache.hadoop.hbase.client.metrics.ScanMetrics getScanMetrics()
```
    Deprecated. Use ResultScanner.getScanMetrics() instead. And notice that, please do not use this method and ResultScanner.getScanMetrics() together, the metrics will be messed up.
    
    Gets the scan metrics.
    
    Returns:
    
    Metrics on this Scan, if metrics were enabled.
    
    See Also:
    
    Scan.setScanMetricsEnabled(boolean)
  - isAsyncPrefetch
```
public Boolean isAsyncPrefetch()
```
    Checks if is async prefetch.
    
    Returns:
  - setAsyncPrefetch
```
public AnyScan setAsyncPrefetch(boolean asyncPrefetch)
```
    Sets the async prefetch.
    
    Parameters:
    
    asyncPrefetch -
    
    Returns:
  - getReadType
```
public org.apache.hadoop.hbase.client.Scan.ReadType getReadType()
```
    Gets the read type.
    
    Returns:
  - setReadType
```
public AnyScan setReadType(org.apache.hadoop.hbase.client.Scan.ReadType readType)
```
    Set the read type for this scan.
    Notice that we may choose to use pread even if you specific Scan.ReadType.STREAM here. For example, we will always use pread if this is a get scan.
    
    Parameters:
    
    readType -
    
    Returns:
    
    this
  - isNeedCursorResult
```
public boolean isNeedCursorResult()
```
    Checks if is need cursor result.
    
    Returns:
    
    true, if is need cursor result
  - setNeedCursorResult
```
public AnyScan setNeedCursorResult(boolean needCursorResult)
```
    Sets the need cursor result.
    
    Parameters:
    
    needCursorResult -
    
    Returns:
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
    
    Parameters:
    
    obj -
    
    Returns:
    
    true, if successful
  - toString
```
public String toString()
```
  - getFilter
```
public org.apache.hadoop.hbase.filter.Filter getFilter()
```
    Gets the filter.
    
    Returns:
    
    Filter
  - setFilter
```
public AQ setFilter(org.apache.hadoop.hbase.filter.Filter filter)
```
    Apply the specified server-side filter when performing the Query. Only Filter.filterCell(org.apache.hadoop.hbase.Cell) is called AFTER all tests for ttl, column match, deletes and column family's max versions have been run.
    
    Parameters:
    
    filter - filter to run on the server
    
    Returns:
    
    this for invocation chaining
  - getAuthorizations
```
public org.apache.hadoop.hbase.security.visibility.Authorizations getAuthorizations()
                                                                             throws org.apache.hadoop.hbase.exceptions.DeserializationException
```
    Gets the authorizations.
    
    Returns:
    
    The authorizations this Query is associated with.
    
    Throws:
    
    org.apache.hadoop.hbase.exceptions.DeserializationException - the deserialization exception
  - setAuthorizations
```
public AQ setAuthorizations(org.apache.hadoop.hbase.security.visibility.Authorizations authorizations)
```
    Sets the authorizations to be used by this Query.
    
    Parameters:
    
    authorizations -
    
    Returns:
  - getACL
```
public byte[] getACL()
```
    Gets the acl.
    
    Returns:
    
    The serialized ACL for this operation, or null if none
  - setACL
```
public AQ setACL(String user,
                 org.apache.hadoop.hbase.security.access.Permission perms)
```
    Sets the ACL.
    
    Parameters:
    
    user - User short name
    
    perms - Permissions for the user
    
    Returns:
  - setACL
```
public AQ setACL(Map<String,org.apache.hadoop.hbase.security.access.Permission> perms)
```
    Sets the ACL.
    
    Parameters:
    
    perms - A map of permissions for a user or users
    
    Returns:
  - getConsistency
```
public org.apache.hadoop.hbase.client.Consistency getConsistency()
```
    Returns the consistency level for this operation.
    
    Returns:
  - setConsistency
```
public AQ setConsistency(org.apache.hadoop.hbase.client.Consistency consistency)
```
    Sets the consistency level for this operation.
    
    Parameters:
    
    consistency - the consistency level
    
    Returns:
  - getReplicaId
```
public int getReplicaId()
```
    Returns region replica id where Query will fetch data from.
    
    Returns:
    
    region replica id or -1 if not set.
  - setReplicaId
```
public AQ setReplicaId(int id)
```
    Specify region replica id where Query will fetch data from. Use this together with setConsistency(Consistency) passing Consistency.TIMELINE to read data from a specific replicaId.
    Expert: This is an advanced API exposed. Only use it if you know what you are doing
    
    Parameters:
    
    id -
    
    Returns:
  - getIsolationLevel
```
public org.apache.hadoop.hbase.client.IsolationLevel getIsolationLevel()
```
    Gets the isolation level.
    
    Returns:
    
    The isolation level of this query. If no isolation level was set for this query object, then it returns READ_COMMITTED. The IsolationLevel for this query
  - setIsolationLevel
```
public AQ setIsolationLevel(org.apache.hadoop.hbase.client.IsolationLevel level)
```
    Set the isolation level for this query. If the isolation level is set to READ_UNCOMMITTED, then this query will return data from committed and uncommitted transactions. If the isolation level is set to READ_COMMITTED, then this query will return data from committed transactions only. If a isolation level is not explicitly set on a Query, then it is assumed to be READ_COMMITTED.
    
    Parameters:
    
    level - IsolationLevel for this query
    
    Returns:
  - getLoadColumnFamiliesOnDemandValue
```
public Boolean getLoadColumnFamiliesOnDemandValue()
```
    Get the raw loadColumnFamiliesOnDemand setting; if it's not set, can be null.
    
    Returns:
  - setLoadColumnFamiliesOnDemand
```
public AQ setLoadColumnFamiliesOnDemand(boolean value)
```
    Set the value indicating whether loading CFs on demand should be allowed (cluster default is false). On-demand CF loading doesn't load column families until necessary, e.g. if you filter on one column, the other column family data will be loaded only for the rows that are included in result, not all rows like in normal case. With column-specific filters, like SingleColumnValueFilter w/filterIfMissing == true, this can deliver huge perf gains when there's a cf with lots of data; however, it can also lead to some inconsistent results, as follows: - if someone does a concurrent update to both column families in question you may get a row that never existed, e.g. for { rowKey = 5, { cat_videos => 1 }, { video => "my cat" } } someone puts rowKey 5 with { cat_videos => 0 }, { video => "my dog" }, concurrent scan filtering on "cat_videos == 1" can get { rowKey = 5, { cat_videos => 1 }, { video => "my dog" } }. - if there's a concurrent split and you have more than 2 column families, some rows may be missing some column families.
    
    Parameters:
    
    value -
    
    Returns:
  - doLoadColumnFamiliesOnDemand
```
public boolean doLoadColumnFamiliesOnDemand()
```
    Get the logical value indicating whether on-demand CF loading should be allowed.
    
    Returns:
    
    true, if successful
  - getColumnFamilyTimeRange
```
public Map<byte[],org.apache.hadoop.hbase.io.TimeRange> getColumnFamilyTimeRange()
```
    Gets the column family time range.
    
    Returns:
    
    A map of column families to time ranges
  - getAttribute
```
public byte[] getAttribute(String name)
```
    Gets the attribute.
    
    Parameters:
    
    name -
    
    Returns:
  - getAttributesMap
```
public Map<String,byte[]> getAttributesMap()
```
    Gets the attributes map.
    
    Returns:
  - setAttribute
```
public AOWA setAttribute(String name,
                         Object value)
```
    Sets the attribute.
    
    Parameters:
    
    name -
    
    value -
    
    Returns:
  - getId
```
public String getId()
```
    This method allows you to retrieve the identifier for the operation if one was set.
    
    Returns:
  - setId
```
public AOWA setId(String id)
```
    This method allows you to set an identifier on an operation. The original motivation for this was to allow the identifier to be used in slow query logging, but this could obviously be useful in other places. One use of this could be to put a class.method identifier in here to see where the slow query is coming from.
    
    Parameters:
    
    id - id to set for the scan
    
    Returns:
  - getPriority
```
public int getPriority()
```
    Gets the priority.
    
    Returns:
  - setPriority
```
public AOWA setPriority(int priority)
```
    Sets the priority.
    
    Parameters:
    
    priority -
    
    Returns:
  - getFingerprint
```
public Map<String,Object> getFingerprint()
```
    Gets the fingerprint.
    
    Returns:
  - toMap
```
public Map<String,Object> toMap()
```
  - toMap
```
public Map<String,Object> toMap(int maxCols)
```
    Parameters:
    
    maxCols -
    
    Returns:
  - toJSON
```
public String toJSON()
```
  - toJSON
```
public String toJSON(int maxCols)
```
    Parameters:
    
    maxCols -
    
    Returns:
  - toString
```
public String toString(int maxCols)
```
    Parameters:
    
    maxCols -
    
    Returns:

Class AnyScan

Method Summary

Methods inherited from class java.lang.Object

Method Detail

create

createScanFromCursor

of

of

of

of

of

val

isGetScan

hasFamilies

numFamilies

getFamilies

addFamily

addFamily

getFamilyMap

setFamilyMap

setColumnFamilyTimeRange

setColumnFamilyTimeRange

addColumn

addColumn

getTimeRange

setTimeRange

setTimestamp

setTimeStamp

includeStartRow

getStartRow

setStartRow

withStartRow

withStartRow

includeStopRow

getStopRow

setStopRow

withStopRow

withStopRow

setRowPrefixFilter

getMaxVersions

setMaxVersions

setMaxVersions

readVersions

readAllVersions

getBatch

setBatch

getMaxResultsPerColumnFamily

setMaxResultsPerColumnFamily

getRowOffsetPerColumnFamily

setRowOffsetPerColumnFamily

getCaching

setCaching

getCacheBlocks

setCacheBlocks

getMaxResultSize

setMaxResultSize

getLimit

setLimit

setOneRowLimit

hasFilter

isReversed

setReversed

getAllowPartialResults

setAllowPartialResults

isRaw

setRaw

isSmall

setSmall

isScanMetricsEnabled

setScanMetricsEnabled

getScanMetrics

isAsyncPrefetch

setAsyncPrefetch

getReadType

setReadType

isNeedCursorResult

setNeedCursorResult

hashCode

equals

toString