ome.logic

Class MetadataImpl

java.lang.Object

ome.logic.AbstractLevel2Service

ome.logic.MetadataImpl

All Implemented Interfaces:

IMetadata, ServiceInterface, SelfConfigurableService

public class MetadataImpl
extends AbstractLevel2Service
implements IMetadata

Implement the IMetadata I/F.

Since:

3.0-Beta4

Version:

3.0 (Internal version: $Revision: $Date: $)

Author:

Jean-Marie Burel j.burel@dundee.ac.uk, Donald MacDonald donald@lifesci.dundee.ac.uk

Field Summary

Fields inherited from class ome.logic.AbstractLevel2Service

iQuery, iUpdate, metadata, queryFactory, sec

Fields inherited from interface ome.api.IMetadata

MOVIE_MPEG_NS, MOVIE_QT_NS, MOVIE_WMV_NS, NS_IMPORTER_ARCHIVED, NS_INSIGHT_RATING, NS_INSIGHT_TAG_SET

Constructor Summary

Constructors

Constructor and Description
MetadataImpl()

Method Summary

Methods

Modifier and Type	Method and Description
Long	countAnnotationsUsedNotOwned(Class annotationType, long userID) Implemented as specified by the IMetadata I/F
Long	countSpecifiedAnnotations(Class type, Set<String> include, Set<String> exclude, ome.parameters.Parameters options) Implemented as specified by the IMetadata I/F
Class<? extends ServiceInterface>	getServiceInterface() Returns the Interface implemented by this class.
Map	getTaggedObjectsCount(Set<Long> tagIds, ome.parameters.Parameters options) Implemented as specified by the IMetadata I/F
<A extends ome.model.annotations.Annotation> Set<A>	loadAnnotation(Set<Long> annotationIds) Implemented as specified by the IMetadata I/F
<T extends ome.model.IObject,A extends ome.model.annotations.Annotation> Map<Long,Set<A>>	loadAnnotations(Class<T> rootNodeType, Set<Long> rootNodeIds, Set<String> annotationTypes, Set<Long> annotatorIds, ome.parameters.Parameters options) Implemented as specified by the IMetadata I/F
Set<ome.model.IObject>	loadAnnotationsUsedNotOwned(Class annotationType, long userID) Implemented as specified by the IMetadata I/F
Set	loadChannelAcquisitionData(Set<Long> ids) Implemented as specified by the IMetadata I/F
ome.model.acquisition.Instrument	loadInstrument(long id) Implemented as specified by the IMetadata I/F
Map<Long,Set<ome.model.IObject>>	loadLogFiles(Class<? extends ome.model.IObject> rootNodeType, Set<Long> ids) Find the original file IDs for the import logs corresponding to the given Image or Fileset IDs.
<A extends ome.model.annotations.Annotation> Set<A>	loadSpecifiedAnnotations(Class type, Set<String> include, Set<String> exclude, ome.parameters.Parameters options) Implemented as specified by the IMetadata I/F
<A extends ome.model.annotations.Annotation> Map<Long,Set<A>>	loadSpecifiedAnnotationsLinkedTo(Class type, Set<String> include, Set<String> exclude, Class rootNodeType, Set<Long> rootNodeIds, ome.parameters.Parameters options) Implemented as specified by the IMetadata I/F
Map<Long,Set<ome.model.IObject>>	loadTagContent(Set<Long> tagIds, ome.parameters.Parameters options) Implemented as specified by the IMetadata I/F
Set<ome.model.IObject>	loadTagSets(ome.parameters.Parameters options) Implemented as specified by the IMetadata I/F
void	setIContainer(IContainer iContainer) IContainer bean injector.

Methods inherited from class ome.logic.AbstractLevel2Service

getBeanHelper, getExtendedMetadata, getQueryFactory, getSecuritySystem, selfConfigure, setExtendedMetadata, setQueryFactory, setQueryService, setSecuritySystem, setUpdateService

Methods inherited from class java.lang.Object

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

Constructor Detail

