Package org.sakaiproject.search.elasticsearch

Enum BaseElasticSearchIndexBuilder.IndexAction

java.lang.Object

java.lang.Enum<BaseElasticSearchIndexBuilder.IndexAction>

org.sakaiproject.search.elasticsearch.BaseElasticSearchIndexBuilder.IndexAction

All Implemented Interfaces:

Serializable, Comparable<BaseElasticSearchIndexBuilder.IndexAction>

Enclosing class:

BaseElasticSearchIndexBuilder

public static enum BaseElasticSearchIndexBuilder.IndexAction
extends Enum<BaseElasticSearchIndexBuilder.IndexAction>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ADD	Action ADD the record to the search engine, if the doc ID is set, then remove first, if not set, check its not there.
DELETE	Action DELETE the record from the search engine, once complete delete the record
REBUILD	The action REBUILD causes the indexer thread to rebuild the index from scratch, re-fetching all entities This should only ever appear on the master record
REFRESH	The action REFRESH causes the indexer thread to refresh the search index from the current set of entities.
UNKNOWN	Action Unknown, usually because the record has just been created

Method Summary

Modifier and Type	Method	Description
static BaseElasticSearchIndexBuilder.IndexAction	getAction(int itemActionId)	Generate an IndexAction based on an action ID provided by the Search API
int	getItemAction()
static BaseElasticSearchIndexBuilder.IndexAction	valueOf(String name)	Returns the enum constant of this type with the specified name.
static BaseElasticSearchIndexBuilder.IndexAction[]	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

UNKNOWN

public static final BaseElasticSearchIndexBuilder.IndexAction UNKNOWN

Action Unknown, usually because the record has just been created

ADD

public static final BaseElasticSearchIndexBuilder.IndexAction ADD

Action ADD the record to the search engine, if the doc ID is set, then remove first, if not set, check its not there.

DELETE

public static final BaseElasticSearchIndexBuilder.IndexAction DELETE

Action DELETE the record from the search engine, once complete delete the record

REBUILD

public static final BaseElasticSearchIndexBuilder.IndexAction REBUILD

The action REBUILD causes the indexer thread to rebuild the index from scratch, re-fetching all entities This should only ever appear on the master record

REFRESH

public static final BaseElasticSearchIndexBuilder.IndexAction REFRESH

The action REFRESH causes the indexer thread to refresh the search index from the current set of entities. If a Rebuild is in progress, the refresh will not override the rebuild

Method Detail

values

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

Returns:

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

valueOf

public static BaseElasticSearchIndexBuilder.IndexAction 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

getAction

public static BaseElasticSearchIndexBuilder.IndexAction getAction(int itemActionId)

Generate an IndexAction based on an action ID provided by the Search API

Parameters:

itemActionId - action ID used by the Search API

Returns:

IndexAction matching the given ID, null if nothing has been found

getItemAction

public int getItemAction()