Package noaa.coastwatch.render.feature

Class SelectionRuleFilter

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

java.util.ArrayList<SelectionRule>

noaa.coastwatch.render.feature.SelectionRuleFilter

All Implemented Interfaces:

Serializable, Cloneable, Iterable<SelectionRule>, Collection<SelectionRule>, List<SelectionRule>, RandomAccess

public class SelectionRuleFilter
extends ArrayList<SelectionRule>

A SelectionRuleFilter is a list of SelectionRule objects together with an overall rule that determines how to filter a set of Feature objects. The filter list can be used for feature matching in one of two ways: either all the rules must be matched for a certain feature to be included, or any of the rules can be matched (at least one).

Since:

3.3.2

Author:

Peter Hollemans

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	SelectionRuleFilter.FilterMode	The mode that the filtering is operating under.

Field Summary

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor	Description
SelectionRuleFilter()	Creates a new empty filter with mode set to MATCHES_ANY.

Method Summary

Modifier and Type	Method	Description
Object	clone()
List<Feature>	filter(List<Feature> features)	Filters a collection of features using the rules in this filter for matching.
SelectionRuleFilter.FilterMode	getMode()	Gets the current filtering mode.
static void	main(String[] argv)	Tests this class.
void	setMode(SelectionRuleFilter.FilterMode mode)	Sets the filtering mode.
String	toString()

Methods inherited from class java.util.ArrayList

add, add, addAll, addAll, clear, contains, ensureCapacity, equals, forEach, get, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, removeIf, removeRange, replaceAll, retainAll, set, size, sort, spliterator, subList, toArray, toArray, trimToSize

Methods inherited from class java.util.AbstractCollection

containsAll

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Collection

parallelStream, stream, toArray

Methods inherited from interface java.util.List

containsAll

Constructor Details

SelectionRuleFilter

public SelectionRuleFilter()

Creates a new empty filter with mode set to MATCHES_ANY.

Method Details

clone

public Object clone()

Overrides:

clone in class ArrayList<SelectionRule>

filter

public List<Feature> filter(List<Feature> features)

Filters a collection of features using the rules in this filter for matching.

Parameters:

features - the features to filter.

Returns:

the list of the matching features, possibly empty.

setMode

public void setMode(SelectionRuleFilter.FilterMode mode)

Sets the filtering mode.

Parameters:

mode - the filtering mode, either MATCHES_ANY or MATCHES_ALL. When set to 'any', if any single rule matches a feature, the feature is included in the filter results. When set to 'all', the entire list of rules must match the feature for it to be included.

getMode

public SelectionRuleFilter.FilterMode getMode()

Gets the current filtering mode.

Returns:

the filtering mode, either MATCHES_ANY or MATCHES_ALL.

See Also:

• setMode(noaa.coastwatch.render.feature.SelectionRuleFilter.FilterMode)

toString

public String toString()

Overrides:

toString in class AbstractCollection<SelectionRule>

main

public static void main(String[] argv)
                 throws Exception

Tests this class.

Parameters:

argv - the array of command line parameters.

Throws:

Exception