com.exalead.papi.helper.pipe.buffered

Class BufferedPushAPI.TOperationBuffer

java.lang.Object

com.exalead.papi.helper.pipe.buffered.BufferedPushAPI.TOperationBuffer

Enclosing class:

BufferedPushAPI

protected class BufferedPushAPI.TOperationBuffer
extends java.lang.Object

Class aimed to buffer all operations (add,update..) in a given thread. Note: public functions are synchronized to ensure proper cache flush semantics.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	BufferedPushAPI.TOperationBuffer.NeedFlushException Exception throws when a flush operation is required.

Field Summary

Fields

Modifier and Type	Field and Description
protected BufferedPushAPI.TBuffer	add addDocument buffer
protected BufferedPushAPI.TBuffer	del deleteDocument buffer
protected static int	FIRST_FLUSH
protected int[]	flush Flags describing which operations has to be flushed according to the NEED_FLUSH_* flags.
static int	NEED_FLUSH_ADD A flush of the add buffer is required.
static int	NEED_FLUSH_ALL All flush flags are set.
static int	NEED_FLUSH_DEL A flush of the del is required.
static int	NEED_FLUSH_NONE No flush is required.
static int	NEED_FLUSH_UPDATE A flush of the update buffer is required.
static int	NEED_FLUSH_UPDATE_METAS A flush of the add update metas is required.
protected static int	SECOND_FLUSH
protected BufferedPushAPI.TBuffer	update updateDocument buffer
protected BufferedPushAPI.TBuffer	updateMetas updateDocumentMetas buffer

Constructor Summary

Constructors

Constructor and Description
TOperationBuffer(int size, long maxBytes) Constructor

Method Summary

Modifier and Type	Method and Description
void	addDocument(PushAPI parent, Document document) Push an add document operation and, if flush operation buffers that need to be flushed.
void	deleteDocument(PushAPI parent, java.lang.String uri) Push a delete operation and, if flush operation buffers that need to be flushed.
protected void	executeFlushOperation(PushAPI parent) Execute flush operations currently required.
void	flush(PushAPI parent) Flush all operations.
protected int	getOperationsToFlush(java.lang.String uri, int exclude) Given an URI, return the mask describing all operations buffers which already has this URL recorded.
protected void	pushAddDocument(Document document) Push an add document operation
protected void	pushAny(int operation, java.lang.String uri, boolean full) Push an add document operation
protected void	pushDeleteDocument(java.lang.String uri) Push a delete document operation
protected void	pushUpdateDocument(Document document, java.lang.String[] fields) Push an update document operation
protected void	pushUpdateDocumentMetas(java.lang.String uri, java.lang.String stamp, MetaContainer metaContainer) Push an update metas document operation
protected void	throwIfFlushNeeded() Throws NeedFlushException if a flush is needed
void	updateDocument(PushAPI parent, Document doc, java.lang.String[] fields) Push an update document operation and, if flush operation buffers that need to be flushed.
void	updateDocumentMetas(PushAPI parent, java.lang.String uri, java.lang.String stamp, MetaContainer metaContainer) Push an add update metas operation and, if flush operation buffers that need to be flushed.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

flush

protected int[] flush

Flags describing which operations has to be flushed according to the NEED_FLUSH_* flags. The operations described in "flush[FIRST_FLUSH]" are first flushed, and then operations in "flush[SECOND_FLUSH]".

NEED_FLUSH_NONE

public static final int NEED_FLUSH_NONE

No flush is required.

See Also:

Constant Field Values

NEED_FLUSH_ADD

public static final int NEED_FLUSH_ADD

A flush of the add buffer is required.

See Also:

Constant Field Values

NEED_FLUSH_DEL

public static final int NEED_FLUSH_DEL

A flush of the del is required.

See Also:

Constant Field Values

NEED_FLUSH_UPDATE

public static final int NEED_FLUSH_UPDATE

A flush of the update buffer is required.

See Also:

Constant Field Values

NEED_FLUSH_UPDATE_METAS

public static final int NEED_FLUSH_UPDATE_METAS

A flush of the add update metas is required.

See Also:

