org.apache.juneau.utils

Class SearchArgs.Builder

java.lang.Object

org.apache.juneau.utils.SearchArgs.Builder

Enclosing class:

SearchArgs

public static final class SearchArgs.Builder
extends Object

Builder for SearchArgs class.

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
SearchArgs	build() Construct the SearchArgs object.
SearchArgs.Builder	ignoreCase(boolean value) Specifies whether case-insensitive search should be used.
SearchArgs.Builder	limit(int limit) Specifies the number of rows to return.
SearchArgs.Builder	position(int position) Specifies the starting line number.
SearchArgs.Builder	search(String searchTerms) Adds search terms to this builder.
SearchArgs.Builder	search(String column, String searchTerm) Adds a search term to this builder.
SearchArgs.Builder	sort(Collection<String> sortArgs) Specifies the sort arguments.
SearchArgs.Builder	sort(String sortArgs) Specifies the sort arguments.
SearchArgs.Builder	view(Collection<String> columns) Specifies the list of columns to view.
SearchArgs.Builder	view(String columns) Specifies the list of columns to view.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

search

public SearchArgs.Builder search(String searchTerms)

Adds search terms to this builder.

The search terms are a comma-delimited list of key/value pairs of column-names and search tokens.

For example:

builder.search("column1=foo*, column2=bar baz");

It's up to implementers to decide the syntax and meaning of the search terms.

Whitespace is trimmed from column names and search tokens.

Parameters:

searchTerms - The search terms string. Can be null.

Returns:

This object (for method chaining).

search

public SearchArgs.Builder search(String column,
                                 String searchTerm)

Adds a search term to this builder.

It's up to implementers to decide the syntax and meaning of the search term.

Parameters:

column - The column being searched.

searchTerm - The search term.

Returns:

This object (for method chaining).

view

public SearchArgs.Builder view(String columns)

Specifies the list of columns to view.

The columns argument is a simple comma-delimited list of column names.

For example:

builder.view("column1, column2");

Whitespace is trimmed from column names.

Empty view columns imply view all columns.

Parameters:

columns - The columns being viewed. Can be null.

Returns:

This object (for method chaining).

view

public SearchArgs.Builder view(Collection<String> columns)

Specifies the list of columns to view.

Empty view columns imply view all columns.

Parameters:

columns - The columns being viewed.

Returns:

This object (for method chaining).

sort

public SearchArgs.Builder sort(String sortArgs)

Specifies the sort arguments.

The sort argument is a simple comma-delimited list of column names.
Column names can be suffixed with '+' or '-' to indicate ascending or descending order.
No suffix implies ascending order.

For example:

// Order by column1 ascending, then column2 descending. builder.sort("column1, column2-");

Note that the order of the order arguments is important.

Whitespace is trimmed from column names.

Parameters:

sortArgs - The columns to sort by. Can be null.

Returns:

This object (for method chaining).

sort

public SearchArgs.Builder sort(Collection<String> sortArgs)

Specifies the sort arguments.

Column names can be suffixed with '+' or '-' to indicate ascending or descending order.
No suffix implies ascending order.

Note that the order of the sort is important.

Parameters:

sortArgs - The columns to sort by. Can be null.

Returns:

This object (for method chaining).

position

public SearchArgs.Builder position(int position)

Specifies the starting line number.

Parameters:

position - The zero-indexed position.

Returns:

This object (for method chaining).

limit

public SearchArgs.Builder limit(int limit)

Specifies the number of rows to return.

Parameters:

limit - The number of rows to return. If <=0, all rows should be returned.

Returns:

This object (for method chaining).

ignoreCase

public SearchArgs.Builder ignoreCase(boolean value)

Specifies whether case-insensitive search should be used.

The default is false.

Parameters:

value - The ignore-case flag value.

Returns:

This object (for method chaining).

build

public SearchArgs build()

Construct the SearchArgs object.

This method can be called multiple times to construct new objects.

Returns:

A new SearchArgs object initialized with values in this builder.