Package ome.api

Interface ITypes

  • All Superinterfaces:
    ServiceInterface
    public interface ITypes
extends ServiceInterface
    Access to reflective type information. Also provides simplified access to special types like enumerations.
    Since:
    OMERO3

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      <T extends ome.model.IEnum>
      java.util.List<T>      		 allEnumerations​(java.lang.Class<T> k)  
      <T extends ome.model.IEnum>
      T      		 createEnumeration​(T newEnum)  
      <T extends ome.model.IEnum>
      void      		 deleteEnumeration​(T oEnum)
      deletes enumeration value specified by object
      java.util.List<java.lang.Class<ome.model.IAnnotated>> getAnnotationTypes()
      Returns a list of classes which implement IAnnotated.
      <T extends ome.model.IEnum>
      T      		 getEnumeration​(java.lang.Class<T> k, java.lang.String string)
      lookup an enumeration value.
      <T extends ome.model.IEnum>
      java.util.Map<java.lang.Class<T>,​java.util.List<T>>      		 getEnumerationsWithEntries()
      Gets all metadata classes which are IEnum type with contained objects.
      <T extends ome.model.IEnum>
      java.util.List<java.lang.Class<T>>      		 getEnumerationTypes()
      Gets all metadata classes which are IEnum type.
      <T extends ome.model.IEnum>
      java.util.List<T>      		 getOriginalEnumerations()
      Gets all original values.
      <T extends ome.model.IEnum>
      void      		 resetEnumerations​(java.lang.Class<T> klass)  
      <T extends ome.model.IEnum>
      T      		 updateEnumeration​(T oEnum)
      updates enumeration value specified by object
      <T extends ome.model.IEnum>
      void      		 updateEnumerations​(java.util.List<T> listEnum)
      updates enumeration value specified by object

    • Method Detail

      • getAnnotationTypes

        java.util.List<java.lang.Class<ome.model.IAnnotated>> getAnnotationTypes()
        Returns a list of classes which implement IAnnotated. These can be used in combination with Search.
        Returns:
        a List of IAnnotated implementations

      • createEnumeration

        <T extends ome.model.IEnum> T createEnumeration​(T newEnum)

      • allEnumerations

        <T extends ome.model.IEnum> java.util.List<T> allEnumerations​(java.lang.Class<T> k)

      • getEnumeration

        <T extends ome.model.IEnum> T getEnumeration​(java.lang.Class<T> k,
                                             java.lang.String string)
        lookup an enumeration value. As with the get-methods of IQuery queries returning no results will through an exception.
        Type Parameters:
        T - The type of the enumeration. Must extend IEnum
        Parameters:
        k - An enumeration class which should be searched.
        string - The value for which an enumeration should be found.
        Returns:
        A managed enumeration. Never null.
        Throws:
        ome.conditions.ApiUsageException - if IEnum is not found.

      • updateEnumeration

        <T extends ome.model.IEnum> T updateEnumeration​(T oEnum)
        updates enumeration value specified by object
        Type Parameters:
        T - The type of the enumeration. Must extend IEnum
        Parameters:
        oEnum - An enumeration object which should be searched.
        Returns:
        A managed enumeration. Never null.

      • updateEnumerations

        <T extends ome.model.IEnum> void updateEnumerations​(java.util.List<T> listEnum)
        updates enumeration value specified by object
        Type Parameters:
        T - The type of the enumeration. Must extend IEnum
        Parameters:
        listEnum - An enumeration collection of objects which should be searched.

      • deleteEnumeration

        <T extends ome.model.IEnum> void deleteEnumeration​(T oEnum)
        deletes enumeration value specified by object
        Type Parameters:
        T - The type of the enumeration. Must extend IEnum
        Parameters:
        oEnum - An enumeration object which should be searched.

      • getOriginalEnumerations

        <T extends ome.model.IEnum> java.util.List<T> getOriginalEnumerations()
        Gets all original values.
        Type Parameters:
        T - The type of the enumeration. Must extend IEnum
        Returns:
        A list of managed enumerations.
        Throws:
        java.lang.RuntimeException - if xml parsing failure.

      • resetEnumerations

        <T extends ome.model.IEnum> void resetEnumerations​(java.lang.Class<T> klass)

      • getEnumerationTypes

        <T extends ome.model.IEnum> java.util.List<java.lang.Class<T>> getEnumerationTypes()
        Gets all metadata classes which are IEnum type.
        Type Parameters:
        T - The type of the enumeration. Must extend IEnum
        Returns:
        list of Class of T extends IEnum
        Throws:
        java.lang.RuntimeException - if Class not found.

      • getEnumerationsWithEntries

        <T extends ome.model.IEnum> java.util.Map<java.lang.Class<T>,​java.util.List<T>> getEnumerationsWithEntries()
        Gets all metadata classes which are IEnum type with contained objects.
        Type Parameters:
        T - The type of the enumeration. Must extend IEnum
        Returns:
        list of Class of T extends IEnum
        Throws:
        java.lang.RuntimeException - if xml parsing failure.