org.apache.hadoop.hbase.regionserver

Class ScannerContext.LimitFields

java.lang.Object

org.apache.hadoop.hbase.regionserver.ScannerContext.LimitFields

Enclosing class:

ScannerContext

private static class ScannerContext.LimitFields
extends Object

The different fields that can be used as limits in calls to InternalScanner.next(java.util.List) and InternalScanner.next(java.util.List)

Field Summary

Fields

Modifier and Type	Field and Description
(package private) int	batch
(package private) long	dataSize
private static int	DEFAULT_BATCH Default values of the limit fields.
private static ScannerContext.LimitScope	DEFAULT_SCOPE Default scope that is assigned to a limit if a scope is not specified.
private static long	DEFAULT_SIZE
private static long	DEFAULT_TIME
(package private) long	heapSize
(package private) ScannerContext.LimitScope	sizeScope
(package private) long	time
(package private) ScannerContext.LimitScope	timeScope

Constructor Summary

Constructors

Constructor and Description
LimitFields() Fields keep their default values.
LimitFields(int batch, ScannerContext.LimitScope sizeScope, long size, long heapSize, ScannerContext.LimitScope timeScope, long time)

Method Summary

Modifier and Type	Method and Description
(package private) boolean	canEnforceBatchLimitFromScope(ScannerContext.LimitScope checkerScope)
(package private) boolean	canEnforceSizeLimitFromScope(ScannerContext.LimitScope checkerScope)
(package private) boolean	canEnforceTimeLimitFromScope(ScannerContext.LimitScope checkerScope)
(package private) void	copy(ScannerContext.LimitFields limitsToCopy)
(package private) int	getBatch()
(package private) long	getDataSize()
(package private) long	getHeapSize()
(package private) ScannerContext.LimitScope	getSizeScope()
(package private) long	getTime()
(package private) ScannerContext.LimitScope	getTimeScope()
(package private) void	setBatch(int batch)
(package private) void	setDataSize(long dataSize)
(package private) void	setFields(int batch, ScannerContext.LimitScope sizeScope, long dataSize, long heapSize, ScannerContext.LimitScope timeScope, long time) Set all fields together.
(package private) void	setHeapSize(long heapSize)
(package private) void	setSizeScope(ScannerContext.LimitScope scope) Change the scope in which the size limit is enforced
(package private) void	setTime(long time)
(package private) void	setTimeScope(ScannerContext.LimitScope scope) Change the scope in which the time limit is enforced
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_BATCH

private static int DEFAULT_BATCH

Default values of the limit fields. Defined such that if a field does NOT change from its default, it will not be enforced

DEFAULT_SIZE

private static long DEFAULT_SIZE

DEFAULT_TIME

private static long DEFAULT_TIME

DEFAULT_SCOPE

private static final ScannerContext.LimitScope DEFAULT_SCOPE

Default scope that is assigned to a limit if a scope is not specified.

batch

int batch

sizeScope

ScannerContext.LimitScope sizeScope

dataSize

long dataSize

heapSize

long heapSize

timeScope

ScannerContext.LimitScope timeScope

time

long time

Constructor Detail

LimitFields

LimitFields()

Fields keep their default values.

LimitFields

LimitFields(int batch,
            ScannerContext.LimitScope sizeScope,
            long size,
            long heapSize,
            ScannerContext.LimitScope timeScope,
            long time)

Method Detail

copy

void copy(ScannerContext.LimitFields limitsToCopy)

setFields

void setFields(int batch,
               ScannerContext.LimitScope sizeScope,
               long dataSize,
               long heapSize,
               ScannerContext.LimitScope timeScope,
               long time)

Set all fields together.

getBatch

int getBatch()

setBatch

void setBatch(int batch)

canEnforceBatchLimitFromScope

boolean canEnforceBatchLimitFromScope(ScannerContext.LimitScope checkerScope)

Parameters:

checkerScope -

Returns:

true when the limit can be enforced from the scope of the checker

getDataSize

long getDataSize()

getHeapSize

long getHeapSize()

setDataSize

void setDataSize(long dataSize)

setHeapSize

void setHeapSize(long heapSize)

getSizeScope

ScannerContext.LimitScope getSizeScope()

Returns:

ScannerContext.LimitScope indicating scope in which the size limit is enforced

setSizeScope

void setSizeScope(ScannerContext.LimitScope scope)

Change the scope in which the size limit is enforced

canEnforceSizeLimitFromScope

boolean canEnforceSizeLimitFromScope(ScannerContext.LimitScope checkerScope)

Parameters:

checkerScope -

Returns:

true when the limit can be enforced from the scope of the checker

getTime

long getTime()

setTime

void setTime(long time)

getTimeScope

ScannerContext.LimitScope getTimeScope()

Returns:

ScannerContext.LimitScope indicating scope in which the time limit is enforced

setTimeScope

void setTimeScope(ScannerContext.LimitScope scope)

Change the scope in which the time limit is enforced

canEnforceTimeLimitFromScope

boolean canEnforceTimeLimitFromScope(ScannerContext.LimitScope checkerScope)

Parameters:

checkerScope -

Returns:

true when the limit can be enforced from the scope of the checker

toString

public String toString()

Overrides:

toString in class Object