fr.vergne.collection.filter

Class FilterUtil

java.lang.Object

fr.vergne.collection.filter.FilterUtil

public class FilterUtil
extends Object

Constructor Summary

Constructors

Constructor and Description
FilterUtil()

Method Summary

Methods

Modifier and Type	Method and Description
static <Element> Collection<Element>	filter(Collection<Element> elements, Filter<Element>... filters) Convenient method to filter the elements, trying to be as strict as possible.
static <Element> Collection<Element>	filter(Collection<Element> elements, FilterDecider<Element> decider, Filter<Element>... filters) This method filter a collection of elements by using Filters.
static <Element> Collection<Element>	filter(Collection<Element> elements, FilteringStrategy uninformativeStrategy, FilteringStrategy conflictualStrategy, Filter<Element>... filters) This method filter a collection of elements by using some Filter s.
static <Element> Collection<Element>	filterConservatively(Collection<Element> elements, Filter<Element>... filters) Convenient method to filter the elements, trying to keep as much as possible.
static <Element> Collection<Element>	filterExpeditively(Collection<Element> elements, Filter<Element>... filters) Convenient method to filter the elements, trying to reject as much as possible.

Methods inherited from class java.lang.Object

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

Constructor Detail

FilterUtil

public FilterUtil()

Method Detail

filter

public static <Element> Collection<Element> filter(Collection<Element> elements,
                                   Filter<Element>... filters)
                                  throws UndecidedFilteringException

Convenient method to filter the elements, trying to be as strict as possible. This is equivalent to filter(Collection, FilteringStrategy, FilteringStrategy, Filter...) with both filtering modes at FilteringStrategy.EXPLICIT.

Throws:

UndecidedFilteringException

filterConservatively

public static <Element> Collection<Element> filterConservatively(Collection<Element> elements,
                                                 Filter<Element>... filters)
                                                throws UndecidedFilteringException

Convenient method to filter the elements, trying to keep as much as possible. This is equivalent to filter(Collection, FilteringStrategy, FilteringStrategy, Filter...) with both filtering modes at FilteringStrategy.CONSERVATIVE.

Throws:

UndecidedFilteringException

filterExpeditively

public static <Element> Collection<Element> filterExpeditively(Collection<Element> elements,
                                               Filter<Element>... filters)
                                              throws UndecidedFilteringException

Convenient method to filter the elements, trying to reject as much as possible. This is equivalent to filter(Collection, FilteringStrategy, FilteringStrategy, Filter...) with both filtering modes at FilteringStrategy.EXPEDITIVE.

Throws:

UndecidedFilteringException

filter

public static <Element> Collection<Element> filter(Collection<Element> elements,
                                   FilteringStrategy uninformativeStrategy,
                                   FilteringStrategy conflictualStrategy,
                                   Filter<Element>... filters)
                                  throws UndecidedFilteringException

This method filter a collection of elements by using some Filter s. In the case no clear decision can be taken, some simple FilteringStrategys are applied. Basically, it build a FilterDecider based on these FilteringStrategys and return the result of filter(Collection, FilterDecider, Filter...).

Parameters:

elements - the elements to filter

uninformativeStrategy - FilteringStrategy to apply when no supporter nor rejector is found

conflictualStrategy - FilteringStrategy to apply when both supporters and rejectors are found

filters - the filters to apply

Returns:

the filtered collection

Throws:

UndecidedFilteringException - when the FilteringStrategys does not allow to decide

filter

public static <Element> Collection<Element> filter(Collection<Element> elements,
                                   FilterDecider<Element> decider,
                                   Filter<Element>... filters)
                                  throws UndecidedFilteringException

This method filter a collection of elements by using Filters. In the case the support/rejection cannot be decided (no Filter gives an informative answer or both supporters and rejectors are found), a FilterDecider take the lead and decide the final answer. This allows for instance to manage custom strategies such as prioritized or weighted Filters.

Parameters:

elements - the elements to filter

decider - a FilterDecider which manages the undecided cases

filters - the filters to apply

Returns:

the filtered collection

Throws:

UndecidedFilteringException - when the FilterDecider is not able to decide