Package omero.gateway.model

Enum SearchScope

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<SearchScope>
    public enum SearchScope
extends java.lang.Enum<SearchScope>
    Defines the scope of a search, i.e. in which fields to search (name, description, etc.); See SearchParameters
    Since:
    5.1

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getStringRepresentation()
      Get a String representation of this scope which can be used in a lucene search
      static java.lang.String getStringRepresentation​(java.util.Collection<SearchScope> scopes)
      Get a String representation of the given scopes which can be used in a lucence search
      static SearchScope valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static SearchScope[] 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, toString, valueOf

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Method Detail

      • values

        public static SearchScope[] 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 (SearchScope c : SearchScope.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static SearchScope valueOf​(java.lang.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:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null

      • getStringRepresentation

        public java.lang.String getStringRepresentation()
        Get a String representation of this scope which can be used in a lucene search
        Returns:
        See above.

      • getStringRepresentation

        public static java.lang.String getStringRepresentation​(java.util.Collection<SearchScope> scopes)
        Get a String representation of the given scopes which can be used in a lucence search
        Parameters:
        scopes - The scopes
        Returns:
        See above