org.nuxeo.elasticsearch.commands

Class IndexingCommand

java.lang.Object

org.nuxeo.elasticsearch.commands.IndexingCommand

All Implemented Interfaces:

Serializable

public class IndexingCommand
extends Object
implements Serializable

Holds information about what type of indexing operation must be processed. IndexingCommands are create "on the fly" via a Synchronous event listener and at post commit time the system will merge the commands and execute worker to process them.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IndexingCommand.Type

Field Summary

Fields

Modifier and Type	Field and Description
static String	PREFIX

Constructor Summary

Constructors

Constructor and Description
IndexingCommand(DocumentModel document, IndexingCommand.Type commandType, boolean sync, boolean recurse) Create an indexing command

Method Summary

Methods

Modifier and Type	Method and Description
void	addSchemas(String schema)
void	attach(CoreSession session)
IndexingCommand	clone(DocumentModel newDoc)
static IndexingCommand	fromJSON(org.codehaus.jackson.JsonNode jsonNode)
static IndexingCommand	fromJSON(String json) Create a command from a JSON string.
String	getId()
String	getRepositoryName()
String[]	getSchemas()
String	getSignature() Return a command signature used for deduplication
DocumentModel	getTargetDocument() Return the document or null if it does not exists anymore.
String	getTargetDocumentId()
IndexingCommand.Type	getType()
boolean	isRecurse()
boolean	isSync()
void	makeSync() Try to make the command synchronous.
boolean	merge(IndexingCommand other)
String	toJSON()
void	toJSON(org.codehaus.jackson.JsonGenerator jsonGen)
String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

PREFIX

public static final String PREFIX

See Also:

Constant Field Values

Constructor Detail

IndexingCommand

public IndexingCommand(DocumentModel document,
               IndexingCommand.Type commandType,
               boolean sync,
               boolean recurse)

Create an indexing command

Parameters:

document - the target document

commandType - the type of command

sync - if true the command will be processed on the same thread after transaction completion and the Elasticsearch index will be refresh

recurse - the command affect the document and all its descendants

Method Detail

attach

public void attach(CoreSession session)

getTargetDocument

public DocumentModel getTargetDocument()

Return the document or null if it does not exists anymore.

Throws:

IllegalStateException - if there is no session attached

ClientException - if the document can not be loaded

getRepositoryName

public String getRepositoryName()

merge

public boolean merge(IndexingCommand other)

Returns:

true if merged

isSync

public boolean isSync()

isRecurse

public boolean isRecurse()

getType

public IndexingCommand.Type getType()

toJSON

public String toJSON()
              throws IOException

Throws:

IOException

toJSON

public void toJSON(org.codehaus.jackson.JsonGenerator jsonGen)
            throws IOException

Throws:

IOException

fromJSON

public static IndexingCommand fromJSON(String json)

Create a command from a JSON string.

Throws:

IllegalArgumentException - if json is invalid or command is invalid

fromJSON

public static IndexingCommand fromJSON(org.codehaus.jackson.JsonNode jsonNode)

getId

public String getId()

getTargetDocumentId

public String getTargetDocumentId()

clone

public IndexingCommand clone(DocumentModel newDoc)

getSchemas

public String[] getSchemas()

addSchemas

public void addSchemas(String schema)

toString

public String toString()

Overrides:

toString in class Object

makeSync

public void makeSync()

Try to make the command synchronous. Recurse command will stay in async for update.

getSignature

public String getSignature()

Return a command signature used for deduplication