omero.cmd.graphs

Class BaseGraphTraversalProcessor

java.lang.Object

omero.cmd.graphs.BaseGraphTraversalProcessor

All Implemented Interfaces:

GraphTraversal.Processor

public abstract class BaseGraphTraversalProcessor
extends java.lang.Object
implements GraphTraversal.Processor

Useful methods for GraphTraversal.Processor instances to share.

Since:

5.1.0

Author:

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

Field Summary

Fields

Modifier and Type	Field and Description
protected org.hibernate.Session	session

Constructor Summary

Constructors

Constructor and Description
BaseGraphTraversalProcessor(org.hibernate.Session session)

Method Summary

Modifier and Type	Method and Description
void	assertMayProcess(java.lang.String className, long id, Details details) Assert that an object with the given details may be processed.
void	deleteInstances(java.lang.String className, java.util.Collection<java.lang.Long> ids) Delete the given instances.
void	nullProperties(java.lang.String className, java.lang.String propertyName, java.util.Collection<java.lang.Long> ids) Null the given property of the indicated instances.

Methods inherited from class java.lang.Object

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

Methods inherited from interface ome.services.graphs.GraphTraversal.Processor

getRequiredPermissions, processInstances

Field Detail

session

protected final org.hibernate.Session session

Constructor Detail

BaseGraphTraversalProcessor

public BaseGraphTraversalProcessor(org.hibernate.Session session)

Method Detail

nullProperties

public void nullProperties(java.lang.String className,
                           java.lang.String propertyName,
                           java.util.Collection<java.lang.Long> ids)

Description copied from interface: GraphTraversal.Processor

Null the given property of the indicated instances.

Specified by:

nullProperties in interface GraphTraversal.Processor

Parameters:

className - full name of mapped Hibernate class

propertyName - HQL-style property name of class

ids - applicable instances of class, no more than GraphTraversal.BATCH_SIZE

deleteInstances

public void deleteInstances(java.lang.String className,
                            java.util.Collection<java.lang.Long> ids)
                     throws GraphException

Description copied from interface: GraphTraversal.Processor

Delete the given instances.

Specified by:

deleteInstances in interface GraphTraversal.Processor

Parameters:

className - full name of mapped Hibernate class

ids - applicable instances of class, no more than GraphTraversal.BATCH_SIZE

Throws:

GraphException - if not all the instances could be deleted

assertMayProcess

public void assertMayProcess(java.lang.String className,
                             long id,
                             Details details)
                      throws GraphException

Description copied from interface: GraphTraversal.Processor

Assert that an object with the given details may be processed. Called only if the user is not an administrator.

Specified by:

assertMayProcess in interface GraphTraversal.Processor

Parameters:

className - the name of the object's class

id - the ID of the object

details - the object's details

Throws:

GraphException - if the object may not be processed