com.orientechnologies.orient.core.query.live

Class OLiveQueryHook

java.lang.Object

com.orientechnologies.orient.core.hook.ODocumentHookAbstract

com.orientechnologies.orient.core.query.live.OLiveQueryHook

All Implemented Interfaces:

ODatabaseListener, ORecordHook, ORecordHook.Scoped

public class OLiveQueryHook
extends ODocumentHookAbstract
implements ORecordHook.Scoped, ODatabaseListener

Created by luigidellaquila on 16/03/15.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OLiveQueryHook.OLiveQueryOps

Nested classes/interfaces inherited from interface com.orientechnologies.orient.core.hook.ORecordHook

ORecordHook.DISTRIBUTED_EXECUTION_MODE, ORecordHook.HOOK_POSITION, ORecordHook.RESULT, ORecordHook.SCOPE, ORecordHook.Scoped, ORecordHook.TYPE

Field Summary

Fields inherited from class com.orientechnologies.orient.core.hook.ODocumentHookAbstract

database

Constructor Summary

Constructors

Constructor and Description
OLiveQueryHook(ODatabaseDocumentInternal db)

Method Summary

Modifier and Type	Method and Description
protected void	addOp(ODocument iDocument, byte iType)
ORecordHook.DISTRIBUTED_EXECUTION_MODE	getDistributedExecutionMode()
static OLiveQueryHook.OLiveQueryOps	getOpsReference(ODatabaseInternal db)
ORecordHook.SCOPE[]	getScopes() Returns the array of scopes this hook interested in.
void	onAfterCommand(OCommandRequestText iCommand, OCommandExecutor executor, Object result)
void	onAfterTxCommit(ODatabase iDatabase)
void	onAfterTxRollback(ODatabase iDatabase)
void	onBeforeCommand(OCommandRequestText iCommand, OCommandExecutor executor)
void	onBeforeTxBegin(ODatabase iDatabase)
void	onBeforeTxCommit(ODatabase iDatabase)
void	onBeforeTxRollback(ODatabase iDatabase)
void	onClose(ODatabase iDatabase)
boolean	onCorruptionRepairDatabase(ODatabase iDatabase, String iReason, String iWhatWillbeFixed) Callback to decide if repair the database upon corruption.
void	onCreate(ODatabase iDatabase)
void	onDelete(ODatabase iDatabase)
void	onOpen(ODatabase iDatabase)
void	onRecordAfterCreate(ODocument iDocument) It's called just after the document is created.
void	onRecordAfterUpdate(ODocument iDocument) It's called just after the document is updated.
ORecordHook.RESULT	onRecordBeforeDelete(ODocument iDocument) It's called just before to delete the document.
static Integer	subscribe(Integer token, OLiveQueryListener iListener, ODatabaseInternal db)
static void	unsubscribe(Integer id, ODatabaseInternal db)

Methods inherited from class com.orientechnologies.orient.core.hook.ODocumentHookAbstract

filterBySchemaClass, getExcludeClasses, getIncludeClasses, onRecordAfterDelete, onRecordAfterRead, onRecordBeforeCreate, onRecordBeforeRead, onRecordBeforeUpdate, onRecordCreateFailed, onRecordCreateReplicated, onRecordDeleteFailed, onRecordDeleteReplicated, onRecordFinalizeCreation, onRecordFinalizeDeletion, onRecordFinalizeUpdate, onRecordReadFailed, onRecordReadReplicated, onRecordUpdateFailed, onRecordUpdateReplicated, onTrigger, onUnregister, setExcludeClasses, setIncludeClasses

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.orientechnologies.orient.core.hook.ORecordHook

onTrigger, onUnregister

Constructor Detail

OLiveQueryHook

public OLiveQueryHook(ODatabaseDocumentInternal db)

Method Detail

getScopes

public ORecordHook.SCOPE[] getScopes()

Description copied from interface: ORecordHook.Scoped

Returns the array of scopes this hook interested in. By default, all available scopes are returned, implement/override this method to limit the scopes this hook may participate to lower the number of useless invocations of this hook.

