ome.api
Interface ITypes

All Superinterfaces:
ServiceInterface
All Known Implementing Classes:
TypesImpl

public interface ITypes
extends ServiceInterface

Access to reflective type information. Also provides simplified access to special types like enumerations.

Since:
OMERO3
Version:
3.0 (Internal version: $$)
Author:
Josh Moore      josh.moore@gmx.de

Method Summary
<T extends ome.model.IEnum>
List<T>
allEnumerations(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
 List<Class<ome.model.IAnnotated>> getAnnotationTypes()
          Returns a list of classes which implement IAnnotated.
<T extends ome.model.IEnum>
T
getEnumeration(Class<T> k, String string)
          lookup an enumeration value.
<T extends ome.model.IEnum>
Map<Class<T>,List<T>>
getEnumerationsWithEntries()
          Gets all metadata classes which are IEnum type with contained objects.
<T extends ome.model.IEnum>
List<Class<T>>
getEnumerationTypes()
          Gets all metadata classes which are IEnum type.
<T extends ome.model.IEnum>
List<T>
getOriginalEnumerations()
          Gets all original values.
<T extends ome.model.IEnum>
void
resetEnumerations(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(List<T> listEnum)
          updates enumeration value specified by object
 

Method Detail

getAnnotationTypes

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

Returns:

createEnumeration

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

allEnumerations

<T extends ome.model.IEnum> List<T> allEnumerations(Class<T> k)

getEnumeration

<T extends ome.model.IEnum> T getEnumeration(Class<T> k,
                                             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(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> 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:
RuntimeException - if xml parsing failure.

resetEnumerations

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

getEnumerationTypes

<T extends ome.model.IEnum> List<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:
RuntimeException - if Class not found.

getEnumerationsWithEntries

<T extends ome.model.IEnum> Map<Class<T>,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:
RuntimeException - if xml parsing failure.


OmeroJava Api

Version: Beta4.2.1-r8614-Beta4.2-b41

Copyright © 2009 The University of Dundee. All Rights Reserved.