omero.cmd.graphs

Class NullGraphTraversalProcessor

java.lang.Object

omero.cmd.graphs.NullGraphTraversalProcessor

All Implemented Interfaces:

GraphTraversal.Processor

public class NullGraphTraversalProcessor
extends java.lang.Object
implements GraphTraversal.Processor

A GraphTraversal.Processor that does nothing whatsoever.

Since:

5.1.0

Author:

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

Constructor Summary

Constructors

Constructor and Description
NullGraphTraversalProcessor(java.util.Set<GraphPolicy.Ability> requiredAbilities) Construct a GraphTraversal.Processor that does nothing whatsoever.

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.
java.util.Set<GraphPolicy.Ability>	getRequiredPermissions()
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.
void	processInstances(java.lang.String className, java.util.Collection<java.lang.Long> ids) Process the given instances.

Methods inherited from class java.lang.Object

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

Constructor Detail

NullGraphTraversalProcessor

public NullGraphTraversalProcessor(java.util.Set<GraphPolicy.Ability> requiredAbilities)

Construct a GraphTraversal.Processor that does nothing whatsoever.

Parameters:

requiredAbilities - the GraphPolicy.Ability set to be returned by getRequiredPermissions()

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)

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

processInstances

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

Description copied from interface: GraphTraversal.Processor

Process the given instances. They will have been sufficiently unlinked by the other methods.

Specified by:

processInstances in interface GraphTraversal.Processor

Parameters:

className - full name of mapped Hibernate class

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

getRequiredPermissions

public java.util.Set<GraphPolicy.Ability> getRequiredPermissions()

Specified by:

getRequiredPermissions in interface GraphTraversal.Processor

Returns:

the permissions required for processing instances with GraphTraversal.Processor.processInstances(String, Collection)

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