com.yahoo.bard.webservice.data.dimension

Interface SearchProvider

All Known Implementing Classes:

LuceneSearchProvider, NoOpSearchProvider, ScanSearchProvider

public interface SearchProvider

Provides the capability to search through dimension metadata. For example, finding all dimensions whose name contains "page_views."

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.
default Set<DimensionRow>	findAllDimensionRows() Deprecated. Searching for dimension rows is moving to a paginated version (findAllDimensionRowsPaged(com.yahoo.bard.webservice.web.util.PaginationParameters)) in order to give greater control to the caller.
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.
default TreeSet<DimensionRow>	findFilteredDimensionRows(Set<ApiFilter> filters) Deprecated. Searching for filtered dimension rows is moving to a paginated version (findFilteredDimensionRowsPaged(java.util.Set<com.yahoo.bard.webservice.web.ApiFilter>, com.yahoo.bard.webservice.web.util.PaginationParameters)) in order to give greater control to the caller.
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.
default boolean	hasAnyRows(Set<ApiFilter> filters) Determine if any rows match these filters.
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.
default void	replaceIndex(String newLuceneIndexPathString) Replaces index with a new index in hot-swap manner.
void	setDimension(Dimension dimension) Setter for dimension.
void	setKeyValueStore(KeyValueStore keyValueStore) Setter for store.

Method Detail

setDimension

void setDimension(Dimension dimension)

Setter for dimension.

Parameters:

dimension - Dimension the SearchProvider is searching

setKeyValueStore

void setKeyValueStore(KeyValueStore keyValueStore)

Setter for store.

Parameters:

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

getDimensionCardinality

int getDimensionCardinality()

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

Returns:

The number of dimension rows for this dimension

findAllDimensionRows

@Deprecated
default Set<DimensionRow> findAllDimensionRows()

Deprecated. Searching for dimension rows is moving to a paginated version (findAllDimensionRowsPaged(com.yahoo.bard.webservice.web.util.PaginationParameters)) in order to give greater control to the caller.

Getter for dimension rows.

Returns:

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

findAllDimensionRowsPaged

Pagination<DimensionRow> findAllDimensionRowsPaged(@NotNull
                                                   PaginationParameters paginationParameters)

Return the desired page of dimension rows.

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.

findAllOrderedDimensionRows

TreeSet<DimensionRow> findAllOrderedDimensionRows()

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

Returns:

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

findFilteredDimensionRows

@Deprecated
default TreeSet<DimensionRow> findFilteredDimensionRows(Set<ApiFilter> filters)

Deprecated. Searching for filtered dimension rows is moving to a paginated version (findFilteredDimensionRowsPaged(java.util.Set<com.yahoo.bard.webservice.web.ApiFilter>, com.yahoo.bard.webservice.web.util.PaginationParameters)) in order to give greater control to the caller.

Get a set of dimension row(s) given a set of ApiFilters.

Parameters:

filters - ApiFilters to use for finding matching dimension rows

Returns:

set of dimension row(s)

findFilteredDimensionRowsPaged

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

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

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.

hasAnyRows

default boolean hasAnyRows(Set<ApiFilter> filters)

Determine if any rows match these filters.

Parameters:

filters - ApiFilters to use for finding matching dimension rows

Returns:

true if at least one row is returned.

refreshIndex

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

Method to add / update indexes.

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

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

Method to add / update indexes.

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.

isHealthy

boolean isHealthy()

Method to check if search provider is healthy.

Returns:

true if healthy

replaceIndex

default void replaceIndex(String newLuceneIndexPathString)

Replaces index with a new index in hot-swap manner.

Parameters:

newLuceneIndexPathString - The location of directory that contains the the new index.

clearDimension

void clearDimension()

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