ome.services.graphs
Enum GraphOpts.Op

java.lang.Object
  extended by java.lang.Enum<GraphOpts.Op>
      extended by ome.services.graphs.GraphOpts.Op
All Implemented Interfaces:
Serializable, Comparable<GraphOpts.Op>
Enclosing class:
GraphOpts

public static enum GraphOpts.Op
extends Enum<GraphOpts.Op>


Enum Constant Summary
FORCE
          Permits the use of force to remove objects even against the permission system.
HARD
          Default operation.
KEEP
          Prevents the delete from being carried out.
NULL
          Nulls a particular field of the target rather than deleting it.
ORPHAN
           
REAP
           
SOFT
          Graph is attempted, but the exceptions which would make a HARD operation fail lead only to warnings.
 
Method Summary
static GraphOpts.Op valueOf(String name)
          Returns the enum constant of this type with the specified name.
static GraphOpts.Op[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
 
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

HARD

public static final GraphOpts.Op HARD
Default operation. If a delete is not possible, i.e. it fails with a ConstraintViolationException or similar, then the failure will cause the entire command to fail as an error.


SOFT

public static final GraphOpts.Op SOFT
Graph is attempted, but the exceptions which would make a HARD operation fail lead only to warnings.


KEEP

public static final GraphOpts.Op KEEP
Prevents the delete from being carried out. If an entry has a subspec, then the entire subgraph will not be deleted. In some cases, specifically AnnotationGraphSpec this value may be vetoed by GraphSpec.overrideKeep().


FORCE

public static final GraphOpts.Op FORCE
Permits the use of force to remove objects even against the permission system. (This option cannot override low-level DB constraints)


REAP

public static final GraphOpts.Op REAP

ORPHAN

public static final GraphOpts.Op ORPHAN

NULL

public static final GraphOpts.Op NULL
Nulls a particular field of the target rather than deleting it. This is useful for situations where one user has generated data from another user, as with projections. WARNING:Currently, NULL can only be used for the Pixels.relatedTo relationship.

Method Detail

values

public static GraphOpts.Op[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
for (GraphOpts.Op c : GraphOpts.Op.values())
    System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they are declared

valueOf

public static GraphOpts.Op valueOf(String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:
name - the name of the enum constant to be returned.
Returns:
the enum constant with the specified name
Throws:
IllegalArgumentException - if this enum type has no constant with the specified name
NullPointerException - if the argument is null


OmeroJava Api

Version: 4.3.3-00d1137e-b2894

Copyright © 2009 The University of Dundee. All Rights Reserved.