Package ome.formats.enums

Interface EnumerationProvider

  • All Known Implementing Classes:
    IQueryEnumProvider
    public interface EnumerationProvider
    An enumeration provider, whose job is to make OMERO enumerations available to a consumer based on a set of criteria. Fundamentally, concrete implementations are designed to isolate consumers from the semantics of OMERO services such as IQuery and IObject and to provide a consistent, server agnostic API to unit test code.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      <T extends IObject>
      T      		 getEnumeration​(java.lang.Class<T> klass, java.lang.String value, boolean loaded)
      Retrieves an enumeration.
      <T extends IObject>
      java.util.HashMap<java.lang.String,​T>      		 getEnumerations​(java.lang.Class<T> klass)
      Retrieves all enumerations of a specific type.

    • Method Detail

      • getEnumeration

        <T extends IObject> T getEnumeration​(java.lang.Class<T> klass,
                                     java.lang.String value,
                                     boolean loaded)
        Retrieves an enumeration.
        Parameters:
        klass - Enumeration's base class from ome.model.enums.
        value - Enumeration's string value.
        loaded - true if the enumeration returned should be loaded, otherwise false.
        Returns:
        Enumeration object.

      • getEnumerations

        <T extends IObject> java.util.HashMap<java.lang.String,​T> getEnumerations​(java.lang.Class<T> klass)
        Retrieves all enumerations of a specific type.
        Parameters:
        klass - Enumeration's base class from ome.model.enums.
        Returns:
        Enumeration object.