com.compomics.util.experiment.filtering

Enum FilterItemComparator

java.lang.Object

java.lang.Enum<FilterItemComparator>

com.compomics.util.experiment.filtering.FilterItemComparator

All Implemented Interfaces:

Serializable, Comparable<FilterItemComparator>

public enum FilterItemComparator
extends Enum<FilterItemComparator>

Comparators for filter items.

Author:

Marc Vaudel

Enum Constant Summary

Enum Constants

Enum Constant and Description
contains
equal
excludes
higher
higherOrEqual
lower
lowerOrEqual
matches

Field Summary

Fields

Modifier and Type	Field and Description
String	description The description to use.
String	name The symbol to use.
static String[]	trueFalse Array of possibilities used for a boolean value.

Method Summary

Modifier and Type	Method and Description
boolean	passes(String threshold, List<String> values) Indicates whether a set of values passes a threshold using this comparator.
boolean	passes(String threshold, String value) Indicates whether a given value passes a threshold using this comparator.
boolean	passes(String threshold, String[] values) Indicates whether a set of values passes a threshold using this comparator.
String	toString()
static FilterItemComparator	valueOf(String name) Returns the enum constant of this type with the specified name.
static FilterItemComparator[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

equal

public static final FilterItemComparator equal

higher

public static final FilterItemComparator higher

lower

public static final FilterItemComparator lower

higherOrEqual

public static final FilterItemComparator higherOrEqual

lowerOrEqual

public static final FilterItemComparator lowerOrEqual

contains

public static final FilterItemComparator contains

excludes

public static final FilterItemComparator excludes

matches

public static final FilterItemComparator matches

Field Detail

name

public final String name

The symbol to use.

description

public final String description

The description to use.

trueFalse

public static final String[] trueFalse

Array of possibilities used for a boolean value.

Method Detail

values

public static FilterItemComparator[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (FilterItemComparator c : FilterItemComparator.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static FilterItemComparator valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

passes

public boolean passes(String threshold,
                      String value)

Indicates whether a given value passes a threshold using this comparator.

Parameters:

threshold - the threshold as string

value - the value as string

Returns:

a boolean indicating whether a given value passes a threshold using this comparator

passes

public boolean passes(String threshold,
                      List<String> values)

Indicates whether a set of values passes a threshold using this comparator.

Parameters:

threshold - the threshold as string

values - list of values

Returns:

a boolean indicating whether a given value passes a threshold using this comparator

passes

public boolean passes(String threshold,
                      String[] values)

Indicates whether a set of values passes a threshold using this comparator.

Parameters:

threshold - the threshold as string

values - list of values

Returns:

a boolean indicating whether a given value passes a threshold using this comparator

toString

public String toString()

Overrides:

toString in class Enum<FilterItemComparator>