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

Class NoOpSearchProvider

java.lang.Object

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

All Implemented Interfaces:

SearchProvider

public class NoOpSearchProvider
extends Object
implements SearchProvider

NoSearchProvider class

This class is for supporting search dimensions which don't have any defined set of dimension rows The find* method's on this class would not throw an exception if the filterValue is not found, instead it would just return a new dimension row matching the filter.

Constructor Summary

Constructors

Constructor and Description
NoOpSearchProvider(int queryWeightLimit) 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.
Pagination<DimensionRow>	findAllDimensionRowsPaged(PaginationParameters paginationParameters) Return the desired page of dimension rows.
TreeSet<DimensionRow>	findAllOrderedDimensionRows() For dimensions with NoOpSearchProvider, the dimension rows are unknown.
Pagination<DimensionRow>	findFilteredDimensionRowsPaged(Set<ApiFilter> filters, PaginationParameters paginationParameters) Return the desired page of dimension rows that match the specified filters.
int	getDimensionCardinality() Get cardinality for the dimension
boolean	isHealthy() Method to check if search provider is healthy.
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.

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

NoOpSearchProvider

public NoOpSearchProvider(int queryWeightLimit)

Constructor.

Parameters:

queryWeightLimit - Weight limit for the query, used as a cardinality approximation for this dimension

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()

Get cardinality for the dimension

For dimensions with NoOpSearchProvider, cardinality is unknown because it doesn't have defined set of dimension rows. For such dimensions we should always calculate the query weight and if query weight is larger than what is configured as package_name__query_weight_limit, the query weight is computed always otherwise it is skipped.

Hence, returning the cardinality value as package_name__query_weight_limit

Specified by:

getDimensionCardinality in interface SearchProvider

Returns:

The dimension cardinality

findAllOrderedDimensionRows

public TreeSet<DimensionRow> findAllOrderedDimensionRows()

For dimensions with NoOpSearchProvider, the dimension rows are unknown. So, returning an empty Set would prevent any NullPointerException.

Specified by:

findAllOrderedDimensionRows in interface SearchProvider

Returns:

empty Set of dimension rows.

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.

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

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

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.