com.tangosol.util.filter
Class ArrayFilter.WeightedFilter

java.lang.Object
  com.tangosol.util.filter.ArrayFilter.WeightedFilter

All Implemented Interfaces:

Comparable

Enclosing class:

ArrayFilter

protected static class ArrayFilter.WeightedFilter
extends Object
implements Comparable

A thin wrapper around a Filter allowing for sorting the filters according to their effectiveness.

Constructor Summary

protected

ArrayFilter.WeightedFilter(Filter filter, int nEffect) Construct the WeightedFilter.

Method Summary

int	compareTo(Object o) Compares this WeightedFilter with the specified WeightedFilter for order.
int	getEffectiveness() Get the effectiveness value of the wrapped filter.
Filter	getFilter() Get the wrapped filter.

Constructor Detail

ArrayFilter.WeightedFilter

protected ArrayFilter.WeightedFilter(Filter filter,
                                     int nEffect)

Construct the WeightedFilter.

Parameters:

filter - the wrapped filter

nEffect - the filter's effectiveness

Method Detail

compareTo

public int compareTo(Object o)

Compares this WeightedFilter with the specified WeightedFilter for order. Returns a negative integer, zero, or a positive integer as this WeightedFilter's effectiveness is less than, equal to, or greater than the effectiveness of the specified WeightedFilter object.

Specified by:

compareTo in interface Comparable

Parameters:

o - the Object to be compared

Returns:

a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object

Throws:

ClassCastException - if the specified object's type prevents it from being compared to this WeightedFilter

getFilter

public Filter getFilter()

Get the wrapped filter.

Returns:

the wrapped filter

getEffectiveness

public int getEffectiveness()

Get the effectiveness value of the wrapped filter.

Returns:

the effectiveness of the wrapped filter