omero.util

Class IceMapper

java.lang.Object

ome.util.ContextFilter

ome.util.ModelMapper

omero.util.IceMapper

All Implemented Interfaces:

Filter, ReverseModelMapper

Direct Known Subclasses:

RoiI.RoiResultMapper, RTypeMapper

public class IceMapper
extends ModelMapper
implements ReverseModelMapper

Responsible for the mapping of ome.* types to omero.* types and back again. Not all types are bidirectional, rather only those mappings are needed that actually appear in the blitz API. As of Beta3.1, an IceMapper instance can also be configured to handle return value mapping, though by default an exception will be thrown if mapReturnValue(Object) is called.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	IceMapper.ReturnMapping

Field Summary

Fields

Modifier and Type	Field and Description
static IceMapper.ReturnMapping	FILTERABLE
static IceMapper.ReturnMapping	FILTERABLE_ARRAY
static IceMapper.ReturnMapping	FILTERABLE_COLLECTION
static IceMapper.ReturnMapping	FILTERABLE_PRIMITIVE_MAP
static IceMapper.ReturnMapping	LISTOBJECTARRAY_TO_RTYPESEQSEQ
static IceMapper.ReturnMapping	OBJECT_TO_RTYPE
static IceMapper.ReturnMapping	OBJECTARRAY_TO_RTYPESEQ
static IceMapper.ReturnMapping	PRIMITIVE
static IceMapper.ReturnMapping	PRIMITIVE_FILTERABLE_COLLECTION_MAP
static IceMapper.ReturnMapping	PRIMITIVE_MAP
static IceMapper.ReturnMapping	RTYPEDICT
static IceMapper.ReturnMapping	STRING_TO_RSTRING
protected Map<Object,Object>	target2model
static IceMapper.ReturnMapping	UNMAPPED Specifies a return type which should not be parsed.
static IceMapper.ReturnMapping	VOID

Fields inherited from class ome.util.ModelMapper

model2target

Fields inherited from class ome.util.ContextFilter

_cache, _context

Constructor Summary

Constructors

Constructor and Description
IceMapper()
IceMapper(IceMapper.ReturnMapping mapping)

Method Summary

Modifier and Type	Method and Description
protected Map	c2c() TODO identity versus null mappings
boolean	canMapReturnValue() True if this instance has a IceMapper.ReturnMapping
CodomainMapContext	convert(omero.romio.CodomainMapContext ctx) Converts the passed Ice Object and returns the converted object.
static omero.RTime	convert(Date date)
static omero.sys.EventContext	convert(EventContext ctx)
static Filter	convert(omero.sys.Filter f)
static Options	convert(omero.sys.Options o)
Parameters	convert(omero.sys.Parameters params)
static omero.model.Permissions	convert(Permissions p)
static Permissions	convert(omero.model.Permissions p)
static PlaneDef	convert(omero.romio.PlaneDef def) Converts the passed Ice Object and returns the converted object.
static Principal	convert(omero.sys.Principal old)
static omero.romio.RGBBuffer	convert(RGBBuffer buffer)
static omero.sys.Roles	convert(Roles roles)
static Timestamp	convert(omero.RTime time)
QueryParameter	convert(String key, Object o)
static List<omero.model.NamedValue>	convertMapPairs(List<ome.xml.model.MapPair> map)
static List<omero.model.NamedValue>	convertNamedValueList(List<NamedValue> map)
static Map<String,omero.RString>	convertStringStringMap(Map<String,String> map) Convert a String→String map's values to RStrings.
static omero.ServerError	fillServerError(omero.ServerError se, Throwable t)
Filterable	filter(String fieldId, Filterable source)
Collection	findCollection(Collection source) Overrides the findCollection logic of ModelMapper, since all Collections should be Lists in Ice.
Object	fromRType(omero.RType rt) Uses the omero.rtypes hierarchy to properly convert any RType to its internal representation.
Ice.UserException	handleException(Throwable t, OmeroContext ctx)
Object	handleInput(Class<?> p, Object arg)
Object	handleOutput(Class type, Object o)
omero.ServerError	handleServerError(Throwable t, OmeroContext ctx) wraps any non-ServerError returned by handleException(Throwable, OmeroContext) in an InternalException.
protected boolean	hasntSeen(Object o)
boolean	isImmutable(Object obj)
protected static boolean	isNullablePrimitive(Class<?> p)
protected boolean	isPrimitive(Class<?> p)
boolean	isVoid() Returns true only if the current mapping is the VOID mapping.
protected static boolean	isWrapperArray(Class<?> p)
List	map(Filterable[] array)
Object	mapReturnValue(Object value) Convert the given Object via the set IceMapper.ReturnMapping.
static Class<? extends IObject>	omeroClass(String className, boolean strict)
Collection	reverse(Collection source) Copied from ModelMapper.findCollection(Collection) This could be unified in that a method findCollection(Collection, Map) was added with ModelMapper calling findCollection(source, model2target) and reverseCollection(Collection) calling findCollection(source,target2model).
Collection	reverse(Collection source, Class targetType) Creates a collection assignable to the given type.
Map	reverse(Map map)
Filterable	reverse(ModelBased source) Copied from ReverseModelMapper.
Object	reverse(Object source)
Object[]	reverseArray(List list, Class type) Supports the separate case of reversing for arrays.
static List<NamedValue>	reverseNamedList(List<omero.model.NamedValue> map)
static Map<String,String>	reverseStringStringMap(Map<String,omero.RString> rMap) Reverse a String→String map's values from RStrings.
void	store(Object source, Object target)
omero.RType	toRType(Object o)

