omero.gateway.util

Class PojoMapper

java.lang.Object

omero.gateway.util.PojoMapper

public class PojoMapper
extends Object

Helper methods to convert IObjects into their corresponding DataObjects.

Since:

OME2.2

Version:

2.2

Author:

Jean-Marie Burel j.burel@dundee.ac.uk

Constructor Summary

Constructors

Constructor and Description
PojoMapper()

Method Summary

Modifier and Type	Method and Description
static <T extends DataObject> Collection<T>	asCastedDataObjects(List objects) Converts each element of the collection into its corresponding DataObject.
static DataObject	asDataObject(omero.model.IObject object) Converts the specified IObject into its corresponding DataObject.
static <K,V extends DataObject> Map<K,V>	asDataObjectMap(Class<K> keyKlass, Class<V> valueKlass, String method, List objects) Converts each element of the list to a pair (key, value) in the map.
static Set	asDataObjects(Collection objects) Deprecated. Use convertToDataObjects(Collection) instead
static Set	asDataObjects(omero.model.IObject[] objects) Deprecated. Use convertToDataObjects(Collection) instead
static Set	asDataObjects(List objects) Deprecated. Use convertToDataObjects(Collection) instead
static Map	asDataObjects(Map objects) Converts each pair (key, value) of the map.
static List	asDataObjectsAsList(Collection objects) Deprecated. Use convertToDataObjects(Collection) instead
static <T extends DataObject> Collection<T>	convertToDataObjects(Collection objects) Converts each element of the collection into its corresponding DataObject.
static String	convertTypeForSearch(Class nodeType) Converts the specified type to its corresponding type for search.
static String	convertTypeForSearchByQuery(Class nodeType) Deprecated. Not used.
static String	getGraphType(Class<? extends DataObject> dataType) Returns the name of the data type which has to used for Graph actions, see Requests
static Class<? extends omero.model.IObject>	getModelType(Class<? extends DataObject> pojoType) Converts the specified POJO into the corresponding model class.
static Class<? extends omero.model.IObject>	getModelType(String pojoType) Converts the specified POJO into the corresponding model class, see getModelType(Class)
static Class<? extends DataObject>	getPojoType(Class<? extends omero.model.IObject> modelType) Get the pojo type for a an IObject class (Reverse of getModelType(Class))

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PojoMapper

public PojoMapper()

Method Detail

asDataObject

public static DataObject asDataObject(omero.model.IObject object)

Converts the specified IObject into its corresponding DataObject.

Parameters:

object - The object to convert.

Returns:

See above.

Throws:

IllegalArgumentException - If the object is null or if the type IObject is unknown.

asDataObjects

public static Set asDataObjects(Collection objects)

Deprecated. Use convertToDataObjects(Collection) instead

Converts each element of the collection into its corresponding DataObject.

Parameters:

objects - The set of objects to convert.

Returns:

A set of DataObjects.

Throws:

IllegalArgumentException - If the set is null, doesn't contain IObject or if the type IObject is unknown.

convertToDataObjects

public static <T extends DataObject> Collection<T> convertToDataObjects(Collection objects)

Converts each element of the collection into its corresponding DataObject.

Parameters:

objects - The set of objects to convert.

Returns:

A set of DataObjects.

Throws:

IllegalArgumentException - If the set is null, doesn't contain IObject or if the type IObject is unknown.

asDataObjectsAsList

public static List asDataObjectsAsList(Collection objects)

Deprecated. Use convertToDataObjects(Collection) instead

Converts each element of the collection into its corresponding DataObject.

Parameters:

objects - The set of objects to convert.

Returns:

A set of DataObjects.

Throws:

IllegalArgumentException - If the set is null, doesn't contain IObject or if the type IObject is unknown.

asCastedDataObjects

public static <T extends DataObject> Collection<T> asCastedDataObjects(List objects)

Converts each element of the collection into its corresponding DataObject.

Parameters:

objects - The set of objects to convert.

Returns:

A set of DataObjects.

Throws:

IllegalArgumentException - If the set is null, doesn't contain IObject or if the type IObject is unknown.

asDataObjects

public static Set asDataObjects(List objects)

Deprecated. Use convertToDataObjects(Collection) instead

Converts each element of the collection into its corresponding DataObject.

Parameters:

objects - The set of objects to convert.

Returns:

A set of DataObjects.

Throws:

IllegalArgumentException - If the set is null, doesn't contain IObject or if the type IObject is unknown.

asDataObjects

public static Set asDataObjects(omero.model.IObject[] objects)

Deprecated. Use convertToDataObjects(Collection) instead

Converts each element of the array into its corresponding DataObject.

Parameters:

objects - The set of objects to convert.

Returns:

A set of DataObjects.

Throws:

IllegalArgumentException - If the set is null, doesn't contain IObject or if the type IObject is unknown.

asDataObjectMap

public static <K,V extends DataObject> Map<K,V> asDataObjectMap(Class<K> keyKlass,
                                                                Class<V> valueKlass,
                                                                String method,
                                                                List objects)
                                                         throws SecurityException,
                                                                NoSuchMethodException,
                                                                IllegalArgumentException,
                                                                IllegalAccessException,
                                                                InvocationTargetException

Converts each element of the list to a pair (key, value) in the map. The object in the list must be a IObject subclass and the key is the ID of the object.

Parameters:

keyKlass - The class that will be the key for the map

valueKlass - The class that will be the value for the map

method - The method name as a string that, using reflection, will be used to get the key from the object.

objects - The map of objects to convert.

Returns:

A map of converted objects.

Throws:

NoSuchMethodException

SecurityException

InvocationTargetException

IllegalAccessException

IllegalArgumentException

IllegalArgumentException - If the map is null or if the type IObject is unknown.

asDataObjects

public static Map asDataObjects(Map objects)

Converts each pair (key, value) of the map. If the key (resp. value) is an IObject, the element is converted into its corresponding DataObject.

Parameters:

objects - The map of objects to convert.

Returns:

A map of converted objects.

Throws:

IllegalArgumentException - If the map is null or if the type IObject is unknown.

convertTypeForSearchByQuery

public static String convertTypeForSearchByQuery(Class nodeType)

Deprecated. Not used.

Converts the specified type to its corresponding type for search by HQL query

Parameters:

nodeType - The type to convert.

Returns:

See above.

getPojoType

public static Class<? extends DataObject> getPojoType(Class<? extends omero.model.IObject> modelType)

Get the pojo type for a an IObject class (Reverse of getModelType(Class))

Parameters:

modelType - The IObject

Returns:

See above

getModelType

public static Class<? extends omero.model.IObject> getModelType(String pojoType)

Converts the specified POJO into the corresponding model class, see getModelType(Class)

Parameters:

pojoType - The POJO class (Either the simple or the full class name, e. g. omero.gateway.model.DatasetData or DatasetData)

Returns:

The corresponding IObject class.

getModelType

public static Class<? extends omero.model.IObject> getModelType(Class<? extends DataObject> pojoType)

Converts the specified POJO into the corresponding model class. (Reverse of getPojoType(Class))

Parameters:

pojoType - The POJO class.

Returns:

The corresponding IObject class.

getGraphType

public static String getGraphType(Class<? extends DataObject> dataType)

Returns the name of the data type which has to used for Graph actions, see Requests

Parameters:

dataType - The pojo type

Returns:

See above

convertTypeForSearch

public static String convertTypeForSearch(Class nodeType)

Converts the specified type to its corresponding type for search.

Parameters:

nodeType - The type to convert.

Returns:

See above.