com.attivio.sdk.ingest

Enum DocumentMode

java.lang.Object

java.lang.Enum<DocumentMode>

com.attivio.sdk.ingest.DocumentMode

All Implemented Interfaces:

Serializable, Comparable<DocumentMode>

public enum DocumentMode
extends Enum<DocumentMode>

Contains the possible modes for a document.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ADD Add a document to the index.
CREATE Create a document in the index.
DELETE Delete a document from the index.
PARTIAL Update a document, adding in fields, retaining values for fields not contained in update document.
PARTIAL_APPEND_VALUES Update a document, uniquely appending values to multi-value fields.
PARTIAL_REMOVE_VALUES Update a document, removing matching values from multi-value fields.

Method Summary

Modifier and Type	Method and Description
static DocumentMode	fromExternal(String value) Converts an external value to a DocumentMode value.
static DocumentMode	fromOrdinal(int value)
static DocumentMode	valueOf(String name) Returns the enum constant of this type with the specified name.
static DocumentMode[]	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

ADD

public static final DocumentMode ADD

Add a document to the index. (implies a delete of any existing documents with the same ID prior to adding)

DELETE

public static final DocumentMode DELETE

Delete a document from the index.

PARTIAL

public static final DocumentMode PARTIAL

Update a document, adding in fields, retaining values for fields not contained in update document.

The exact semantics are engine dependent as some may only work on real time fields while others may work on any field in the document.

PARTIAL_APPEND_VALUES

public static final DocumentMode PARTIAL_APPEND_VALUES

Update a document, uniquely appending values to multi-value fields.

NOTE: This operation will only affect multi-value fields. Any updates to single value fields will be ignored.

PARTIAL_REMOVE_VALUES

public static final DocumentMode PARTIAL_REMOVE_VALUES

Update a document, removing matching values from multi-value fields.

Fields in this update act as a blacklist, filtering multi-value fields in the previously indexed document.

NOTE: This operation will only affect multi-value fields. Any updates to single value fields will be ignored.

CREATE

public static final DocumentMode CREATE

Create a document in the index. (does not imply delete of document prior to add)

This document mode should only be used during an initial feed of the index or in situations where the same document will never be feed twice. If the same document is added with this mode twice, the document will occur in the index twice.

Method Detail

values

public static DocumentMode[] 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 (DocumentMode c : DocumentMode.values())
    System.out.println(c);

Returns:

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

valueOf

public static DocumentMode 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

fromExternal

public static DocumentMode fromExternal(String value)

Converts an external value to a DocumentMode value.

Parameters:

value - the external value

Returns:

the type

fromOrdinal

public static DocumentMode fromOrdinal(int value)