Methods inherited from class ome.util.ModelMapper

event2timestamp, filter, filter, findClass, findCollectionTarget, findKeyTarget, findMap, findTarget, map, map, map, nullSafeDouble, nullSafeFloat, nullSafeInt, nullSafeLong, stackAsString

Methods inherited from class ome.util.ContextFilter

addSeen, afterFilter, beforeFilter, currentContext, doFilter, doFilter, doFilter, enter, exit, filter, filter, pop, previousContext, push

Methods inherited from class java.lang.Object

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

Field Detail

VOID

public static final IceMapper.ReturnMapping VOID

FILTERABLE

public static final IceMapper.ReturnMapping FILTERABLE

FILTERABLE_ARRAY

public static final IceMapper.ReturnMapping FILTERABLE_ARRAY

FILTERABLE_COLLECTION

public static final IceMapper.ReturnMapping FILTERABLE_COLLECTION

OBJECTARRAY_TO_RTYPESEQ

public static final IceMapper.ReturnMapping OBJECTARRAY_TO_RTYPESEQ

LISTOBJECTARRAY_TO_RTYPESEQSEQ

public static final IceMapper.ReturnMapping LISTOBJECTARRAY_TO_RTYPESEQSEQ

OBJECT_TO_RTYPE

public static final IceMapper.ReturnMapping OBJECT_TO_RTYPE

STRING_TO_RSTRING

public static final IceMapper.ReturnMapping STRING_TO_RSTRING

UNMAPPED

public static final IceMapper.ReturnMapping UNMAPPED

Specifies a return type which should not be parsed. This should only be used for objects unknown to the Mapper, and should not be used for any types which contain by transitivity any ome.model.* types!

PRIMITIVE

public static final IceMapper.ReturnMapping PRIMITIVE

PRIMITIVE_MAP

public static final IceMapper.ReturnMapping PRIMITIVE_MAP

FILTERABLE_PRIMITIVE_MAP

public static final IceMapper.ReturnMapping FILTERABLE_PRIMITIVE_MAP

PRIMITIVE_FILTERABLE_COLLECTION_MAP

public static final IceMapper.ReturnMapping PRIMITIVE_FILTERABLE_COLLECTION_MAP

RTYPEDICT

public static final IceMapper.ReturnMapping RTYPEDICT

target2model

protected Map<Object,Object> target2model

Constructor Detail

IceMapper

public IceMapper()

IceMapper

public IceMapper(IceMapper.ReturnMapping mapping)

Method Detail

isVoid

public boolean isVoid()

Returns true only if the current mapping is the VOID mapping.

canMapReturnValue

public boolean canMapReturnValue()

True if this instance has a IceMapper.ReturnMapping

mapReturnValue

public Object mapReturnValue(Object value)
                      throws Ice.UserException

Convert the given Object via the set IceMapper.ReturnMapping. Throws a NullPointerException if no mapping is set.

Throws:

Ice.UserException

fillServerError

public static omero.ServerError fillServerError(omero.ServerError se,
                                                Throwable t)

omeroClass

public static Class<? extends IObject> omeroClass(String className,
                                                  boolean strict)
                                           throws omero.ApiUsageException

Throws:

omero.ApiUsageException

toRType

public omero.RType toRType(Object o)
                    throws omero.ApiUsageException

Throws:

omero.ApiUsageException

fromRType

public Object fromRType(omero.RType rt)
                 throws omero.ApiUsageException

Uses the omero.rtypes hierarchy to properly convert any RType to its internal representation. This requires that the instance properly implement rtypes.Conversion otherwise ApiUsageException will be thrown.

Parameters:

rt - the wrapped value

Returns:

the value unwrapped

Throws:

omero.ApiUsageException - if the given value is not wrapped

convert

public static omero.sys.EventContext convert(EventContext ctx)

convert

public static omero.romio.RGBBuffer convert(RGBBuffer buffer)

convert

public CodomainMapContext convert(omero.romio.CodomainMapContext ctx)

Converts the passed Ice Object and returns the converted object.

