ome.services.graphs

Enum GraphOpts.Op

java.lang.Object

java.lang.Enum<GraphOpts.Op>

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

Enum Constants

Enum Constant and Description
FORCE Permits the use of force to remove objects even against the permission system.
HARD Default operation.
KEEP Prevents the action from being carried out.
NULL Nulls a particular field of the target rather than performing the standard action on it.
ORPHAN
REAP If more than one step points at the same REAP then only the last one will be interpreted as HARD, all others will be interpreted as SOFT.
SOFT Graph is attempted, but the exceptions which would make a HARD operation fail lead only to warnings.

Method Summary

Modifier and Type	Method and Description
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 an action 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 action from being carried out. If an entry has a subspec, then the entire subgraph will not be processed. In some cases, specifically when traversing the annotations graph, this value may be vetoed and the annotations will be kept.

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

If more than one step points at the same REAP then only the last one will be interpreted as HARD, all others will be interpreted as SOFT. This gives earlier objects in the graph a chance to let later objects cleanup for them.

ORPHAN

public static final GraphOpts.Op ORPHAN

NULL

public static final GraphOpts.Op NULL

Nulls a particular field of the target rather than performing the standard action on 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