Package org.apache.juneau.commons.beanquery

Class BeanQuery.Builder

java.lang.Object

org.apache.juneau.commons.beanquery.BeanQuery.Builder

Enclosing class:

BeanQuery

public static final class BeanQuery.Builder
extends Object

Builds an immutable BeanQuery. Create with BeanQuery.create(); derive one from an existing query with BeanQuery.copy().

Exposes every BeanQuery.GroupBuilder condition method (they add top-level conditions here) plus view/sort/paging/opts/counts and build().

Example:

BeanQuery q = BeanQuery.create().eq("status", "active").build();

Since:

10.0.0

Method Summary

Modifier and Type	Method	Description
BeanQuery.Builder	and(Consumer<BeanQuery.GroupBuilder> block)	Same as BeanQuery.GroupBuilder.and(Consumer), adding a top-level group.
BeanQuery.Builder	between(String column, Object lower, Object upper)	Same as BeanQuery.GroupBuilder.between(String,Object,Object), adding a top-level condition.
BeanQuery.Builder	blank(String column)	Same as BeanQuery.GroupBuilder.blank(String), adding a top-level condition.
BeanQuery	build()	Builds a new, immutable BeanQuery from this builder's current state.
BeanQuery.Builder	contains(String column, Object value)	Same as BeanQuery.GroupBuilder.contains(String,Object), adding a top-level condition.
BeanQuery.Builder	counts(CountRequest request)	Sets the counts option from a CountRequest.
BeanQuery.Builder	eq(String column, Object value)	Same as BeanQuery.GroupBuilder.eq(String,Object), adding a top-level condition.
BeanQuery.Builder	gt(String column, Object value)	Same as BeanQuery.GroupBuilder.gt(String,Object), adding a top-level condition.
BeanQuery.Builder	gte(String column, Object value)	Same as BeanQuery.GroupBuilder.gte(String,Object), adding a top-level condition.
BeanQuery.Builder	in(String column, Object... values)	Same as BeanQuery.GroupBuilder.in(String,Object...), adding a top-level condition.
BeanQuery.Builder	limit(int limit)	Sets the maximum number of rows to return.
BeanQuery.Builder	lt(String column, Object value)	Same as BeanQuery.GroupBuilder.lt(String,Object), adding a top-level condition.
BeanQuery.Builder	lte(String column, Object value)	Same as BeanQuery.GroupBuilder.lte(String,Object), adding a top-level condition.
BeanQuery.Builder	ne(String column, Object... values)	Same as BeanQuery.GroupBuilder.ne(String,Object...), adding a top-level condition.
BeanQuery.Builder	not(Consumer<BeanQuery.GroupBuilder> block)	Same as BeanQuery.GroupBuilder.not(Consumer), adding a top-level group.
BeanQuery.Builder	notBlank(String column)	Same as BeanQuery.GroupBuilder.notBlank(String), adding a top-level condition.
BeanQuery.Builder	op(String column, String name, Object... values)	Same as BeanQuery.GroupBuilder.op(String,String,Object...), adding a top-level condition.
BeanQuery.Builder	opt(String key, String value)	Sets a free-form option, overwriting any earlier value for the same key.
BeanQuery.Builder	or(Consumer<BeanQuery.GroupBuilder> block)	Same as BeanQuery.GroupBuilder.or(Consumer), adding a top-level group.
BeanQuery.Builder	page(int start, int length)	Sets position(int) and limit(int) together.
BeanQuery.Builder	position(int position)	Sets the zero-based row offset.
BeanQuery.Builder	prefix(String column, Object value)	Same as BeanQuery.GroupBuilder.prefix(String,Object), adding a top-level condition.
BeanQuery.Builder	regex(String column, String pattern)	Same as BeanQuery.GroupBuilder.regex(String,String), adding a top-level condition.
BeanQuery.Builder	regex(String column, String pattern, String flags)	Same as BeanQuery.GroupBuilder.regex(String,String,String), adding a top-level condition.
BeanQuery.Builder	search(String column, String expression)	Same as BeanQuery.GroupBuilder.search(String,String), adding a top-level condition.
BeanQuery.Builder	sort(String column)	Appends an ascending sort key; does not replace keys already added.
BeanQuery.Builder	sortDesc(String column)	Appends a descending sort key (column + ":desc"); does not replace keys already added.
BeanQuery.Builder	view(String... columns)	Appends columns to the view list; does not replace columns already added.

Methods inherited from class java.lang.Object

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

Method Details

eq

public BeanQuery.Builder eq(String column,
 Object value)

Same as BeanQuery.GroupBuilder.eq(String,Object), adding a top-level condition. @param column The column name. @param value The value. @return This object.

ne

public BeanQuery.Builder ne(String column,
 Object... values)

Same as BeanQuery.GroupBuilder.ne(String,Object...), adding a top-level condition. @param column The column name. @param values The values. @return This object.

in

public BeanQuery.Builder in(String column,
 Object... values)

Same as BeanQuery.GroupBuilder.in(String,Object...), adding a top-level condition. @param column The column name. @param values The values. @return This object.

contains

public BeanQuery.Builder contains(String column,
 Object value)

Same as BeanQuery.GroupBuilder.contains(String,Object), adding a top-level condition. @param column The column name. @param value The value. @return This object.

prefix

public BeanQuery.Builder prefix(String column,
 Object value)

