com.yahoo.bullet.querying

Class QueryManager

java.lang.Object

com.yahoo.bullet.querying.QueryManager

public class QueryManager
extends Object

This class wraps the concept of the Partitioner and allows you to control using your configured (or not) partitioner, what queries are seen for each BulletRecord. It also uses the QueryCategorizer to categorize your queries for you if you use the categorize() (for categorizing all queries) or categorize(BulletRecord) (for categorizing all partitioned queries for a record). You can get the queries relevant to your record (after applying any partitioner) using partition(BulletRecord). You can use the addQuery(String, Querier) to add a query to the manager and the removeAndGetQuery(String) and removeQueries(Set) methods to remove a query from the manager.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	QueryManager.PartitionStat

Field Summary

Fields

Modifier and Type	Field and Description
static int	QUANTILE_STEP

Constructor Summary

Constructors

Constructor and Description
QueryManager(BulletConfig config) The constructor that takes a non-null BulletConfig instance that contains partitioning settings.

Method Summary

Modifier and Type	Method and Description
void	addQuery(String id, Querier querier) Adds a configured, initialized query instance Querier to the manager.
QueryCategorizer	categorize() Categorizes all the queries in the manager regardless of partitioning, using a QueryCategorizer.
QueryCategorizer	categorize(com.yahoo.bullet.record.BulletRecord record) Categorizes only the queries for the BulletRecord after partitioning using the QueryCategorizer.
Querier	getQuery(String id) Retrieves a query stored in the manager or null, if not found.
Map<QueryManager.PartitionStat,Object>	getStats() Gets some statistics about the current state of partitioning and queries in this manager.
boolean	hasQuery(String id) Checks to see if the given ID is stored in the manager.
Map<String,Querier>	partition(com.yahoo.bullet.record.BulletRecord record) Takes a BulletRecord instance and returns the matching queries (according to the Partitioner) for it as as Map of query IDs to the Querier instances.
List<Querier>	removeAndGetQueries(Set<String> ids) Removes and returns the List of Querier instances for the given non-null query IDs.
Querier	removeAndGetQuery(String id) Removes and returns a Querier from the manager.
void	removeQueries(Set<String> ids) Removes all the queries for the given non-null Set of query IDs from the manager completely.
int	size() Returns the size of the queries in the manager.

Methods inherited from class java.lang.Object

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

Field Detail

QUANTILE_STEP

public static final int QUANTILE_STEP

See Also:

Constant Field Values

Constructor Detail

QueryManager

public QueryManager(BulletConfig config)

The constructor that takes a non-null BulletConfig instance that contains partitioning settings.

Parameters:

config - The non-null config.

Method Detail

addQuery

public void addQuery(String id,
                     Querier querier)

Adds a configured, initialized query instance Querier to the manager.

Parameters:

id - The query ID.

querier - A fully initialized Querier instance.

removeAndGetQuery

public Querier removeAndGetQuery(String id)

Removes and returns a Querier from the manager. The manager does not have any information pertaining to the query any longer.

Parameters:

id - The query ID to remove.

Returns:

The removed Querier instance.

removeAndGetQueries

public List<Querier> removeAndGetQueries(Set<String> ids)

Removes and returns the List of Querier instances for the given non-null query IDs. The manager does not have any information pertaining to these queries after.

Parameters:

ids - The non-null Set of query IDs to remove.

Returns:

The removed List of Querier instances.

removeQueries

public void removeQueries(Set<String> ids)

Removes all the queries for the given non-null Set of query IDs from the manager completely. Use removeAndGetQueries(Set) to get these queries.

Parameters:

ids - The non-null Set of query IDs to remove.

getQuery

public Querier getQuery(String id)

Retrieves a query stored in the manager or null, if not found.

Parameters:

id - The ID of the query.

Returns:

The Querier instance or null, if not present.

hasQuery

public boolean hasQuery(String id)

Checks to see if the given ID is stored in the manager.

Parameters:

id - The ID of the query.

Returns:

A boolean denoting whether this query is in the manager.

size

public int size()

Returns the size of the queries in the manager.

Returns:

An int representing the number of queries in the manager.

partition

public Map<String,Querier> partition(com.yahoo.bullet.record.BulletRecord record)

Takes a BulletRecord instance and returns the matching queries (according to the Partitioner) for it as as Map of query IDs to the Querier instances.

Parameters:

record - The non-null BulletRecord instance.

Returns:

The non-null Map of matching queries for the record.

categorize

public QueryCategorizer categorize()

Categorizes all the queries in the manager regardless of partitioning, using a QueryCategorizer.

Returns:

The QueryCategorizer instance with all the categorized queries in the manager.

categorize

public QueryCategorizer categorize(com.yahoo.bullet.record.BulletRecord record)

Categorizes only the queries for the BulletRecord after partitioning using the QueryCategorizer.

Parameters:

record - The BulletRecord to consume for the partitioned queries.

Returns:

The QueryCategorizer instance with the categorized queries in the manager after partitioning.

getStats

public Map<QueryManager.PartitionStat,Object> getStats()

Gets some statistics about the current state of partitioning and queries in this manager.

Returns:

A Map of QueryManager.PartitionStat to their values for the current state of the manager.