com.orientechnologies.orient.core.schedule

Class OSchedulerTrigger

java.lang.Object

com.orientechnologies.orient.core.hook.ODocumentHookAbstract

com.orientechnologies.orient.core.schedule.OSchedulerTrigger

All Implemented Interfaces:

ORecordHook, ORecordHook.Scoped

public class OSchedulerTrigger
extends ODocumentHookAbstract
implements ORecordHook.Scoped

Keeps synchronized the scheduled events in memory.

Since:

Mar 28, 2013

Author:

Luca Garulli, henryzhao81-at-gmail.com

Nested Class Summary

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
OSchedulerTrigger(ODatabaseDocument database)

Method Summary

Modifier and Type	Method and Description
ORecordHook.DISTRIBUTED_EXECUTION_MODE	getDistributedExecutionMode()
ORecordHook.SCOPE[]	getScopes() Returns the array of scopes this hook interested in.
void	onRecordAfterCreate(ODocument iDocument) It's called just after the document is created.
void	onRecordAfterDelete(ODocument iDocument) It's called just after the document is deleted.
ORecordHook.RESULT	onRecordBeforeCreate(ODocument iDocument) It's called just before to create the new document.
ORecordHook.RESULT	onRecordBeforeUpdate(ODocument iDocument) It's called just before to update the document.
ORecordHook.RESULT	onTrigger(ORecordHook.TYPE iType, ORecord iRecord)

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

filterBySchemaClass, getExcludeClasses, getIncludeClasses, onRecordAfterRead, onRecordAfterUpdate, onRecordBeforeDelete, onRecordBeforeRead, onRecordCreateFailed, onRecordCreateReplicated, onRecordDeleteFailed, onRecordDeleteReplicated, onRecordFinalizeCreation, onRecordFinalizeDeletion, onRecordFinalizeUpdate, onRecordReadFailed, onRecordReadReplicated, onRecordUpdateFailed, onRecordUpdateReplicated, 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

onUnregister

Constructor Detail

OSchedulerTrigger

public OSchedulerTrigger(ODatabaseDocument database)

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

getDistributedExecutionMode

public ORecordHook.DISTRIBUTED_EXECUTION_MODE getDistributedExecutionMode()

Specified by:

getDistributedExecutionMode in interface ORecordHook

onTrigger

public ORecordHook.RESULT onTrigger(ORecordHook.TYPE iType,
                                    ORecord iRecord)

Specified by:

onTrigger in interface ORecordHook

Overrides:

onTrigger in class ODocumentHookAbstract

onRecordBeforeCreate

public ORecordHook.RESULT onRecordBeforeCreate(ODocument iDocument)

Description copied from class: ODocumentHookAbstract

It's called just before to create the new document.

Overrides:

onRecordBeforeCreate in class ODocumentHookAbstract

Parameters:

iDocument - The document to create

Returns:

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

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

onRecordBeforeUpdate

public ORecordHook.RESULT onRecordBeforeUpdate(ODocument iDocument)

Description copied from class: ODocumentHookAbstract

It's called just before to update the document.

Overrides:

onRecordBeforeUpdate in class ODocumentHookAbstract

Parameters:

iDocument - The document to update

Returns:

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

onRecordAfterDelete

public void onRecordAfterDelete(ODocument iDocument)

Description copied from class: ODocumentHookAbstract

It's called just after the document is deleted.

Overrides:

onRecordAfterDelete in class ODocumentHookAbstract

Parameters:

iDocument - The document just deleted