Same as BeanQuery.GroupBuilder.prefix(String,Object), adding a top-level condition. @param column The column name. @param value The value. @return This object.

blank

public BeanQuery.Builder blank(String column)

Same as BeanQuery.GroupBuilder.blank(String), adding a top-level condition. @param column The column name. @return This object.

notBlank

public BeanQuery.Builder notBlank(String column)

Same as BeanQuery.GroupBuilder.notBlank(String), adding a top-level condition. @param column The column name. @return This object.

gt

public BeanQuery.Builder gt(String column,
 Object value)

Same as BeanQuery.GroupBuilder.gt(String,Object), adding a top-level condition. @param column The column name. @param value The value. @return This object.

gte

public BeanQuery.Builder gte(String column,
 Object value)

Same as BeanQuery.GroupBuilder.gte(String,Object), adding a top-level condition. @param column The column name. @param value The value. @return This object.

lt

public BeanQuery.Builder lt(String column,
 Object value)

Same as BeanQuery.GroupBuilder.lt(String,Object), adding a top-level condition. @param column The column name. @param value The value. @return This object.

lte

public BeanQuery.Builder lte(String column,
 Object value)

Same as BeanQuery.GroupBuilder.lte(String,Object), adding a top-level condition. @param column The column name. @param value The value. @return This object.

between

public BeanQuery.Builder between(String column,
 Object lower,
 Object upper)

Same as BeanQuery.GroupBuilder.between(String,Object,Object), adding a top-level condition. @param column The column name. @param lower The lower bound. @param upper The upper bound. @return This object.

regex

public BeanQuery.Builder regex(String column,
 String pattern)

Same as BeanQuery.GroupBuilder.regex(String,String), adding a top-level condition. @param column The column name. @param pattern The regular expression. @return This object.

regex

public BeanQuery.Builder regex(String column,
 String pattern,
 String flags)

Same as BeanQuery.GroupBuilder.regex(String,String,String), adding a top-level condition. @param column The column name. @param pattern The regular expression. @param flags The regex flags. @return This object.

op

public BeanQuery.Builder op(String column,
 String name,
 Object... values)

Same as BeanQuery.GroupBuilder.op(String,String,Object...), adding a top-level condition. @param column The column name. @param name The operator name, starting with "$". @param values The operator's arguments. @return This object.

search

public BeanQuery.Builder search(String column,
 String expression)

Same as BeanQuery.GroupBuilder.search(String,String), adding a top-level condition. @param column The column name. @param expression The raw expression. @return This object.

or

public BeanQuery.Builder or(Consumer<BeanQuery.GroupBuilder> block)

Same as BeanQuery.GroupBuilder.or(Consumer), adding a top-level group. @param block Populates the group. @return This object.

and

public BeanQuery.Builder and(Consumer<BeanQuery.GroupBuilder> block)

Same as BeanQuery.GroupBuilder.and(Consumer), adding a top-level group. @param block Populates the group. @return This object.

not

public BeanQuery.Builder not(Consumer<BeanQuery.GroupBuilder> block)

Same as BeanQuery.GroupBuilder.not(Consumer), adding a top-level group. @param block Populates the negated condition. @return This object. @throws IllegalArgumentException If the block adds a number of items other than exactly one.

view

public BeanQuery.Builder view(String... columns)

Appends columns to the view list; does not replace columns already added.

Parameters:

columns - The columns to append. Must not be null, nor contain a null element.

Returns:

This object.

Throws:

IllegalArgumentException - If columns is null or contains a null element.

sort

public BeanQuery.Builder sort(String column)

Appends an ascending sort key; does not replace keys already added.

Parameters:

column - The column to sort by.

Returns:

This object.

sortDesc

public BeanQuery.Builder sortDesc(String column)

Appends a descending sort key (column + ":desc"); does not replace keys already added.

Parameters:

column - The column to sort by, descending.

Returns:

This object.

position

public BeanQuery.Builder position(int position)

Sets the zero-based row offset.

Parameters:

position - The row offset; must not be negative.

Returns:

This object.

Throws:

IllegalArgumentException - If position is negative.

limit

public BeanQuery.Builder limit(int limit)

Sets the maximum number of rows to return. A negative value is clamped to the literal -1 (meaning "as many rows as the session allows"), never dropped to null.

Parameters:

limit - The row limit.

Returns:

This object.

page

public BeanQuery.Builder page(int start,
 int length)

Sets position(int) and limit(int) together.

Parameters:

start - The zero-based row offset; must not be negative.

length - The maximum number of rows to return; a negative value means "as many as allowed".

Returns:

This object.

Throws:

IllegalArgumentException - If start is negative.

opt

public BeanQuery.Builder opt(String key,
 String value)

Sets a free-form option, overwriting any earlier value for the same key.

Parameters:

key - The option name. Must not be null or blank.

value - The option value. Must not be null.

Returns:

This object.

Throws:

IllegalArgumentException - If key is null or blank, or value is null.

counts

public BeanQuery.Builder counts(CountRequest request)

Sets the counts option from a CountRequest. CountRequest.NONE removes the counts option entirely (rather than writing a "none" value).

Parameters:

request - The requested counts.

Returns:

This object.

build

public BeanQuery build()

Builds a new, immutable BeanQuery from this builder's current state. The builder remains usable afterward; later calls do not affect the BeanQuery already built.

Returns:

A new BeanQuery.