Parameters:

ctx - The object to convert

Returns:

See above.

Throws:

omero.ApiUsageException - Thrown if the slice is unknown.

convert

public static PlaneDef convert(omero.romio.PlaneDef def)
                        throws omero.ApiUsageException

Converts the passed Ice Object and returns the converted object.

Parameters:

def - The object to convert

Returns:

See above.

Throws:

omero.ApiUsageException - Thrown if the slice is unknown.

convert

public static Principal convert(omero.sys.Principal old)

convert

public static omero.sys.Roles convert(Roles roles)

convert

public static omero.RTime convert(Date date)

convert

public static Timestamp convert(omero.RTime time)

convert

public Parameters convert(omero.sys.Parameters params)
                   throws omero.ApiUsageException

Throws:

omero.ApiUsageException

convert

public QueryParameter convert(String key,
                              Object o)
                       throws omero.ApiUsageException

Throws:

omero.ApiUsageException

convert

public static Options convert(omero.sys.Options o)

convert

public static Filter convert(omero.sys.Filter f)

convertNamedValueList

public static List<omero.model.NamedValue> convertNamedValueList(List<NamedValue> map)

convertMapPairs

public static List<omero.model.NamedValue> convertMapPairs(List<ome.xml.model.MapPair> map)

convertStringStringMap

public static Map<String,omero.RString> convertStringStringMap(Map<String,String> map)

Convert a String→String map's values to RStrings. null values are dropped completely.

Parameters:

map - a map

Returns:

the converted map, or null if map == null

findCollection

public Collection findCollection(Collection source)

Overrides the findCollection logic of ModelMapper, since all Collections should be Lists in Ice.

Overrides:

findCollection in class ModelMapper

map

public List map(Filterable[] array)

convert

public static omero.model.Permissions convert(Permissions p)

convert

public static Permissions convert(omero.model.Permissions p)

isImmutable

public boolean isImmutable(Object obj)

reverse

public Object reverse(Object source)
               throws omero.ApiUsageException

Throws:

omero.ApiUsageException

reverse

public Collection reverse(Collection source)

Copied from ModelMapper.findCollection(Collection) This could be unified in that a method findCollection(Collection, Map) was added with ModelMapper calling findCollection(source, model2target) and reverseCollection(Collection) calling findCollection(source,target2model).

Specified by:

reverse in interface ReverseModelMapper

Parameters:

source - the wrapped Collection

Returns:

the Collection unwrapped

reverse

public Collection reverse(Collection source,
                          Class targetType)

Creates a collection assignable to the given type. Currently only Set and List are supported, and HashSets and ArrayLists will be returned. The need for this arose from the decision to have no Sets in the Ice Java mapping.

See Also:

Trac ticket #684

reverseArray

public Object[] reverseArray(List list,
                             Class type)
                      throws omero.ServerError

Supports the separate case of reversing for arrays. See reverse(Collection, Class) and map(Filterable[]).

Throws:

omero.ServerError

reverse

public Map reverse(Map map)

reverse

public Filterable reverse(ModelBased source)

Copied from ReverseModelMapper.

Specified by:

reverse in interface ReverseModelMapper

reverseStringStringMap

public static Map<String,String> reverseStringStringMap(Map<String,omero.RString> rMap)

Reverse a String→String map's values from RStrings. null values are dropped completely.

Parameters:

rMap - a map

Returns:

the reversed map, or null if rMap == null

reverseNamedList

public static List<NamedValue> reverseNamedList(List<omero.model.NamedValue> map)

store

public void store(Object source,
                  Object target)

c2c

protected Map c2c()

Description copied from class: ModelMapper

TODO identity versus null mappings

Specified by:

c2c in class ModelMapper

Returns:

a map from IObject classes ModelBased classes.

filter

public Filterable filter(String fieldId,
                         Filterable source)

Specified by:

filter in interface Filter

Overrides:

filter in class ModelMapper

hasntSeen

protected boolean hasntSeen(Object o)

Overrides:

hasntSeen in class ContextFilter

isPrimitive

protected boolean isPrimitive(Class<?> p)

isNullablePrimitive

protected static boolean isNullablePrimitive(Class<?> p)

isWrapperArray

protected static boolean isWrapperArray(Class<?> p)

handleInput

public Object handleInput(Class<?> p,
                          Object arg)
                   throws omero.ServerError

Throws:

omero.ServerError

handleOutput

public Object handleOutput(Class type,
                           Object o)
                    throws omero.ServerError

Throws:

omero.ServerError

handleServerError

public omero.ServerError handleServerError(Throwable t,
                                           OmeroContext ctx)

wraps any non-ServerError returned by handleException(Throwable, OmeroContext) in an InternalException.

handleException

public Ice.UserException handleException(Throwable t,
                                         OmeroContext ctx)