MetadataImpl

public MetadataImpl()

Method Detail

getServiceInterface

public final Class<? extends ServiceInterface> getServiceInterface()

Returns the Interface implemented by this class.

Specified by:

getServiceInterface in interface SelfConfigurableService

Returns:

See above.

setIContainer

public final void setIContainer(IContainer iContainer)

IContainer bean injector. For use during configuration. Can only be called once.

Parameters:

iContainer - The value to set.

loadInstrument

@Transactional(readOnly=true)
public ome.model.acquisition.Instrument loadInstrument(long id)

Implemented as specified by the IMetadata I/F

Specified by:

loadInstrument in interface IMetadata

Parameters:

id - The id of the instrument to load.

Returns:

See above

See Also:

IMetadata#loadInstrument(Long)

loadChannelAcquisitionData

@Transactional(readOnly=true)
public Set loadChannelAcquisitionData(Set<Long> ids)

Implemented as specified by the IMetadata I/F

Specified by:

loadChannelAcquisitionData in interface IMetadata

Parameters:

ids - The collection of logical channel's ids. Mustn't be null.

Returns:

The collection of loaded logical channels.

See Also:

IMetadata.loadChannelAcquisitionData(Set)

loadAnnotations

@Transactional(readOnly=true)
public <T extends ome.model.IObject,A extends ome.model.annotations.Annotation> Map<Long,Set<A>> loadAnnotations(Class<T> rootNodeType,
                                                                                                                      Set<Long> rootNodeIds,
                                                                                                                      Set<String> annotationTypes,
                                                                                                                      Set<Long> annotatorIds,
                                                                                                                      ome.parameters.Parameters options)

Implemented as specified by the IMetadata I/F

Specified by:

loadAnnotations in interface IMetadata

Parameters:

rootNodeType - The type of the nodes the annotations are linked to. Mustn't be null.

rootNodeIds - Ids of the objects of type rootNodeType. Mustn't be null.

annotationTypes - The types of annotation to retrieve. If null all annotations will be loaded. String of the type ome.model.annotations.*.

annotatorIds - Ids of the users for whom annotations should be retrieved. If null, all annotations returned.

Returns:

A map whose key is rootNodeId and value the Set of all annotations for that node or null.

See Also:

IMetadata#loadAnnotations(Class, Set, Set, Set)

loadSpecifiedAnnotations

@Transactional(readOnly=true)
public <A extends ome.model.annotations.Annotation> Set<A> loadSpecifiedAnnotations(Class type,
                                                                                         Set<String> include,
                                                                                         Set<String> exclude,
                                                                                         ome.parameters.Parameters options)

Implemented as specified by the IMetadata I/F

Specified by:

loadSpecifiedAnnotations in interface IMetadata

Parameters:

type - The type of annotations to load.

include - Include the annotations with the specified name spaces.

exclude - Exclude the annotations with the specified name spaces.

options - The POJO options.

Returns:

A collection of found annotations.

See Also:

IMetadata.loadSpecifiedAnnotations(Class, Set, Set, Parameters)

countSpecifiedAnnotations

@Transactional(readOnly=true)
public Long countSpecifiedAnnotations(Class type,
                                           Set<String> include,
                                           Set<String> exclude,
                                           ome.parameters.Parameters options)

Implemented as specified by the IMetadata I/F

Specified by:

countSpecifiedAnnotations in interface IMetadata

Parameters:

type - The type of annotations to load.

include - The collection of name space, one of the constants defined by this class.

exclude - The collection of name space, one of the constants defined by this class.

options - The POJO options.

Returns:

See above.

See Also:

IMetadata.countSpecifiedAnnotations(Class, Set, Set, Parameters)

loadAnnotation

@Transactional(readOnly=true)
public <A extends ome.model.annotations.Annotation> Set<A> loadAnnotation(Set<Long> annotationIds)

Implemented as specified by the IMetadata I/F

Specified by:

loadAnnotation in interface IMetadata

Parameters:

annotationIds - The collection of annotation's ids.