Limiting the hook to proper scopes may give huge performance boost, especially if the hook ORecordHook.onTrigger(TYPE, ORecord) dispatcher implementation is heavy. In extreme cases, you may override the ORecordHook.onTrigger(TYPE, ORecord) to act directly on event ORecordHook.TYPE and exit early, scopes are just a more handy alternative to this.

Specified by:

getScopes in interface ORecordHook.Scoped

Returns:

the scopes of this hook.

See Also:

ORecordHook.SCOPE

getOpsReference

public static OLiveQueryHook.OLiveQueryOps getOpsReference(ODatabaseInternal db)

subscribe

public static Integer subscribe(Integer token,
                                OLiveQueryListener iListener,
                                ODatabaseInternal db)

unsubscribe

public static void unsubscribe(Integer id,
                               ODatabaseInternal db)

onCreate

public void onCreate(ODatabase iDatabase)

Specified by:

onCreate in interface ODatabaseListener

onDelete

public void onDelete(ODatabase iDatabase)

Specified by:

onDelete in interface ODatabaseListener

onOpen

public void onOpen(ODatabase iDatabase)

Specified by:

onOpen in interface ODatabaseListener

onBeforeTxBegin

public void onBeforeTxBegin(ODatabase iDatabase)

Specified by:

onBeforeTxBegin in interface ODatabaseListener

onBeforeTxRollback

public void onBeforeTxRollback(ODatabase iDatabase)

Specified by:

onBeforeTxRollback in interface ODatabaseListener

onAfterTxRollback

public void onAfterTxRollback(ODatabase iDatabase)

Specified by:

onAfterTxRollback in interface ODatabaseListener

onBeforeTxCommit

public void onBeforeTxCommit(ODatabase iDatabase)

Specified by:

onBeforeTxCommit in interface ODatabaseListener

onAfterTxCommit

public void onAfterTxCommit(ODatabase iDatabase)

Specified by:

onAfterTxCommit in interface ODatabaseListener

onClose

public void onClose(ODatabase iDatabase)

Specified by:

onClose in interface ODatabaseListener

onBeforeCommand

public void onBeforeCommand(OCommandRequestText iCommand,
                            OCommandExecutor executor)

Specified by:

onBeforeCommand in interface ODatabaseListener

onAfterCommand

public void onAfterCommand(OCommandRequestText iCommand,
                           OCommandExecutor executor,
                           Object result)

Specified by:

onAfterCommand in interface ODatabaseListener

onRecordAfterCreate

public void onRecordAfterCreate(ODocument iDocument)

Description copied from class: ODocumentHookAbstract

It's called just after the document is created.

Overrides:

onRecordAfterCreate in class ODocumentHookAbstract

Parameters:

iDocument - The document is going to be created

onRecordAfterUpdate

public void onRecordAfterUpdate(ODocument iDocument)

Description copied from class: ODocumentHookAbstract

It's called just after the document is updated.

Overrides:

onRecordAfterUpdate in class ODocumentHookAbstract

Parameters:

iDocument - The document just updated

onRecordBeforeDelete

public ORecordHook.RESULT onRecordBeforeDelete(ODocument iDocument)

Description copied from class: ODocumentHookAbstract

It's called just before to delete the document.

Overrides:

onRecordBeforeDelete in class ODocumentHookAbstract

Parameters:

iDocument - The document to delete

Returns:

True if the document has been modified and a new marshalling is required, otherwise false

addOp

protected void addOp(ODocument iDocument,
                     byte iType)

onCorruptionRepairDatabase

public boolean onCorruptionRepairDatabase(ODatabase iDatabase,
                                          String iReason,
                                          String iWhatWillbeFixed)

Description copied from interface: ODatabaseListener

Callback to decide if repair the database upon corruption.

Specified by:

onCorruptionRepairDatabase in interface ODatabaseListener

Parameters:

iDatabase - Target database

iReason - Reason of corruption

iWhatWillbeFixed - TODO

Returns:

true if repair must be done, otherwise false

getDistributedExecutionMode

public ORecordHook.DISTRIBUTED_EXECUTION_MODE getDistributedExecutionMode()

Specified by:

getDistributedExecutionMode in interface ORecordHook