Package org.apache.fluo.api.client.scanner

Interface ScannerBuilder

public interface ScannerBuilder

Since:

1.0.0

Method Summary

Modifier and Type	Method	Description
CellScanner	build()
RowScannerBuilder	byRow()	Call this to build a row scanner.
ScannerBuilder	fetch(Collection<Column> columns)	Passing in a Column with only the family set will fetch the entire column family.
ScannerBuilder	fetch(Column... columns)	Passing in a Column with only the family set will fetch the entire column family.
default ScannerBuilder	over(CharSequence row)
default ScannerBuilder	over(CharSequence row, Column col)
default ScannerBuilder	over(Bytes row)
default ScannerBuilder	over(Bytes row, Column col)
ScannerBuilder	over(Span span)
default ScannerBuilder	overPrefix(CharSequence rowPrefix)
default ScannerBuilder	overPrefix(CharSequence row, Column colPrefix)
default ScannerBuilder	overPrefix(Bytes rowPrefix)
default ScannerBuilder	overPrefix(Bytes row, Column colPrefix)

Method Detail

over

ScannerBuilder over(Span span)

Parameters:

span - restrict the scanner to data within span

Returns:

self

over

default ScannerBuilder over(Bytes row)

Parameters:

row - restrict the scanner to data in an exact row

Returns:

self

Since:

1.2.0

See Also:

Span.exact(Bytes)

over

default ScannerBuilder over(CharSequence row)

Parameters:

row - restrict the scanner to data in an exact row. String parameters will be encoded as UTF-8

Returns:

self

Since:

1.2.0

See Also:

Span.exact(CharSequence)

over

default ScannerBuilder over(Bytes row,
                            Column col)

Parameters:

row - restrict the scanner to data in an exact row

col - restrict the scanner to data in exact Column.

Since:

1.2.0

See Also:

Span.exact(Bytes, Column)

over

default ScannerBuilder over(CharSequence row,
                            Column col)

Parameters:

row - restrict the scanner to data in an exact row

col - restrict the scanner to data in exact Column.

Returns:

self

Since:

1.2.0

See Also:

Span.exact(CharSequence, Column)

overPrefix

default ScannerBuilder overPrefix(Bytes rowPrefix)

Parameters:

rowPrefix - restrict the scanner to data in rows that begins with a prefix

Returns:

self

Since:

1.2.0

See Also:

Span.prefix(Bytes)

overPrefix

default ScannerBuilder overPrefix(CharSequence rowPrefix)

Parameters:

rowPrefix - restrict the scanner to data in rows that begins with a prefix.

Returns:

self

Since:

1.2.0

See Also:

Span.prefix(CharSequence)

overPrefix

default ScannerBuilder overPrefix(Bytes row,
                                  Column colPrefix)

Parameters:

row - restrict the scanner to data in an exact row.

colPrefix - restrict scanner to data that begins with a specific Column prefix.

Returns:

self

Since:

1.2.0

See Also:

Span.prefix(Bytes, Column)

overPrefix

default ScannerBuilder overPrefix(CharSequence row,
                                  Column colPrefix)

Parameters:

row - restrict the scanner to data in an exact row.

colPrefix - restrict scanner to data that begins with a specific Column prefix.

Returns:

self

Since:

1.2.0

See Also:

Span.prefix(CharSequence, Column)

fetch

ScannerBuilder fetch(Column... columns)

Passing in a Column with only the family set will fetch the entire column family.

Parameters:

columns - restrict the scanner to only these columns

Returns:

self

fetch

ScannerBuilder fetch(Collection<Column> columns)

Passing in a Column with only the family set will fetch the entire column family.

Parameters:

columns - restrict the scanner to only these columns

Returns:

self

build

CellScanner build()

Returns:

a new scanner created with any previously set restrictions

byRow

RowScannerBuilder byRow()

Call this to build a row scanner.

Returns:

a row scanner builder using any previously set restrictions