Search (frogr-base 0.2.1 API)

java.lang.Object
- de.whitefrog.frogr.service.Search

public class Search
extends Object

Provides search filtering, counting, fetching, ordering and paging. Can return results in different formats. Use as follows:

   List results = repository.search()
       .filter("field", "value*")
       .fields("fieldA", "fieldB")
       .limit(10)
       .page(2)
       .list();

Constructor Summary

Constructors
Constructor and Description

Search(Repository<? extends Base> repository)

Constructors
Constructor and Description
`Search(Repository<? extends Base> repository)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`long`	`count()` Count the number of results.
`long`	`count(String id)` Count the number of results of a specific identifier.
`Search`	`debug()` Print queries and parameters to stdout.
`Search`	`fields(FieldList fields)` Fields to fetch on results.
`Search`	`fields(QueryField... fields)` Fields to fetch on results.
`Search`	`fields(String... fields)` Fields to fetch on results.
`Search`	`filter(Filter filter)` Adds a `filter` for results.
`Search`	`filter(String property, String value)` Filter results by field values.
`Search`	`ids(Collection<Long> ids)` Filter results by ids.
`Search`	`ids(Long... ids)` Filter results by ids.
`Search`	`limit(int limit)` Limit results to a specific count.
`<T extends Base> List<T>`	`list()` Get a `list` of results.
`Search`	`locale(Locale locale)` `Locale` to use for queries.
`Search`	`orderBy(String field)` Sort results by a specific field in ascending order.
`Search`	`orderBy(String field, SearchParameter.SortOrder dir)` Sort results by a specific field and given order.
`Search`	`page(int page)` Page number to return, starts with 1.
`Search`	`params(SearchParameter params)` Replaces the underlying `SearchParameter` object.
`Search`	`query(String query)` Query indexed fields.
`Search`	`returns(String... fields)` Fields to return.
`<T extends Base> Set<T>`	`set()` Get a `set` of results.
`<T extends Base> T`	`single()` Get a single result.
`Search`	`start(int start)` Start results at a specific position.
`<T extends Base> java.util.stream.Stream<T>`	`stream()` Get a `stream` of results.
`Number`	`sum(String field)` Adds all found field values.
`Integer`	`toInt()` Get a `Integer` value.
`Long`	`toLong()` Get a `Long` value.
`Search`	`uuids(Collection<String> uuids)` Filter results by uuids.
`Search`	`uuids(String... uuids)` Filter results by uuids.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Search
```
public Search(Repository<? extends Base> repository)
```
- Method Detail
  - count
```
public long count()
```
    Count the number of results.
    
    Returns:
    
    The result count
  - count
```
public long count(String id)
```
    Count the number of results of a specific identifier.
    
    Parameters:
    
    id - The identifier to use
    
    Returns:
    
    The result count
  - sum
```
public Number sum(String field)
```
    Adds all found field values.
    
    Parameters:
    
    field - The field to sum up
    
    Returns:
    
    The sum of all results
  - stream
```
public <T extends Base> java.util.stream.Stream<T> stream()
```
    Get a stream of results.
    
    Returns:
    
    A stream of results
    
    Throws:
    
    ClassCastException - when the SearchParameter.returns value was not matching the class to return
  - list
```
public <T extends Base> List<T> list()
```
    Get a list of results.
    
    Returns:
    
    A list of results
    
    Throws:
    
    ClassCastException - when the SearchParameter.returns value was not matching the class to return
  - set
```
public <T extends Base> Set<T> set()
```
    Get a set of results.
    
    Returns:
    
    A set of results
    
    Throws:
    
    ClassCastException - when the SearchParameter.returns value was not matching the class to return
  - single
```
public <T extends Base> T single()
```
    Get a single result.
    
    Returns:
    
    A single result
    
    Throws:
    
    ClassCastException - when the SearchParameter.returns value was not matching the class to return
  - toLong
```
public Long toLong()
```
    Get a Long value. Tries to convert the result to Long and throws an UnsupportedOperationException if that fails.
    
    Returns:
    
    A Long value
  - toInt
```
public Integer toInt()
```
    Get a Integer value. Tries to convert the result to Integer and throws an UnsupportedOperationException if that fails.
    
    Returns:
    
    A Integer value
  - debug
```
public Search debug()
```
    Print queries and parameters to stdout.
  - fields
```
public Search fields(String... fields)
```
    Fields to fetch on results.
    
    Parameters:
    
    fields - Fields to fetch
  - fields
```
public Search fields(QueryField... fields)
```
    Fields to fetch on results.
    
    Parameters:
    
    fields - QueryField's to fetch
  - fields
```
public Search fields(FieldList fields)
```
    Fields to fetch on results.
    
    Parameters:
    
    fields - FieldList containing all fields to fetch
  - filter
```
public Search filter(String property,
                     String value)
```
    Filter results by field values. Supports only Filter.Equals filter.
    
    Parameters:
    
    property - Field to apply the filter on
    
    value - Value to look for
  - filter
```
public Search filter(Filter filter)
```
    Adds a filter for results.
    
    Parameters:
    
    filter - Filter to add
  - params
```
public Search params(SearchParameter params)
```
    Replaces the underlying SearchParameter object. This should be called first, to prevent overriding.
    
    Parameters:
    
    params - SearchParameter object
  - locale
```
public Search locale(Locale locale)
```
    Locale to use for queries.
    
    Parameters:
    
    locale - Locale to use
  - query
```
public Search query(String query)
```
    Query indexed fields. Use '*' as wildcard operator at start or end of query. Use the form 'field:queryString' to query only specific fields. Could be replaced by filters. But this provides a convenient way to make simple queries.
    
    Parameters:
    
    query - The querystring to use
  - start
```
public Search start(int start)
```
    Start results at a specific position. Especially useful in combination when results are ordered.
    
    Parameters:
    
    start - The position to start from.
  - ids
```
public Search ids(Long... ids)
```
    Filter results by ids.
    
    Parameters:
    
    ids - Ids to include in results
  - ids
```
public Search ids(Collection<Long> ids)
```
    Filter results by ids.
    
    Parameters:
    
    ids - Ids to include in results as set
  - uuids
```
public Search uuids(String... uuids)
```
    Filter results by uuids.
    
    Parameters:
    
    uuids - UUIDs to include in results
  - uuids
```
public Search uuids(Collection<String> uuids)
```
    Filter results by uuids.
    
    Parameters:
    
    uuids - UUIDs to include in results as list
  - limit
```
public Search limit(int limit)
```
    Limit results to a specific count.
    
    Parameters:
    
    limit - Amount of results to return
  - page
```
public Search page(int page)
```
    Page number to return, starts with 1. Should be used in combination with limit. If set, there's no start required.
    
    Parameters:
    
    page - Page number
  - orderBy
```
public Search orderBy(String field)
```
    Sort results by a specific field in ascending order.
    
    Parameters:
    
    field - Field, by which results will be sorted
  - orderBy
```
public Search orderBy(String field,
                      SearchParameter.SortOrder dir)
```
    Sort results by a specific field and given order.
    
    Parameters:
    
    field - Field, by which results will be sorted
    
    dir - Sort direction (ascending or descending)
  - returns
```
public Search returns(String... fields)
```
    Fields to return.
    
    Parameters:
    
    fields - Fields to return

Class Search

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Search

Method Detail

count

count

sum

stream

list

set

single

toLong

toInt

debug

fields

fields

fields

filter

filter

params

locale

query

start

ids

ids

uuids

uuids

limit

page

orderBy

orderBy

returns