Package com.codingchili.core.storage

Class Query<Value extends Storable>

java.lang.Object

com.codingchili.core.storage.Query<Value>

All Implemented Interfaces:

QueryBuilder<Value>

public class Query<Value extends Storable>
extends Object
implements QueryBuilder<Value>

Provides the ability to create a query without an existing storage.

Can be used to create reusable queries and string based/serializable queries.

If the query is to be executed the #must be set or an exception will be thrown.

Field Summary

Fields

Modifier and Type	Field	Description
static String	AND
static String	BETWEEN
static String	EQ
static String	IN
static String	LIKE
static String	NAMED
static String	ON
static String	OR
static String	ORDERBY
static String	PAGE
static String	PAGESIZE
static String	QUERY
static String	REGEX
static String	STARTSWITH

Constructor Summary

Constructors

Constructor	Description
Query()

Method Summary

Modifier and Type	Method	Description
Query<Value>	and(String attribute)	Adds a new AND clause to the query.
Query<Value>	between(Long minimum, Long maximum)	Matches documents with the attribute between and including minimum and maximum.
Query<Value>	equalTo(Comparable match)	Matches if the attribute is an exact match to the given text.
void	execute(io.vertx.core.Handler<io.vertx.core.AsyncResult<Collection<Value>>> handler)	Executes the constructed query asynchronously.
Query<Value>	in(Comparable... list)	Matches if a specified attribute is contained within the given list
Query<Value>	like(String text)	Matches documents where the attribute containst the given text
Query<Value>	mapper(Consumer<Value> mapper)	Sets a mapping function that can be used to intercept results.
Query<Value>	matches(String regex)	Checks if the given attribute matches the given regex.
String	name()	Generates unique ids for the triggers that are used.
Query<Value>	on(String attribute)	The attribute to be queried.
Query<Value>	or(String attribute)	Adds a new OR clause to the query.
Query<Value>	order(SortOrder order)	Orders the result by the given direction using the last specified attribute handler unless orderBy is set.
Query<Value>	orderBy(String orderByAttribute)	Orders the result by the given attribute using the default sort order unless the sort order has been explicitly set.
Query<Value>	page(int page)	set the page offset for paging support.
Query<Value>	pageSize(int pageSize)	set the size of each page for paging support.
EntryWatcher<Value>	poll(Consumer<Collection<Value>> consumer, TimerSource timer)	Executes the query periodically.
Query<Value>	setName(String name)	Sets a name for the query for identification.
Query<Value>	startsWith(String text)	Matches if the specified attribute starts with the given text
Query<Value>	storage(AsyncStorage<Value> storage)	If intending to invoke either #execute(Handler) or #poll(Consumer, TimerSource) this method must be called first.
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

ON

public static final String ON

See Also:

Constant Field Values

AND

public static final String AND

See Also:

Constant Field Values

OR

public static final String OR

See Also:

Constant Field Values

PAGE

public static final String PAGE

See Also:

Constant Field Values

PAGESIZE

public static final String PAGESIZE

See Also:

Constant Field Values

BETWEEN

public static final String BETWEEN

See Also:

Constant Field Values

LIKE

public static final String LIKE

See Also:

Constant Field Values

STARTSWITH

public static final String STARTSWITH

See Also:

Constant Field Values

IN

public static final String IN

See Also:

Constant Field Values

EQ

public static final String EQ

See Also:

Constant Field Values

ORDERBY

public static final String ORDERBY

See Also:

Constant Field Values

REGEX

public static final String REGEX

See Also:

Constant Field Values

QUERY

public static final String QUERY

See Also:

Constant Field Values

NAMED

public static final String NAMED

See Also:

Constant Field Values

Constructor Details

Query

public Query()

Method Details

and

public Query<Value> and(String attribute)

Description copied from interface: QueryBuilder

Adds a new AND clause to the query.

Specified by:

and in interface QueryBuilder<Value extends Storable>

Parameters:

attribute - the name of the attribute to be queried.

Returns:

fluent

or

public Query<Value> or(String attribute)

Description copied from interface: QueryBuilder

Adds a new OR clause to the query.

Specified by:

or in interface QueryBuilder<Value extends Storable>

Parameters:

attribute - the name of the attribute to be queried.

Returns:

fluent

on

public Query<Value> on(String attribute)

Description copied from interface: QueryBuilder

The attribute to be queried.

Specified by:

on in interface QueryBuilder<Value extends Storable>

Parameters:

attribute - the name of the queried attribute.

Returns:

fluent

page

public Query<Value> page(int page)

Description copied from interface: QueryBuilder

set the page offset for paging support.

Specified by:

