gov.bnl.channelfinder.api

Class ChannelQuery

java.lang.Object

gov.bnl.channelfinder.api.ChannelQuery

public class ChannelQuery
extends Object

An observable query to channel finder that maintains the cached result.

Author:

carcassi

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ChannelQuery.Builder
static class	ChannelQuery.Result Result of the query.

Method Summary

Modifier and Type	Method and Description
void	addChannelQueryListener(ChannelQueryListener listener) Adds a new listener that is called every time the query is executed.
boolean	equals(Object obj)
void	execute(ChannelQueryListener listener) Executes the query and calls the listener with the result.
static Executor	getDefaultQueryExecutor() The executor on which the queries are executed.
String	getQuery() The text of the query.
ChannelQuery.Result	getResult() The result of the query, if present.
int	hashCode()
static ChannelQuery.Builder	query(String query) A new query with the given search string.
void	refresh() Triggers a new execution of the query, and calls all the listeners as a result.
void	removeChannelQueryListener(ChannelQueryListener listener) Removes a listener.
static void	setDefaultQueryExecutor(Executor defaultQueryExecutor) Change the executor on which the queries are executed.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

query

public static ChannelQuery.Builder query(String query)

A new query with the given search string.

Parameters:

query - the query; cannot be null

Returns:

a new builder

getDefaultQueryExecutor

public static Executor getDefaultQueryExecutor()

The executor on which the queries are executed.

Returns:

the current executor

setDefaultQueryExecutor

public static void setDefaultQueryExecutor(Executor defaultQueryExecutor)

Change the executor on which the queries are executed.

TODO: it's not clear who has the responsibility of closing the old executor

Parameters:

defaultQueryExecutor - the new executor

addChannelQueryListener

public void addChannelQueryListener(ChannelQueryListener listener)

Adds a new listener that is called every time the query is executed. Note: if you want the listener to be called at least once, use execute(ChannelQueryListener).

Parameters:

listener - a new listener

removeChannelQueryListener

public void removeChannelQueryListener(ChannelQueryListener listener)

Removes a listener.

Parameters:

listener - the listener to be removed

getQuery

public String getQuery()

The text of the query.

Returns:

the query text

getResult

public ChannelQuery.Result getResult()

The result of the query, if present.

Returns:

result or null if the query was never executed

execute

public void execute(ChannelQueryListener listener)

Executes the query and calls the listener with the result. If the query was already executed, the listener is called immediately with the result.

Parameters:

listener - - channel query listener

refresh

public void refresh()

Triggers a new execution of the query, and calls all the listeners as a result.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object