com.orientechnologies.orient.core.db.record

Class OClassTrigger

java.lang.Object

com.orientechnologies.orient.core.hook.ODocumentHookAbstract

com.orientechnologies.orient.core.db.record.OClassTrigger

All Implemented Interfaces:

ORecordHook, ORecordHook.Scoped

public class OClassTrigger
extends ODocumentHookAbstract
implements ORecordHook.Scoped

Author : henryzhao81@gmail.com Feb 19, 2013 Create a class OTriggered which contains 8 additional class attributes, which link to OFunction - beforeCreate - afterCreate - beforeRead - afterRead - beforeUpdate - afterUpdate - beforeDelete - afterDelete

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

Modifier and Type	Field and Description
static String	CLASSNAME
static String	METHOD_SEPARATOR
static String	ONAFTER_CREATED
static String	ONAFTER_DELETE
static String	ONAFTER_READ
static String	ONAFTER_UPDATED
static String	ONBEFORE_CREATED
static String	ONBEFORE_DELETE
static String	ONBEFORE_READ
static String	ONBEFORE_UPDATED
static String	PROP_AFTER_CREATE
static String	PROP_AFTER_DELETE
static String	PROP_AFTER_READ
static String	PROP_AFTER_UPDATE
static String	PROP_BEFORE_CREATE
static String	PROP_BEFORE_DELETE
static String	PROP_BEFORE_READ
static String	PROP_BEFORE_UPDATE

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

database

Constructor Summary

Constructors

Constructor and Description
OClassTrigger(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.
void	onRecordAfterRead(ODocument iDocument) It's called just after the document is read.
void	onRecordAfterUpdate(ODocument iDocument) It's called just after the document is updated.
ORecordHook.RESULT	onRecordBeforeCreate(ODocument iDocument) It's called just before to create the new document.
ORecordHook.RESULT	onRecordBeforeDelete(ODocument iDocument) It's called just before to delete the document.
ORecordHook.RESULT	onRecordBeforeRead(ODocument iDocument) It's called just before to read the 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, 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

Field Detail

CLASSNAME

public static final String CLASSNAME

See Also:

Constant Field Values

METHOD_SEPARATOR

public static final String METHOD_SEPARATOR

See Also:

Constant Field Values

ONBEFORE_CREATED

public static final String ONBEFORE_CREATED

See Also:

Constant Field Values

PROP_BEFORE_CREATE

public static final String PROP_BEFORE_CREATE

See Also:

Constant Field Values

ONAFTER_CREATED

public static final String ONAFTER_CREATED

See Also:

Constant Field Values

PROP_AFTER_CREATE

public static final String PROP_AFTER_CREATE

See Also:

Constant Field Values

ONBEFORE_READ

public static final String ONBEFORE_READ

See Also:

Constant Field Values

PROP_BEFORE_READ

public static final String PROP_BEFORE_READ

See Also:

Constant Field Values

ONAFTER_READ

public static final String ONAFTER_READ

See Also:

Constant Field Values

PROP_AFTER_READ

public static final String PROP_AFTER_READ

See Also:

Constant Field Values

ONBEFORE_UPDATED

public static final String ONBEFORE_UPDATED

See Also:

Constant Field Values

PROP_BEFORE_UPDATE

public static final String PROP_BEFORE_UPDATE

See Also:

Constant Field Values

ONAFTER_UPDATED

public static final String ONAFTER_UPDATED

See Also:

Constant Field Values

PROP_AFTER_UPDATE

public static final String PROP_AFTER_UPDATE

See Also:

Constant Field Values

ONBEFORE_DELETE

public static final String ONBEFORE_DELETE

See Also:

Constant Field Values

PROP_BEFORE_DELETE

public static final String PROP_BEFORE_DELETE

See Also:

Constant Field Values

ONAFTER_DELETE

public static final String ONAFTER_DELETE

See Also:

Constant Field Values

PROP_AFTER_DELETE

public static final String PROP_AFTER_DELETE

See Also:

Constant Field Values

Constructor Detail

OClassTrigger

public OClassTrigger(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

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

onRecordBeforeRead

public ORecordHook.RESULT onRecordBeforeRead(ODocument iDocument)

Description copied from class: ODocumentHookAbstract

It's called just before to read the document.

Overrides:

onRecordBeforeRead in class ODocumentHookAbstract

Parameters:

iDocument - The document to read

Returns:

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

onRecordAfterRead

public void onRecordAfterRead(ODocument iDocument)

Description copied from class: ODocumentHookAbstract

It's called just after the document is read.

Overrides:

onRecordAfterRead in class ODocumentHookAbstract

Parameters:

iDocument - The document just read

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

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

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

onTrigger

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

Specified by:

onTrigger in interface ORecordHook

Overrides:

onTrigger in class ODocumentHookAbstract