io.stallion.dataAccess.filtering

Class FilterChain<T extends Model>

java.lang.Object

io.stallion.dataAccess.filtering.FilterChain<T>

Type Parameters:

T -

All Implemented Interfaces:

Iterable<T>

Direct Known Subclasses:

MySqlFilterChain

public class FilterChain<T extends Model>
extends Object
implements Iterable<T>

A FilterChain is the default way by which data from a ModelController is actually queried and accessed. You use it as follows: List<Books> books = MyBooksController.instance() .filter('published', true') .filter('author', 'Mark Twain') .exclude('publishDate.year', 2014) .sort('publishDate', 'desc') .all(); You can chain together as many "filter" commands as you want. The chain is not actually executed until you call one of the access methods: all(), first(), count(), groupBy()

Field Summary

Fields

Modifier and Type	Field and Description
protected ArrayList<io.stallion.dataAccess.filtering.FilterOperation>	operations

Constructor Summary

Constructors

Constructor and Description
FilterChain(FilterChain chain, LocalMemoryStash<T> stash)
FilterChain(String bucket, List<T> originalObjects, io.stallion.dataAccess.filtering.FilterOperation op, LocalMemoryStash<T> stash)
FilterChain(String bucket, List<T> originalObjects, LocalMemoryStash<T> stash)
FilterChain(String bucket, LocalMemoryStash<T> stash)

Method Summary

Modifier and Type	Method and Description
List<T>	all() Executes the filters and returns all matching items.
FilterChain<T>	andAnyOf(List<String>... tuples)
FilterChain<T>	andAnyOf(Map<String,Object> allowedMatches)
FilterChain<T>	andAnyOf(Or... ors)
protected boolean	checkSkipCache(String key)
protected FilterChain<T>	cloneChainAndAddOperation(io.stallion.dataAccess.filtering.FilterOperation operation)
<Y> List<Y>	column(String name) Executes the filters, and returns a list of all values of the given property name for all matching objects.
int	count() Executes the filters and returns the total matching count.
List<FilterGroup<T>>	countBy(String... fieldNames) Count the objects matching this filter, grouped by fieldNames.
boolean	empty() Executes the filters and returns true if there are no matching items found.
FilterChain	exclude(String name, Object value) Excludes all matching items instead of including them.
FilterChain	exclude(String name, Object value, String op) Excludes all matching items instead of including them.
FilterChain<T>	excludeAnyOf(Or... ors)
FilterChain	excludeBy(String name, Object value, FilterOperator op) Excludes all matching items instead of including them.
FilterChain<T>	filter(String name, Comparable value) Do a basic equality filter.
FilterChain<T>	filter(String name, Comparable value, String op)
FilterChain<T>	filter(String name, Object val) Do a basic equality filter
FilterChain<T>	filter(String name, Object value, String op) Add a filter to the chain
FilterChain<T>	filterBy(String name, Comparable value, FilterOperator op) Add a filter to the chain with a custom operator
FilterChain<T>	filterBy(String name, Object value, FilterOperator op) Add a filter to the chain with a custom operator
T	first() Executes the filters and returns the first matching item.
void	forEach(Consumer<? super T> action)
String	getBucket()
protected Object	getCached(String methodName)
String	getExtraCacheKey()
Boolean	getIncludeDeleted()
protected Integer	getMatchingCount()
protected List<T>	getObjects()
ArrayList<io.stallion.dataAccess.filtering.FilterOperation>	getOperations()
SortDirection	getSortDirection()
String	getSortField()
List<FilterGroup<T>>	groupBy(String... fieldNames) Group the matching objects by field names.
FilterChain<T>	includeDeleted()
boolean	isEmpty() Alias for empty(), no matching items.
Iterator<T>	iterator()
protected FilterChain<T>	newCopy() Create a copy this filter chain.
Pager	pager(Integer page) Alias for pager(page, 10) (default page size of 10);
Pager	pager(Integer page, Integer size) Executes the filters and returns a pager object.
protected void	process() Alias for process(0, 100000, false)
protected void	process(int page, int size, boolean fetchTotalMatching) Actually applies all filters and sorts to reduce the originalObjects into a subset of matched objects.
FilterChain<T>	search(String value, String... fields) Searches for @value in all @fields, using a case-insensitive string contains search.
protected void	setBucket(String bucket)
protected void	setCached(String methodName, Object val)
protected void	setExtraCacheKey(String extraCacheKey)
protected FilterChain<T>	setIncludeDeleted(Boolean includeDeleted)
protected void	setMatchingCount(Integer matchingCount)
protected void	setObjects(List<T> objects)
protected void	setSortDirection(SortDirection sortDirection)
protected void	setSortField(String sortField)
FilterChain<T>	sort(String fieldName, String direction) Adds a sort direction the filter chain response.
FilterChain<T>	sortBy(String fieldName, SortDirection direction) Adds a sort direction the filter chain response.
Spliterator<T>	spliterator()

Methods inherited from class java.lang.Object

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

Field Detail

operations

protected ArrayList<io.stallion.dataAccess.filtering.FilterOperation> operations

Constructor Detail

FilterChain

public FilterChain(String bucket,
                   LocalMemoryStash<T> stash)

FilterChain

public FilterChain(String bucket,
                   List<T> originalObjects,
                   LocalMemoryStash<T> stash)

FilterChain

public FilterChain(String bucket,
                   List<T> originalObjects,
                   io.stallion.dataAccess.filtering.FilterOperation op,
                   LocalMemoryStash<T> stash)

FilterChain

public FilterChain(FilterChain chain,
                   LocalMemoryStash<T> stash)

Method Detail

filter

public FilterChain<T> filter(String name,
                             Object val)

Do a basic equality filter

Parameters:

name -

val -

Returns:

filter

public FilterChain<T> filter(String name,
                             Comparable value)

Do a basic equality filter.

Parameters:

name -

value -

Returns:

filter

public FilterChain<T> filter(String name,
                             Object value,
                             String op)

Add a filter to the chain

Parameters:

name -

value -

op -

Returns:

filter

public FilterChain<T> filter(String name,
                             Comparable value,
                             String op)

filterBy

public FilterChain<T> filterBy(String name,
                               Object value,
                               FilterOperator op)

Add a filter to the chain with a custom operator

Parameters:

name -

value -

op -

Returns:

filterBy

public FilterChain<T> filterBy(String name,
                               Comparable value,
                               FilterOperator op)

Add a filter to the chain with a custom operator

Parameters:

name -

value -

op -

Returns:

search

public FilterChain<T> search(String value,
                             String... fields)

Searches for @value in all @fields, using a case-insensitive string contains search.

Parameters:

value -

value -

Returns:

exclude

public FilterChain exclude(String name,
                           Object value)

Excludes all matching items instead of including them.

Parameters:

name -

value -

Returns:

exclude

public FilterChain exclude(String name,
                           Object value,
                           String op)

Excludes all matching items instead of including them.

Parameters:

name -

value -

op -

Returns:

excludeBy

public FilterChain excludeBy(String name,
                             Object value,
                             FilterOperator op)

Excludes all matching items instead of including them.

Parameters:

name -

value -

op -

Returns:

andAnyOf

public FilterChain<T> andAnyOf(Map<String,Object> allowedMatches)

andAnyOf

public FilterChain<T> andAnyOf(List<String>... tuples)

andAnyOf

public FilterChain<T> andAnyOf(Or... ors)

excludeAnyOf

public FilterChain<T> excludeAnyOf(Or... ors)

cloneChainAndAddOperation

protected FilterChain<T> cloneChainAndAddOperation(io.stallion.dataAccess.filtering.FilterOperation operation)

newCopy

protected FilterChain<T> newCopy()

Create a copy this filter chain.

Returns:

countBy

public List<FilterGroup<T>> countBy(String... fieldNames)

Count the objects matching this filter, grouped by fieldNames.

Parameters:

fieldNames -

Returns:

groupBy

public List<FilterGroup<T>> groupBy(String... fieldNames)

Group the matching objects by field names. So if I wanted a group of blog posts written by some author, grouped by year/month I would do: BlogPostController.instance() .filter("author", "Mark Twain") .groupBy("publishDate.year", "publishDate.month");

Parameters:

fieldNames -

Returns:

all

public List<T> all()

Executes the filters and returns all matching items.

Returns:

empty

public boolean empty()

Executes the filters and returns true if there are no matching items found.

Returns:

isEmpty

public boolean isEmpty()

Alias for empty(), no matching items.

Returns:

column

public <Y> List<Y> column(String name)

Executes the filters, and returns a list of all values of the given property name for all matching objects.

Type Parameters:

Y -

Parameters:

name -

Returns:

count

public int count()

Executes the filters and returns the total matching count.

Returns:

first

public T first()

Executes the filters and returns the first matching item.

Returns:

sort

public FilterChain<T> sort(String fieldName,
                           String direction)

Adds a sort direction the filter chain response.

Parameters:

fieldName -

direction - - either asc or desc

Returns:

sortBy

public FilterChain<T> sortBy(String fieldName,
                             SortDirection direction)

Adds a sort direction the filter chain response.

Parameters:

fieldName -

direction -

Returns:

pager

public Pager pager(Integer page)

Alias for pager(page, 10) (default page size of 10);

Parameters:

page -

Returns:

pager

public Pager pager(Integer page,
                   Integer size)

Executes the filters and returns a pager object. A page object has a subset of the items based on the desired page and the page size

Parameters:

page - - which page to return

size - - how many items are on a page

Returns:

process

protected void process()

Alias for process(0, 100000, false)

process

protected void process(int page,
                       int size,
                       boolean fetchTotalMatching)

Actually applies all filters and sorts to reduce the originalObjects into a subset of matched objects.

Parameters:

page - - the page to start from when returning results

size - - the number of results per page (the number of results to return)

fetchTotalMatching - - hydrate the total matching count field, even if we are returning a subet

getCached

protected Object getCached(String methodName)

checkSkipCache

protected boolean checkSkipCache(String key)

setCached

protected void setCached(String methodName,
                         Object val)

iterator

public Iterator<T> iterator()

Specified by:

iterator in interface Iterable<T extends Model>

forEach

public void forEach(Consumer<? super T> action)

Specified by:

forEach in interface Iterable<T extends Model>

spliterator

public Spliterator<T> spliterator()

Specified by:

spliterator in interface Iterable<T extends Model>

getSortField

public String getSortField()

setSortField

protected void setSortField(String sortField)

getSortDirection

public SortDirection getSortDirection()

setSortDirection

protected void setSortDirection(SortDirection sortDirection)

getBucket

public String getBucket()

setBucket

protected void setBucket(String bucket)

getExtraCacheKey

public String getExtraCacheKey()

setExtraCacheKey

protected void setExtraCacheKey(String extraCacheKey)

getIncludeDeleted

public Boolean getIncludeDeleted()

setIncludeDeleted

protected FilterChain<T> setIncludeDeleted(Boolean includeDeleted)

includeDeleted

public FilterChain<T> includeDeleted()

getOperations

public ArrayList<io.stallion.dataAccess.filtering.FilterOperation> getOperations()

getMatchingCount

protected Integer getMatchingCount()

setMatchingCount

protected void setMatchingCount(Integer matchingCount)

getObjects

protected List<T> getObjects()

setObjects

protected void setObjects(List<T> objects)