page in interface QueryBuilder<Value extends Storable>

Parameters:

page - the page to return results from.

Returns:

fluent

pageSize

public Query<Value> pageSize(int pageSize)

Description copied from interface: QueryBuilder

set the size of each page for paging support.

Specified by:

pageSize in interface QueryBuilder<Value extends Storable>

Parameters:

pageSize - the number of hits returned on each page.

Returns:

fluent

between

public Query<Value> between(Long minimum,
 Long maximum)

Description copied from interface: QueryBuilder

Matches documents with the attribute between and including minimum and maximum.

Specified by:

between in interface QueryBuilder<Value extends Storable>

Parameters:

minimum - the minimum value to match

maximum - the maximum value to match

Returns:

fluent

like

public Query<Value> like(String text)

Description copied from interface: QueryBuilder

Matches documents where the attribute containst the given text

Specified by:

like in interface QueryBuilder<Value extends Storable>

Parameters:

text - the text to check if contained.

Returns:

fluent

startsWith

public Query<Value> startsWith(String text)

Description copied from interface: QueryBuilder

Matches if the specified attribute starts with the given text

Specified by:

startsWith in interface QueryBuilder<Value extends Storable>

Parameters:

text - the text to check if starting with.

Returns:

fluent

in

public Query<Value> in(Comparable... list)

Description copied from interface: QueryBuilder

Matches if a specified attribute is contained within the given list

Specified by:

in in interface QueryBuilder<Value extends Storable>

Parameters:

list - the list that the attribute value must be contained in to match.

Returns:

fluent

equalTo

public Query<Value> equalTo(Comparable match)

Description copied from interface: QueryBuilder

Matches if the attribute is an exact match to the given text.

Specified by:

equalTo in interface QueryBuilder<Value extends Storable>

Parameters:

match - the text that should be equal to the specified attribute.

Returns:

fluent

matches

public Query<Value> matches(String regex)

Description copied from interface: QueryBuilder

Checks if the given attribute matches the given regex. Be careful when passing user input to this method. No complexity restrictions are applied. To pass user input use equals instead. If a query can use any non-regex constraint, it is recommended to use that instead.

Specified by:

matches in interface QueryBuilder<Value extends Storable>

Parameters:

regex - the regular expression in which the attribute is to match

Returns:

fluent

orderBy

public Query<Value> orderBy(String orderByAttribute)

Description copied from interface: QueryBuilder

Orders the result by the given attribute using the default sort order unless the sort order has been explicitly set.

Specified by:

orderBy in interface QueryBuilder<Value extends Storable>

Parameters:

orderByAttribute - the handler of the attribute to sort by using dot notation.

Returns:

fluent

order

public Query<Value> order(SortOrder order)

Description copied from interface: QueryBuilder

Orders the result by the given direction using the last specified attribute handler unless orderBy is set.

Specified by:

order in interface QueryBuilder<Value extends Storable>

Parameters:

order - descending or ascending.

Returns:

fluent

storage

public Query<Value> storage(AsyncStorage<Value> storage)

If intending to invoke either #execute(Handler) or #poll(Consumer, TimerSource) this method must be called first.

Parameters:

storage - the storage to use if the standalone query is executed.

Returns:

fluent.

execute

public void execute(io.vertx.core.Handler<io.vertx.core.AsyncResult<Collection<Value>>> handler)

Description copied from interface: QueryBuilder

Executes the constructed query asynchronously.

Specified by:

execute in interface QueryBuilder<Value extends Storable>

Parameters:

handler - the handler to be invoked when the result is completed.

mapper

public Query<Value> mapper(Consumer<Value> mapper)

Sets a mapping function that can be used to intercept results.

Parameters:

mapper - a mapper that is called for each result when the query is executed.

Returns:

fluent.

poll

public EntryWatcher<Value> poll(Consumer<Collection<Value>> consumer,
 TimerSource timer)

Description copied from interface: QueryBuilder

Executes the query periodically.

Specified by:

poll in interface QueryBuilder<Value extends Storable>

Parameters:

consumer - a consumer that receives the results

timer - the source of the interval.

Returns:

fluent.

name

public String name()

Description copied from interface: QueryBuilder

Generates unique ids for the triggers that are used. Should be overridden so that logging messages are a bit meaningful.

Specified by:

name in interface QueryBuilder<Value extends Storable>

Returns:

a name that identifies this query.

setName

public Query<Value> setName(String name)

Description copied from interface: QueryBuilder

Sets a name for the query for identification.

Specified by:

setName in interface QueryBuilder<Value extends Storable>

Parameters:

name - the name to set

Returns:

fluent

toString

public String toString()

Overrides:

toString in class Object