Returns:

See above.

See Also:

IMetadata.loadAnnotation(Set)

loadTagContent

@Transactional(readOnly=true)
public Map<Long,Set<ome.model.IObject>> loadTagContent(Set<Long> tagIds,
                                                            ome.parameters.Parameters options)

Implemented as specified by the IMetadata I/F

Specified by:

loadTagContent in interface IMetadata

Parameters:

tagIds - The id of the tag to load or -1.

options - The POJO options.

Returns:

Map whose key is a Tag/Tag Set and the value either a Map or a list of related DataObject.

See Also:

IMetadata.loadTagContent(Set, Parameters)

loadTagSets

@Transactional(readOnly=true)
public Set<ome.model.IObject> loadTagSets(ome.parameters.Parameters options)

Implemented as specified by the IMetadata I/F

Specified by:

loadTagSets in interface IMetadata

Parameters:

options - The POJO options.

Returns:

See above.

See Also:

IMetadata.loadTagSets(Parameters)

getTaggedObjectsCount

@Transactional(readOnly=true)
public Map getTaggedObjectsCount(Set<Long> tagIds,
                                      ome.parameters.Parameters options)

Implemented as specified by the IMetadata I/F

Specified by:

getTaggedObjectsCount in interface IMetadata

Parameters:

tagIds - The collection of ids.

options - The POJO options.

Returns:

See above.

See Also:

IMetadata#lgetTaggedObjectsCount(Set, Parameters)

loadAnnotationsUsedNotOwned

@Transactional(readOnly=true)
public Set<ome.model.IObject> loadAnnotationsUsedNotOwned(Class annotationType,
                                                               long userID)

Implemented as specified by the IMetadata I/F

Specified by:

loadAnnotationsUsedNotOwned in interface IMetadata

userID - The identifier of the user.

Returns:

See above.

See Also:

IMetadata#loadAnnotationUsedNotOwned(Class, Long)

countAnnotationsUsedNotOwned

@Transactional(readOnly=true)
public Long countAnnotationsUsedNotOwned(Class annotationType,
                                              long userID)

Implemented as specified by the IMetadata I/F

Specified by:

countAnnotationsUsedNotOwned in interface IMetadata

userID - The identifier of the user.

Returns:

See above.

See Also:

IMetadata#countAnnotationsUsedNotOwned(Class, Long)

loadSpecifiedAnnotationsLinkedTo

@Transactional(readOnly=true)
public <A extends ome.model.annotations.Annotation> Map<Long,Set<A>> loadSpecifiedAnnotationsLinkedTo(Class type,
                                                                                                           Set<String> include,
                                                                                                           Set<String> exclude,
                                                                                                           Class rootNodeType,
                                                                                                           Set<Long> rootNodeIds,
                                                                                                           ome.parameters.Parameters options)

Implemented as specified by the IMetadata I/F

Specified by:

loadSpecifiedAnnotationsLinkedTo in interface IMetadata

Parameters:

type - The type of annotations to load.

include - Include the annotations with the specified name spaces.

exclude - Exclude the annotations with the specified name spaces.

rootNodeType - The type of objects the annotations are linked to.

rootNodeIds - The identifiers of the objects.

options - The POJO options.

Returns:

A collection of found annotations.

See Also:

IMetadata.loadSpecifiedAnnotationsLinkedTo(Class, Set, Set, Class, Set, Parameters)

loadLogFiles

@Transactional(readOnly=true)
public Map<Long,Set<ome.model.IObject>> loadLogFiles(Class<? extends ome.model.IObject> rootNodeType,
                                                          Set<Long> ids)

Description copied from interface: IMetadata

Find the original file IDs for the import logs corresponding to the given Image or Fileset IDs.

Specified by:

loadLogFiles in interface IMetadata

Parameters:

rootNodeType - the root node type, may be omero.model.core.Image or omero.model.fs.Fileset

ids - the IDs of the entities for which the import log original file IDs are required

Returns:

the original file IDs of the import logs