org.apache.juneau.utils

Class SearchArgs

java.lang.Object

org.apache.juneau.utils.SearchArgs

public class SearchArgs
extends Object

Encapsulates arguments for basic search/view/sort/position/limit functionality.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SearchArgs.Builder Builder for SearchArgs class.

Method Summary

Modifier and Type	Method and Description
static SearchArgs.Builder	builder() Creates a new builder for SearchArgs
int	getLimit() The number of rows to return.
int	getPosition() The first-row position.
Map<String,String>	getSearch() The query search terms.
Map<String,Boolean>	getSort() The sort columns.
List<String>	getView() The view columns.
boolean	isIgnoreCase() The ignore-case flag.

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static SearchArgs.Builder builder()

Creates a new builder for SearchArgs

Returns:

A new builder for SearchArgs

getSearch

public Map<String,String> getSearch()

The query search terms.

The search terms are key/value pairs consisting of column-names and search tokens.

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

Returns:

An unmodifiable map of query search terms.

getView

public List<String> getView()

The view columns.

The view columns are the list of columns that should be displayed. An empty list implies all columns should be displayed.

Returns:

An unmodifiable list of columns to view.

getSort

public Map<String,Boolean> getSort()

The sort columns.

The sort columns are key/value pairs consisting of column-names and direction flags (false = ascending, true = descending).

Returns:

An unmodifiable ordered map of sort columns and directions.

getPosition

public int getPosition()

The first-row position.

Returns:

The zero-indexed row number of the first row to display. Default is 0

getLimit

public int getLimit()

The number of rows to return.

Returns:

The number of rows to return in the result. Default is 0 which means return all rows.

isIgnoreCase

public boolean isIgnoreCase()

The ignore-case flag.

Used in conjunction with getSearch() to specify whether case-insensitive searches should be performed.

Returns:

The number of rows to return in the result. Default is false.