org.dizitart.no2

Class FindOptions

java.lang.Object

org.dizitart.no2.FindOptions

public class FindOptions
extends java.lang.Object

Represents the options to specify during a find operation on a collection.

Example of find options

// find with pagination options
collection.find(FindOptions.limit(0, 10));

// find with sort options
collection.find(FindOptions.sort("age", SortOrder.Descending));

// find with sort options and pagination options
// this will first sort all records by age in descending order and
// then it will take first 10 records as a result
collection.find(sort("age", SortOrder.Descending).thenLimit(0, 10));

Since:

1.0

See Also:

NitriteCollection.find(FindOptions), NitriteCollection.find(Filter, FindOptions)

Constructor Summary

Constructors

Constructor and Description
FindOptions(int offset, int size) Instantiates a new find options with pagination criteria.
FindOptions(java.lang.String field, SortOrder sortOrder) Instantiates a new find options with sorting criteria.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getField() Gets the target value name for sorting the find results.
int	getOffset() Gets the offset for pagination in find operation.
int	getSize() Gets the number of records in each page for pagination in find operation results.
SortOrder	getSortOrder() Gets the sort order of the find result.
static FindOptions	limit(int offset, int size) Creates a find options with pagination criteria.
static FindOptions	sort(java.lang.String field, SortOrder sortOrder) Creates a find options with sorting criteria.
FindOptions	thenLimit(int offset, int size) Sets the pagination criteria of a @FindOptions with sorting updateOptions.

Methods inherited from class java.lang.Object

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

Constructor Detail

FindOptions

public FindOptions(int offset,
                   int size)

Instantiates a new find options with pagination criteria.

Parameters:

offset - the pagination offset.

size - the number of records per page.

FindOptions

public FindOptions(java.lang.String field,
                   SortOrder sortOrder)

Instantiates a new find options with sorting criteria.

Parameters:

field - the value to sort by.

sortOrder - the sort order.

Method Detail

limit

public static FindOptions limit(int offset,
                                int size)

Creates a find options with pagination criteria.

Parameters:

offset - the pagination offset.

size - the number of records per page.

Returns:

the find options with pagination criteria.

sort

public static FindOptions sort(java.lang.String field,
                               SortOrder sortOrder)

Creates a find options with sorting criteria.

Parameters:

field - the value to sort by.

sortOrder - the sort order.

Returns:

the find options with sorting criteria.

thenLimit

public FindOptions thenLimit(int offset,
                             int size)

Sets the pagination criteria of a @FindOptions with sorting updateOptions.

With this FindOptions it will first sort all search results, then it will apply pagination criteria on the sorted results.

Parameters:

offset - the pagination offset.

size - the number of records per page.

Returns:

the find updateOptions with pagination and sorting criteria.

getOffset

@Generated(value="lombok")
public int getOffset()

Gets the offset for pagination in find operation.

Returns:

the offset for pagination.

getSize

@Generated(value="lombok")
public int getSize()

Gets the number of records in each page for pagination in find operation results.

Returns:

the record size per page.

getField

@Generated(value="lombok")
public java.lang.String getField()

Gets the target value name for sorting the find results.

Returns:

the target value name.

getSortOrder

@Generated(value="lombok")
public SortOrder getSortOrder()

Gets the sort order of the find result.

Returns:

the sort order.