com.yahoo.bard.webservice.data.dimension.impl

Class ScanSearchProvider

java.lang.Object

com.yahoo.bard.webservice.data.dimension.impl.ScanSearchProvider

All Implemented Interfaces:

FilterDimensionRows, SearchProvider

public class ScanSearchProvider
extends Object
implements SearchProvider, FilterDimensionRows

Search provider using scan on dimension rows.

Constructor Summary

Constructors

Constructor and Description
ScanSearchProvider() Constructor.

Method Summary

Modifier and Type	Method and Description
void	clearDimension() Clears the dimension cache, and resets the indices, effectively resetting the SearchProvider to a clean state.
TreeSet<DimensionRow>	containsFilterOperation(TreeSet<DimensionRow> dimensionRows, ApiFilter filter) Contains filter operation.
Pagination<DimensionRow>	findAllDimensionRowsPaged(PaginationParameters paginationParameters) Return the desired page of dimension rows.
TreeSet<DimensionRow>	findAllOrderedDimensionRows() Getter for dimension rows in tree set for consistent order.
DimensionRow	findDimensionRowByKeyValue(String value) Get a dimension row given an id.
Pagination<DimensionRow>	findFilteredDimensionRowsPaged(Set<ApiFilter> filters, PaginationParameters paginationParameters) Return the desired page of dimension rows that match the specified filters.
int	getDimensionCardinality() Gets the number of distinct dimension rows (assuming the key field is unique) in the index.
TreeSet<DimensionRow>	inFilterOperation(TreeSet<DimensionRow> dimensionRows, ApiFilter filter) In-filter operation.
boolean	isHealthy() Method to check if search provider is healthy.
TreeSet<DimensionRow>	notinFilterOperation(TreeSet<DimensionRow> dimensionRows, ApiFilter filter) Notin-filter operation.
void	refreshIndex(Map<String,HashDataCache.Pair<DimensionRow,DimensionRow>> changedRows) Method to add / update indexes.
void	refreshIndex(String rowId, DimensionRow dimensionRow, DimensionRow dimensionRowOld) Method to add / update indexes.
void	setDimension(Dimension dimension) Setter for dimension.
void	setKeyValueStore(KeyValueStore keyValueStore) Setter for store.
TreeSet<DimensionRow>	startswithFilterOperation(TreeSet<DimensionRow> dimensionRows, ApiFilter filter) Startswith-filter operation.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.yahoo.bard.webservice.data.dimension.SearchProvider

findAllDimensionRows, findFilteredDimensionRows, hasAnyRows, replaceIndex

Constructor Detail

ScanSearchProvider

public ScanSearchProvider()

Constructor.

Method Detail

setDimension

public void setDimension(Dimension dimension)

Description copied from interface: SearchProvider

Setter for dimension.

Specified by:

setDimension in interface SearchProvider

Parameters:

dimension - Dimension the SearchProvider is searching

setKeyValueStore

public void setKeyValueStore(KeyValueStore keyValueStore)

Description copied from interface: SearchProvider

Setter for store.

Specified by:

setKeyValueStore in interface SearchProvider

Parameters:

keyValueStore - KeyValueStore that holds the data rows indexed by the Search Provider

getDimensionCardinality

public int getDimensionCardinality()

Description copied from interface: SearchProvider

Gets the number of distinct dimension rows (assuming the key field is unique) in the index.

Specified by:

getDimensionCardinality in interface SearchProvider

Returns:

The number of dimension rows for this dimension

findDimensionRowByKeyValue

public DimensionRow findDimensionRowByKeyValue(String value)

Get a dimension row given an id.

Parameters:

value - dimension id to look up

Returns:

dimension row if exists else null

findAllOrderedDimensionRows

public TreeSet<DimensionRow> findAllOrderedDimensionRows()

Description copied from interface: SearchProvider

Getter for dimension rows in tree set for consistent order. Throws TimeoutException If the search times out.

Specified by:

findAllOrderedDimensionRows in interface SearchProvider

Returns:

tree set of dimension rows the Search Provider has in it's indexes

isHealthy

public boolean isHealthy()

Description copied from interface: SearchProvider

Method to check if search provider is healthy.

Specified by:

