ch.agent.crnickl.impl

Class UpdateEventImpl

java.lang.Object

ch.agent.crnickl.impl.UpdateEventImpl

All Implemented Interfaces:

UpdateEvent

public class UpdateEventImpl
extends Object
implements UpdateEvent

Default implementation of UpdateEvent.

Author:

Jean-Paul Vetterli

Constructor Summary

Constructors

Constructor and Description
UpdateEventImpl(UpdateEventOperation op, DBObject source) Construct an UpdateEvent.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getComment() Return a comment giving informal details on the operation reported in the event.
UpdateEventOperation	getOperation() Return a constant identifying the operation which generated the event.
DBObject	getSource() Return the database object reported by the event.
DBObject	getSourceOrNull() Return the database object for which the event was reported.
Surrogate	getSurrogate() Return the surrogate of the database object source of the event.
DBObjectType	getType() Return the type of the database object source of the event.
int	hashCode()
String	toString()
UpdateEvent	withComment(String comment) Set a comment.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

UpdateEventImpl

public UpdateEventImpl(UpdateEventOperation op,
                       DBObject source)

Construct an UpdateEvent.

Parameters:

op - an operation

source - a database object

Method Detail

withComment

public UpdateEvent withComment(String comment)

Set a comment.

Parameters:

comment - a string

Returns:

the update event

getType

public DBObjectType getType()

Description copied from interface: UpdateEvent

Return the type of the database object source of the event.

Specified by:

getType in interface UpdateEvent

Returns:

the database object type

getOperation

public UpdateEventOperation getOperation()

Description copied from interface: UpdateEvent

Return a constant identifying the operation which generated the event.

Specified by:

getOperation in interface UpdateEvent

Returns:

a constant identifying the operation

getSurrogate

public Surrogate getSurrogate()

Description copied from interface: UpdateEvent

Return the surrogate of the database object source of the event.

Specified by:

getSurrogate in interface UpdateEvent

Returns:

a surrogate

getComment

public String getComment()

Description copied from interface: UpdateEvent

Return a comment giving informal details on the operation reported in the event.

Specified by:

getComment in interface UpdateEvent

Returns:

a comment or null

getSource

public DBObject getSource()

Description copied from interface: UpdateEvent

Return the database object reported by the event. The source is not reliable because it can identify something which has been deleted. Depending on the case, the source still holds useful information like the name. If a reliable source is required, it can be constructed from the surrogate using the Surrogate.getObject() method, which returns either a valid source of an SurrogateImpl.InvalidDBObject object.

Specified by:

getSource in interface UpdateEvent

Returns:

the database object for which the event was generated

getSourceOrNull

public DBObject getSourceOrNull()

Description copied from interface: UpdateEvent

Return the database object for which the event was reported. If the object is invalid, return null.

Specified by:

getSourceOrNull in interface UpdateEvent

Returns:

the database object for which the event was generated or null

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object