Constant Field Values

NEED_FLUSH_ALL

public static final int NEED_FLUSH_ALL

All flush flags are set.

See Also:

Constant Field Values

add

protected final BufferedPushAPI.TBuffer add

addDocument buffer

del

protected final BufferedPushAPI.TBuffer del

deleteDocument buffer

update

protected final BufferedPushAPI.TBuffer update

updateDocument buffer

updateMetas

protected final BufferedPushAPI.TBuffer updateMetas

updateDocumentMetas buffer

FIRST_FLUSH

protected static final int FIRST_FLUSH

See Also:

Constant Field Values

SECOND_FLUSH

protected static final int SECOND_FLUSH

See Also:

Constant Field Values

Constructor Detail

TOperationBuffer

public TOperationBuffer(int size,
                        long maxBytes)

Constructor

Method Detail

getOperationsToFlush

protected int getOperationsToFlush(java.lang.String uri,
                                   int exclude)

Given an URI, return the mask describing all operations buffers which already has this URL recorded.

Parameters:

uri - the URI to lookup in all operation buffers

mask - of operation buffers to be excluded from the lookup

throwIfFlushNeeded

protected void throwIfFlushNeeded()
                           throws BufferedPushAPI.TOperationBuffer.NeedFlushException

Throws NeedFlushException if a flush is needed

Throws:

BufferedPushAPI.TOperationBuffer.NeedFlushException

pushAny

protected void pushAny(int operation,
                       java.lang.String uri,
                       boolean full)
                throws BufferedPushAPI.TOperationBuffer.NeedFlushException

Push an add document operation

Throws:

BufferedPushAPI.TOperationBuffer.NeedFlushException

pushAddDocument

protected void pushAddDocument(Document document)
                        throws BufferedPushAPI.TOperationBuffer.NeedFlushException

Push an add document operation

Throws:

BufferedPushAPI.TOperationBuffer.NeedFlushException

pushUpdateDocument

protected void pushUpdateDocument(Document document,
                                  java.lang.String[] fields)
                           throws BufferedPushAPI.TOperationBuffer.NeedFlushException

Push an update document operation

Throws:

BufferedPushAPI.TOperationBuffer.NeedFlushException

pushUpdateDocumentMetas

protected void pushUpdateDocumentMetas(java.lang.String uri,
                                       java.lang.String stamp,
                                       MetaContainer metaContainer)
                                throws BufferedPushAPI.TOperationBuffer.NeedFlushException

Push an update metas document operation

Throws:

BufferedPushAPI.TOperationBuffer.NeedFlushException

pushDeleteDocument

protected void pushDeleteDocument(java.lang.String uri)
                           throws BufferedPushAPI.TOperationBuffer.NeedFlushException

Push a delete document operation

Throws:

BufferedPushAPI.TOperationBuffer.NeedFlushException

executeFlushOperation

protected void executeFlushOperation(PushAPI parent)
                              throws PushAPIException

Execute flush operations currently required. NOOP if no flush operations is necessary.

Throws:

PushAPIException

addDocument

public void addDocument(PushAPI parent,
                        Document document)
                 throws PushAPIException

Push an add document operation and, if flush operation buffers that need to be flushed.

Throws:

PushAPIException

updateDocument

public void updateDocument(PushAPI parent,
                           Document doc,
                           java.lang.String[] fields)
                    throws PushAPIException

Push an update document operation and, if flush operation buffers that need to be flushed.

Throws:

PushAPIException

updateDocumentMetas

public void updateDocumentMetas(PushAPI parent,
                                java.lang.String uri,
                                java.lang.String stamp,
                                MetaContainer metaContainer)
                         throws PushAPIException

Push an add update metas operation and, if flush operation buffers that need to be flushed.

Throws:

PushAPIException

deleteDocument

public void deleteDocument(PushAPI parent,
                           java.lang.String uri)
                    throws PushAPIException

Push a delete operation and, if flush operation buffers that need to be flushed.

Throws:

PushAPIException

flush

public void flush(PushAPI parent)
           throws PushAPIException

Flush all operations.

Throws:

PushAPIException