TransformationDirective (EXALEAD CloudView Custom code SDK)

java.lang.Object
- java.lang.Enum<TransformationDirective>
- - com.exalead.cloudview.consolidationapi.TransformationDirective

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<TransformationDirective>
```
public enum TransformationDirective
extends java.lang.Enum<TransformationDirective>
```
List of CloudView PushAPI Document custom directive processed by the consolidation server. Given a document, its directives are processed in the very order they are declared below. This is why declaration order is critical: deletions MUST be handled first.

Enum Constant Summary

Enum Constants
Enum Constant and Description
`CLEAR_PREDECESSORS_META` Removes relationships arriving to the document.
`CLEAR_SUCCESSORS_META` Removes the relationships leaving the document.
`DOCUMENT_CREATE` Adds the document to the object graph store.
`DOCUMENT_DELETE` Deletion the specified document, optionally all of its children.
`DOCUMENT_DELETE_ROOT_PATH` Deletes a set of documents corresponding to a URI prefix.
`DOCUMENT_IS_MANAGED` Register the current document as managed, which means that if at the end of the transformation phase no arcs point on it, it will be automatically destroyed by the consolidation server.
`INCOMING_ARC_ADDITION` Adds an incoming arc for a given root document, incoming from a given target document.
`INCOMING_ARC_DELETION` Deletes an incoming arc for a given root document, incoming from a given target document.
`INCOMING_ARCS_DELETION` Deletes ALL incoming arcs for a given root document.
`OUTGOING_ARC_ADDITION` Adds an outgoing arc for a given root document, outgoing to a target document.
`OUTGOING_ARC_DELETION` Deletes an outgoing arc for a given root document, outgoing to a target document.
`OUTGOING_ARCS_DELETION` Deletes ALL outgoing arcs for a given root document.
`PREDECESSORS_ADDITION_META` Adds an incoming arc starting from a source document and arriving to the current document.
`PREDECESSORS_DELETION_META` Delete the relationship between the source document and the current document.
`SUCCESSORS_ADDITION_META` Adds an outgoing arc between the current document and a target document.
`SUCCESSORS_DELETION_META` Deletes the relationship between the current document and a target document.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getId()`
`static TransformationDirective`	`valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
`static TransformationDirective[]`	`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
  - DOCUMENT_IS_MANAGED
```
public static final TransformationDirective DOCUMENT_IS_MANAGED
```
    Register the current document as managed, which means that if at the end of the transformation phase no arcs point on it, it will be automatically destroyed by the consolidation server.
  - DOCUMENT_DELETE
```
public static final TransformationDirective DOCUMENT_DELETE
```
    Deletion the specified document, optionally all of its children.
  - DOCUMENT_DELETE_ROOT_PATH
```
public static final TransformationDirective DOCUMENT_DELETE_ROOT_PATH
```
    Deletes a set of documents corresponding to a URI prefix. All the documents matching the URI prefix will be deleted.
  - SUCCESSORS_DELETION_META
```
public static final TransformationDirective SUCCESSORS_DELETION_META
```
    Deletes the relationship between the current document and a target document.
  - PREDECESSORS_DELETION_META
```
public static final TransformationDirective PREDECESSORS_DELETION_META
```
    Delete the relationship between the source document and the current document.
  - OUTGOING_ARC_DELETION
```
public static final TransformationDirective OUTGOING_ARC_DELETION
```
    Deletes an outgoing arc for a given root document, outgoing to a target document.
  - INCOMING_ARC_DELETION
```
public static final TransformationDirective INCOMING_ARC_DELETION
```
    Deletes an incoming arc for a given root document, incoming from a given target document.
  - OUTGOING_ARCS_DELETION
```
public static final TransformationDirective OUTGOING_ARCS_DELETION
```
    Deletes ALL outgoing arcs for a given root document.
  - INCOMING_ARCS_DELETION
```
public static final TransformationDirective INCOMING_ARCS_DELETION
```
    Deletes ALL incoming arcs for a given root document.
  - CLEAR_SUCCESSORS_META
```
public static final TransformationDirective CLEAR_SUCCESSORS_META
```
    Removes the relationships leaving the document.
  - CLEAR_PREDECESSORS_META
```
public static final TransformationDirective CLEAR_PREDECESSORS_META
```
    Removes relationships arriving to the document.
  - DOCUMENT_CREATE
```
public static final TransformationDirective DOCUMENT_CREATE
```
    Adds the document to the object graph store.
  - SUCCESSORS_ADDITION_META
```
public static final TransformationDirective SUCCESSORS_ADDITION_META
```
    Adds an outgoing arc between the current document and a target document.
  - PREDECESSORS_ADDITION_META
```
public static final TransformationDirective PREDECESSORS_ADDITION_META
```
    Adds an incoming arc starting from a source document and arriving to the current document.
  - OUTGOING_ARC_ADDITION
```
public static final TransformationDirective OUTGOING_ARC_ADDITION
```
    Adds an outgoing arc for a given root document, outgoing to a target document.
  - INCOMING_ARC_ADDITION
```
public static final TransformationDirective INCOMING_ARC_ADDITION
```
    Adds an incoming arc for a given root document, incoming from a given target document.
- Method Detail
  - values
```
public static TransformationDirective[] 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 (TransformationDirective c : TransformationDirective.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static TransformationDirective valueOf(java.lang.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:
    
    java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
    
    java.lang.NullPointerException - if the argument is null
  - getId
```
public java.lang.String getId()
```

Enum TransformationDirective

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

DOCUMENT_IS_MANAGED

DOCUMENT_DELETE

DOCUMENT_DELETE_ROOT_PATH

SUCCESSORS_DELETION_META

PREDECESSORS_DELETION_META

OUTGOING_ARC_DELETION

INCOMING_ARC_DELETION

OUTGOING_ARCS_DELETION

INCOMING_ARCS_DELETION

CLEAR_SUCCESSORS_META

CLEAR_PREDECESSORS_META

DOCUMENT_CREATE

SUCCESSORS_ADDITION_META

PREDECESSORS_ADDITION_META

OUTGOING_ARC_ADDITION

INCOMING_ARC_ADDITION

Method Detail

values

valueOf

getId