ome.services.query

Class HierarchyNavigatorWrap<T,E>

java.lang.Object

ome.services.query.HierarchyNavigator

ome.services.query.HierarchyNavigatorWrap<T,E>

public abstract class HierarchyNavigatorWrap<T,E>
extends HierarchyNavigator

Convenience class for creating versions of HierarchyNavigator with different model object representations.

Since:

5.0

Author:

m.t.b.carroll@dundee.ac.uk

Field Summary

Fields inherited from class ome.services.query.HierarchyNavigator

iQuery

Constructor Summary

Constructors

Constructor and Description
HierarchyNavigatorWrap(IQuery iQuery)

Method Summary

Modifier and Type	Method and Description
com.google.common.collect.ImmutableSet<E>	doLookup(T toType, E from) Look up which objects of a given type relate to the given query object.
protected abstract Map.Entry<String,Long>	entityToStringLong(E entity) Convert a model object to the type string and database ID expected by HierarchyNavigator.
void	prepareLookups(T toType, Collection<E> from) Batch bulk database queries to prime the cache for doLookup(Object, Object).
protected abstract E	stringLongToEntity(String typeName, long id) Convert the given type string and database ID to the model object.
protected abstract T	stringToType(String typeName) Convert the given type string to the object type.
protected abstract String	typeToString(T type) Convert the given object type to the type strings expected by HierarchyNavigator.

Methods inherited from class ome.services.query.HierarchyNavigator

doLookup, prepareLookups

Methods inherited from class java.lang.Object

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

Constructor Detail

HierarchyNavigatorWrap

public HierarchyNavigatorWrap(IQuery iQuery)

Method Detail

typeToString

protected abstract String typeToString(T type)

Convert the given object type to the type strings expected by HierarchyNavigator.

Parameters:

type - an object type

Returns:

the corresponding type string

stringToType

protected abstract T stringToType(String typeName)

Convert the given type string to the object type.

Parameters:

typeName - a type string

Returns:

the corresponding object type

entityToStringLong

protected abstract Map.Entry<String,Long> entityToStringLong(E entity)

Convert a model object to the type string and database ID expected by HierarchyNavigator.

Parameters:

entity - a model object

Returns:

the corresponding type string and database ID

stringLongToEntity

protected abstract E stringLongToEntity(String typeName,
                                        long id)

Convert the given type string and database ID to the model object.

Parameters:

typeName - a type string

id - a database ID

Returns:

the corresponding model object

prepareLookups

public void prepareLookups(T toType,
                           Collection<E> from)

Batch bulk database queries to prime the cache for doLookup(Object, Object). It is not necessary to call this method, but it is advised if many lookups are anticipated. Wraps HierarchyNavigator.prepareLookups(String, String, Collection).

Parameters:

toType - the type of the objects to which the query objects may be related, not null

from - the query objects, none null, may be of differing types

doLookup

public com.google.common.collect.ImmutableSet<E> doLookup(T toType,
                                                          E from)

Look up which objects of a given type relate to the given query object. Caches results, and one may bulk-cache results in advance using prepareLookups(Object, Collection). Wraps HierarchyNavigator.doLookup(String, String, Long).

Parameters:

toType - the type of the objects to which the query object may be related, not null

from - the query object, not null

Returns:

the related objects, never null