org.hypergraphdb.event

Class HGAtomReplaceRequestEvent

java.lang.Object

org.hypergraphdb.event.HGAtomEvent

org.hypergraphdb.event.HGAtomReplaceRequestEvent

All Implemented Interfaces:

HGEvent

public class HGAtomReplaceRequestEvent
extends HGAtomEvent

A HGAtomReplaceRequestEvent is triggered when an attempt is made to replace the value of an existing atom within the HyperGraph, but before the replacement process proceeds. This event gives a chance to an application to cancel the replacement of the atom. A listener to this event may return the HGListener.Result.cancel code which will prevent the change from happening. On the other hand, if an application needs to perform some action as a result to an already completed replacement, the application should then listen to the HGAtomReplacedEvent.

A listener may also throw a HGReplaceRefusedException which will fail the current transaction and must be caught at the application level.

Author:

Borislav Iordanov

Constructor Summary

Constructors

Constructor and Description
HGAtomReplaceRequestEvent(HGHandle handle, HGHandle type, Object newValue) Construct a new HGAtomReplaceRequestEvent for the given atom.

Method Summary

Methods

Modifier and Type	Method and Description
Object	getNewValue()
HGHandle	getType()
void	setNewValue(Object newValue)
void	setType(HGHandle type)

Methods inherited from class org.hypergraphdb.event.HGAtomEvent

getAtomHandle, getSource, setSource

Methods inherited from class java.lang.Object

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

Constructor Detail

HGAtomReplaceRequestEvent

public HGAtomReplaceRequestEvent(HGHandle handle,
                         HGHandle type,
                         Object newValue)

Construct a new HGAtomReplaceRequestEvent for the given atom.

Parameters:

handle - The HGHandle of the atom.

Method Detail

getNewValue

public Object getNewValue()

setNewValue

public void setNewValue(Object newValue)

getType

public HGHandle getType()

setType

public void setType(HGHandle type)