at.molindo.esi4j.chain

Interface Esi4JEntityTask

All Superinterfaces:

Cloneable, Serializable

All Known Implementing Classes:

AbstractEntityTask, DeleteEntityTask, IndexEntityTask, UpdateEntityTask

public interface Esi4JEntityTask
extends Serializable, Cloneable

A task is a single operation (index, update, delete) on a single entity to be processed by an Esi4JTaskProcessor. A task needs to be Serializable after replaceEntity(Esi4JEntityResolver) was called.

Method Summary

Methods

Modifier and Type	Method and Description
void	addToBulk(org.elasticsearch.client.Client client, org.elasticsearch.action.bulk.BulkRequestBuilder bulk, String indexName, Esi4JOperation.OperationContext context) add necessary index operation to bulk request
Esi4JEntityTask	clone()
boolean	isUpdate()
void	replaceEntity(Esi4JEntityResolver entityResolver) optional, might be implemented as noop
void	resolveEntity(Esi4JEntityResolver entityResolver) optional, might be implemented as noop if replaceEntity(Esi4JEntityResolver) is a noop or entity is a ObjectKey
ObjectKey	toObjectKey(Esi4JEntityResolver entityResolver) returns the entities ObjectKey

Method Detail

isUpdate

boolean isUpdate()

Returns:

true if this updates an existing state, false if it overwrites the previous state

replaceEntity

void replaceEntity(Esi4JEntityResolver entityResolver)

optional, might be implemented as noop

resolveEntity

void resolveEntity(Esi4JEntityResolver entityResolver)
                   throws EntityNotResolveableException

optional, might be implemented as noop if replaceEntity(Esi4JEntityResolver) is a noop or entity is a ObjectKey

Throws:

EntityNotResolveableException

toObjectKey

ObjectKey toObjectKey(Esi4JEntityResolver entityResolver)

returns the entities ObjectKey

addToBulk

void addToBulk(org.elasticsearch.client.Client client,
             org.elasticsearch.action.bulk.BulkRequestBuilder bulk,
             String indexName,
             Esi4JOperation.OperationContext context)

add necessary index operation to bulk request

clone

Esi4JEntityTask clone()

Returns:

a clone of this task