isHealthy in interface SearchProvider

Returns:

true if healthy

clearDimension

public void clearDimension()

Description copied from interface: SearchProvider

Clears the dimension cache, and resets the indices, effectively resetting the SearchProvider to a clean state.

Specified by:

clearDimension in interface SearchProvider

refreshIndex

public void refreshIndex(String rowId,
                         DimensionRow dimensionRow,
                         DimensionRow dimensionRowOld)

Description copied from interface: SearchProvider

Method to add / update indexes.

Specified by:

refreshIndex in interface SearchProvider

Parameters:

rowId - Unique ID for the dimension row

dimensionRow - New, updated dimension row

dimensionRowOld - Old dimension row if we're updating one, or null if there is no row for the rowId

refreshIndex

public void refreshIndex(Map<String,HashDataCache.Pair<DimensionRow,DimensionRow>> changedRows)

Description copied from interface: SearchProvider

Method to add / update indexes.

Specified by:

refreshIndex in interface SearchProvider

Parameters:

changedRows - Collection of newRow / oldRow pairs keyed by rowId to update the index with. Each row is a pair of dimension rows (newRow is the key, oldRow is the value), with the rowId (ie. unique key in the dimension) as the top-level Map key.

inFilterOperation

public TreeSet<DimensionRow> inFilterOperation(TreeSet<DimensionRow> dimensionRows,
                                               ApiFilter filter)

Description copied from interface: FilterDimensionRows

In-filter operation.

Specified by:

inFilterOperation in interface FilterDimensionRows

Parameters:

dimensionRows - The unfiltered set of dimension rows

filter - The api filter to be applied to the dimension rows

Returns:

Tree set of DimensionRows

notinFilterOperation

public TreeSet<DimensionRow> notinFilterOperation(TreeSet<DimensionRow> dimensionRows,
                                                  ApiFilter filter)

Description copied from interface: FilterDimensionRows

Notin-filter operation.

Specified by:

notinFilterOperation in interface FilterDimensionRows

Parameters:

dimensionRows - The unfiltered set of dimension rows

filter - The api filter to be applied to the dimension rows

Returns:

Tree set of DimensionRows

startswithFilterOperation

public TreeSet<DimensionRow> startswithFilterOperation(TreeSet<DimensionRow> dimensionRows,
                                                       ApiFilter filter)

Description copied from interface: FilterDimensionRows

Startswith-filter operation.

Specified by:

startswithFilterOperation in interface FilterDimensionRows

Parameters:

dimensionRows - The unfiltered set of dimension rows

filter - The api filter to be applied to the dimension rows

Returns:

Tree set of DimensionRows

containsFilterOperation

public TreeSet<DimensionRow> containsFilterOperation(TreeSet<DimensionRow> dimensionRows,
                                                     ApiFilter filter)

Contains filter operation.

Specified by:

containsFilterOperation in interface FilterDimensionRows

Parameters:

dimensionRows - The unfiltered set of dimension rows

filter - The api filter

Returns:

Tree set of DimensionRows

findAllDimensionRowsPaged

public Pagination<DimensionRow> findAllDimensionRowsPaged(PaginationParameters paginationParameters)

Description copied from interface: SearchProvider

Return the desired page of dimension rows.

Specified by:

findAllDimensionRowsPaged in interface SearchProvider

Parameters:

paginationParameters - The parameters that define a page (i.e. the number of rows per page, and the page of results desired)

Returns:

A page of the dimension rows contained in the Search Provider's indices Throws TimeoutException If the search times out.

findFilteredDimensionRowsPaged

public Pagination<DimensionRow> findFilteredDimensionRowsPaged(Set<ApiFilter> filters,
                                                               PaginationParameters paginationParameters)

Description copied from interface: SearchProvider

Return the desired page of dimension rows that match the specified filters.

Specified by:

findFilteredDimensionRowsPaged in interface SearchProvider

Parameters:

filters - ApiFilters to use for finding matching dimension rows

paginationParameters - The parameters that define a page (i.e. the number of rows per page, and the page of results desired) Throws TimeoutException If the search times out.

Returns:

A page of the dimension rows contained in the Search Provider's indices and matched by the specified filters.