com.orientechnologies.orient.core.index

Class OClassIndexManager

java.lang.Object

com.orientechnologies.orient.core.hook.ODocumentHookAbstract

com.orientechnologies.orient.core.index.OClassIndexManager

All Implemented Interfaces:

ORecordHook, ORecordHook.Scoped, OOrientShutdownListener, OOrientStartupListener

Direct Known Subclasses:

ClassIndexManagerRemote

public class OClassIndexManager
extends ODocumentHookAbstract
implements ORecordHook.Scoped, OOrientStartupListener, OOrientShutdownListener

Handles indexing when records change.

Author:

Andrey Lomakin, Artem Orobets

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
OClassIndexManager(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 document) It's called just after the document is created.
void	onRecordAfterDelete(ODocument iDocument) It's called just after the document is deleted.
void	onRecordAfterUpdate(ODocument iDocument) It's called just after the document is updated.
ORecordHook.RESULT	onRecordBeforeCreate(ODocument document) 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	onRecordBeforeUpdate(ODocument iDocument) It's called just before to update the document.
void	onRecordCreateFailed(ODocument iDocument) It's called just after the document creation was failed.
void	onRecordCreateReplicated(ODocument iDocument) It's called just after the document creation was replicated on another node.
void	onRecordDeleteFailed(ODocument iDocument) It's called just after the document deletion was failed.
void	onRecordDeleteReplicated(ODocument iDocument) It's called just after the document deletion was replicated.
void	onRecordFinalizeCreation(ODocument document)
void	onRecordFinalizeDeletion(ODocument document)
void	onRecordFinalizeUpdate(ODocument document)
void	onRecordUpdateFailed(ODocument iDocument) It's called just after the document updated was failed.
void	onRecordUpdateReplicated(ODocument iDocument) It's called just after the document updated was replicated.
void	onShutdown()
void	onStartup()
protected void	putInIndex(OIndex<?> index, Object key, OIdentifiable value)
protected void	removeFromIndex(OIndex<?> index, Object key, OIdentifiable value)

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

filterBySchemaClass, getExcludeClasses, getIncludeClasses, onRecordAfterRead, onRecordBeforeRead, onRecordReadFailed, onRecordReadReplicated, 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

OClassIndexManager

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

onShutdown

public void onShutdown()

Specified by:

onShutdown in interface OOrientShutdownListener

onStartup

public void onStartup()

Specified by:

onStartup in interface OOrientStartupListener

getDistributedExecutionMode

public ORecordHook.DISTRIBUTED_EXECUTION_MODE getDistributedExecutionMode()

Specified by:

getDistributedExecutionMode in interface ORecordHook

onRecordBeforeCreate

public ORecordHook.RESULT onRecordBeforeCreate(ODocument document)

Description copied from class: ODocumentHookAbstract

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

Overrides:

onRecordBeforeCreate in class ODocumentHookAbstract

Parameters:

document - 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 document)

Description copied from class: ODocumentHookAbstract

It's called just after the document is created.

Overrides:

onRecordAfterCreate in class ODocumentHookAbstract

Parameters:

document - The document is going to be created

onRecordCreateFailed

public void onRecordCreateFailed(ODocument iDocument)

Description copied from class: ODocumentHookAbstract

It's called just after the document creation was failed.

Overrides:

onRecordCreateFailed in class ODocumentHookAbstract

Parameters:

iDocument - The document just created

onRecordCreateReplicated

public void onRecordCreateReplicated(ODocument iDocument)

Description copied from class: ODocumentHookAbstract

It's called just after the document creation was replicated on another node.

Overrides:

onRecordCreateReplicated in class ODocumentHookAbstract

Parameters:

iDocument - The document just 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

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

onRecordUpdateFailed

public void onRecordUpdateFailed(ODocument iDocument)

Description copied from class: ODocumentHookAbstract

It's called just after the document updated was failed.

Overrides:

onRecordUpdateFailed in class ODocumentHookAbstract

Parameters:

iDocument - The document is going to be updated

onRecordUpdateReplicated

public void onRecordUpdateReplicated(ODocument iDocument)

Description copied from class: ODocumentHookAbstract

It's called just after the document updated was replicated.

Overrides:

onRecordUpdateReplicated in class ODocumentHookAbstract

Parameters:

iDocument - The document is going to be 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

onRecordDeleteFailed

public void onRecordDeleteFailed(ODocument iDocument)

Description copied from class: ODocumentHookAbstract

It's called just after the document deletion was failed.

Overrides:

onRecordDeleteFailed in class ODocumentHookAbstract

Parameters:

iDocument - The document is going to be deleted

onRecordDeleteReplicated

public void onRecordDeleteReplicated(ODocument iDocument)

Description copied from class: ODocumentHookAbstract

It's called just after the document deletion was replicated.

Overrides:

onRecordDeleteReplicated in class ODocumentHookAbstract

Parameters:

iDocument - The document is going to be deleted

onRecordFinalizeUpdate

public void onRecordFinalizeUpdate(ODocument document)

Overrides:

onRecordFinalizeUpdate in class ODocumentHookAbstract

onRecordFinalizeCreation

public void onRecordFinalizeCreation(ODocument document)

Overrides:

onRecordFinalizeCreation in class ODocumentHookAbstract

onRecordFinalizeDeletion

public void onRecordFinalizeDeletion(ODocument document)

Overrides:

onRecordFinalizeDeletion in class ODocumentHookAbstract

putInIndex

protected void putInIndex(OIndex<?> index,
                          Object key,
                          OIdentifiable value)

removeFromIndex

protected void removeFromIndex(OIndex<?> index,
                               Object key,
                               OIdentifiable value)