sirius.db.mongo

Class Finder

java.lang.Object

sirius.db.mongo.QueryBuilder<Finder>

sirius.db.mongo.Finder

public class Finder
extends QueryBuilder<Finder>

Fluent builder to build a find statement.

Field Summary

Fields inherited from class sirius.db.mongo.QueryBuilder

filterObject, FILTERS, mixing, mongo

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Finder(Mongo mongo)

Method Summary

Modifier and Type	Method and Description
void	allIn(Class<?> type, Consumer<Doc> processor) Executes the query for the given collection and calls the given processor for each document.
void	allIn(String collection, Consumer<Doc> processor) Executes the query for the given collection and calls the given processor for each document.
long	countIn(Class<?> type) Counts the number of documents in the result of the given query.
long	countIn(String collection) Counts the number of documents in the result of the given query.
void	eachIn(Class<?> type, Function<Doc,Boolean> processor) Executes the query for the given collection and calls the given processor for each document as long as it returns true.
void	eachIn(String collection, Function<Doc,Boolean> processor) Executes the query for the given collection and calls the given processor for each document as long as it returns true.
Finder	limit(int limit) Adds a limit to the query.
Finder	limit(int skip, int limit) Adds a limit to the query.
Finder	orderByAsc(Mapping field) Adds a sort constraint to order by the given field ascending.
Finder	orderByAsc(String field) Adds a sort constraint to order by the given field ascending.
Finder	orderByDesc(Mapping field) Adds a sort constraint to order by the given field descending.
Finder	orderByDesc(String field) Adds a sort constraint to order by the given field descending.
Finder	selectFields(Mapping... fieldsToReturn) Limits the fields being returned to the given list.
Finder	selectFields(String... fieldsToReturn) Limits the fields being returned to the given list.
Optional<Doc>	singleIn(Class<?> type) Executes the query for the given collection and returns a single document.
Optional<Doc>	singleIn(String collection) Executes the query for the given collection and returns a single document.
Finder	skip(int skip) Specifies the number of items to skip before items are added to the result.

Methods inherited from class sirius.db.mongo.QueryBuilder

getRelationName, toString, traceIfRequired, transferFilters, where, where, where

Methods inherited from class java.lang.Object

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

Constructor Detail

Finder

protected Finder(Mongo mongo)

Method Detail

selectFields

public Finder selectFields(Mapping... fieldsToReturn)

Limits the fields being returned to the given list.

Parameters:

fieldsToReturn - specified the list of fields to return

Returns:

the builder itself for fluent method calls

selectFields

public Finder selectFields(String... fieldsToReturn)

Limits the fields being returned to the given list.

Parameters:

fieldsToReturn - specified the list of fields to return

Returns:

the builder itself for fluent method calls

orderByAsc

public Finder orderByAsc(Mapping field)

Adds a sort constraint to order by the given field ascending.

Parameters:

field - the field to order by.

Returns:

the builder itself for fluent method calls

orderByAsc

public Finder orderByAsc(String field)

Adds a sort constraint to order by the given field ascending.

Parameters:

field - the field to order by.

Returns:

the builder itself for fluent method calls

orderByDesc

public Finder orderByDesc(Mapping field)

Adds a sort constraint to order by the given field descending.

Parameters:

field - the field to order by.

Returns:

the builder itself for fluent method calls

orderByDesc

public Finder orderByDesc(String field)

Adds a sort constraint to order by the given field descending.

Parameters:

field - the field to order by.

Returns:

the builder itself for fluent method calls

limit

public Finder limit(int skip,
                    int limit)

Adds a limit to the query.

Parameters:

skip - the number of items to skip (used for pagination).

limit - the max. number of items to return (exluding those who have been skipped).

Returns:

the builder itself for fluent method calls

limit

public Finder limit(int limit)

Adds a limit to the query.

This is boilerplate for finder.limit(0, limit).

Parameters:

limit - the max. number of items to return

Returns:

the builder itself for fluent method calls

skip

public Finder skip(int skip)

Specifies the number of items to skip before items are added to the result.

Parameters:

skip - the number of items to skip. Value <= 0 are ignored.

Returns:

the query itself for fluent method calls

singleIn

public Optional<Doc> singleIn(Class<?> type)

Executes the query for the given collection and returns a single document.

Parameters:

type - the type of entities to search

Returns:

the founbd document wrapped as Optional or an empty one, if no document was found.

singleIn

public Optional<Doc> singleIn(String collection)

Executes the query for the given collection and returns a single document.

Parameters:

collection - the collection to search in

Returns:

the founbd document wrapped as Optional or an empty one, if no document was found.

eachIn

public void eachIn(Class<?> type,
                   Function<Doc,Boolean> processor)

Executes the query for the given collection and calls the given processor for each document as long as it returns true.

Parameters:

type - the type of entities to search

processor - the processor to handle matches, which also controls if further results should be processed

eachIn

public void eachIn(String collection,
                   Function<Doc,Boolean> processor)

Executes the query for the given collection and calls the given processor for each document as long as it returns true.

Parameters:

collection - the collection to search in

processor - the processor to handle matches, which also controls if further results should be processed

allIn

public void allIn(Class<?> type,
                  Consumer<Doc> processor)

Executes the query for the given collection and calls the given processor for each document.

Parameters:

type - the type of entities to search

processor - the processor to handle matches

allIn

public void allIn(String collection,
                  Consumer<Doc> processor)

Executes the query for the given collection and calls the given processor for each document.

Parameters:

collection - the collection to search in

processor - the processor to handle matches

countIn

public long countIn(Class<?> type)

Counts the number of documents in the result of the given query.

Note that limits are ignored for this query.

Parameters:

type - the type of entities to search

Returns:

the number of documents found

countIn

public long countIn(String collection)

Counts the number of documents in the result of the given query.

Note that limits are ignored for this query.

Parameters:

collection - the collection to search in

Returns:

the number of documents found