Package org.cytoscape.filter.predicates

Enum Class Predicate

java.lang.Object
java.lang.Enum<Predicate>
org.cytoscape.filter.predicates.Predicate
All Implemented Interfaces:
Serializable, Comparable<Predicate>, java.lang.constant.Constable
public enum Predicate extends Enum<Predicate>
Various predicates that can be used to test conditions in Transformers. Implementations are free to support any subset of the predicates listed here.

Cytoscape Backwards Compatibility (Enum): This class is an enum therefore can't be extended by users. This means that we may add methods or enum values for minor version updates. Methods or enum values will only be removed for major version updates.

Module: filter-api

To use this in your app, include the following dependency in your POM:

<dependency>
    <groupId>org.cytoscape</groupId>
    <artifactId>filter-api</artifactId>
</dependency>

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    BETWEEN
    A ternary predicate that tests whether the first parameter is greater than or equal to the second parameter, and less than or equal to the third parameter.
    CONTAINS
    A binary predicate that tests whether the first parameter is contained within the second parameter.
    DOES_NOT_CONTAIN
    A binary predicate that tests whether the first parameter does not contain the second parameter.
    GREATER_THAN
    A binary predicate that tests whether the first parameter is greater than the second.
    GREATER_THAN_OR_EQUAL
    A binary predicate that tests whether the first parameter is greater than or equal to the second.
    IS
    A binary predicate that tests whether the first parameter is equal to the second.
    IS_NOT
    A binary predicate that tests whether the first parameter is not equal to the second.
    IS_NOT_BETWEEN
    A ternary predicate that tests whether the first parameter is less than the second parameter, and greater than the third parameter.
    LESS_THAN
    A binary predicate that tests whether the first parameter is less than the second.
    LESS_THAN_OR_EQUAL
    A binary predicate that tests whether the first parameter is less than or equal to the second.
    REGEX
    A binary predicate that tests whether the first parameter matches a regular expression (second parameter).

  • Method Summary

    Modifier and Type
    Method
    Description
    static Predicate
    valueOf​(String name)
    Returns the enum constant of this class with the specified name.
    static Predicate[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Enum

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

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • IS

      public static final Predicate IS
      A binary predicate that tests whether the first parameter is equal to the second.

    • IS_NOT

      public static final Predicate IS_NOT
      A binary predicate that tests whether the first parameter is not equal to the second.

    • GREATER_THAN

      public static final Predicate GREATER_THAN
      A binary predicate that tests whether the first parameter is greater than the second.

    • GREATER_THAN_OR_EQUAL

      public static final Predicate GREATER_THAN_OR_EQUAL
      A binary predicate that tests whether the first parameter is greater than or equal to the second.

    • LESS_THAN

      public static final Predicate LESS_THAN
      A binary predicate that tests whether the first parameter is less than the second.

    • LESS_THAN_OR_EQUAL

      public static final Predicate LESS_THAN_OR_EQUAL
      A binary predicate that tests whether the first parameter is less than or equal to the second.

    • BETWEEN

      public static final Predicate BETWEEN
      A ternary predicate that tests whether the first parameter is greater than or equal to the second parameter, and less than or equal to the third parameter.

    • IS_NOT_BETWEEN

      public static final Predicate IS_NOT_BETWEEN
      A ternary predicate that tests whether the first parameter is less than the second parameter, and greater than the third parameter.

    • CONTAINS

      public static final Predicate CONTAINS
      A binary predicate that tests whether the first parameter is contained within the second parameter.

    • DOES_NOT_CONTAIN

      public static final Predicate DOES_NOT_CONTAIN
      A binary predicate that tests whether the first parameter does not contain the second parameter.

    • REGEX

      public static final Predicate REGEX
      A binary predicate that tests whether the first parameter matches a regular expression (second parameter).

  • Method Details

    • values

      public static Predicate[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static Predicate valueOf​(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name
      NullPointerException - if the argument is null