io.cdap.cdap.api.dataset.table

Class Scan

java.lang.Object

io.cdap.cdap.api.dataset.table.Scan

@Beta
public class Scan
extends Object

Scan configuration for Table.

Constructor Summary

Constructors

Constructor and Description
Scan(byte[] startRow, byte[] stopRow) Creates Scan for a given start and stop row keys.
Scan(byte[] startRow, byte[] stopRow, Filter filter) Creates Scan for a given start and stop row keys and filter.

Method Summary

Modifier and Type	Method and Description
Filter	getFilter()
Map<String,String>	getProperties()
byte[]	getStartRow()
byte[]	getStopRow()
void	setProperty(String property, String value) Set a property for the Scan.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Scan

public Scan(@Nullable
            byte[] startRow,
            @Nullable
            byte[] stopRow)

Creates Scan for a given start and stop row keys.

Parameters:

startRow - start row inclusive; null means start from first row of the table

stopRow - stop row exclusive; null means scan all rows to the end of the table

Scan

public Scan(@Nullable
            byte[] startRow,
            @Nullable
            byte[] stopRow,
            @Nullable
            Filter filter)

Creates Scan for a given start and stop row keys and filter.

Parameters:

startRow - start row inclusive; null means start from first row of the table

stopRow - stop row exclusive; null means scan all rows to the end of the table

filter - filter to be used on scan

Method Detail

setProperty

public void setProperty(String property,
                        String value)

Set a property for the Scan. Properties may be used to optimize performance, and may not apply in all environments.

Parameters:

property - the name of the property

value - the value of the property

getStartRow

@Nullable
public byte[] getStartRow()

getStopRow

@Nullable
public byte[] getStopRow()

getFilter

@Nullable
public Filter getFilter()

getProperties

public Map<String,String> getProperties()

toString

public String toString()

Overrides:

toString in class Object