org.nuiton.wikitty.services

Class WikittyEvent

java.lang.Object

java.util.EventObject

org.nuiton.wikitty.services.WikittyEvent

All Implemented Interfaces:

Serializable

public class WikittyEvent
extends EventObject

Wikitty service event. Contains :

• Wikitty service as source
• wikitties : wikitty added if type contains PUT_WIKITTY
• ids & remove date : if type contains REMOVE_WIKITTY
• extensions : extension added if type contains PUT_EXTENSION

Version:

$Revision: 1501 $ Last update : $Date: 2012-08-23 10:23:10 +0200 (Thu, 23 Aug 2012) $ By : $Author: bpoussin $

Author:

chatellier

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WikittyEvent.WikittyEventType Message type (put, remove, clear...).

Field Summary

Fields

Modifier and Type	Field and Description
protected Set<String>	deletedExtensions Use by REMOVE_EXTENSION, all extensions id deleted
protected long	eventId unique event id, each event must have eventId, and event is sequence without hole.
protected Map<String,WikittyExtension>	extensions Use by PUT_EXTENSION, all extensions added
protected boolean	remote Remote event (received from server).
protected Map<String,Date>	removeDate Use by REMOVE_WIKITTY.
protected long	time heure de creation de l'event
protected EnumSet<WikittyEvent.WikittyEventType>	type event type, one event can have multiple type (ex: PUT_WIKITTY + PUT_EXTENSION
protected Map<String,Wikitty>	wikitties Use by PUT_WIKITTY, all wikitties added

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
WikittyEvent(Object source) Constructor with source WikittyService.

Method Summary

Methods

Modifier and Type	Method and Description
void	add(WikittyEvent e) Merge this event with event passed in arguement.
void	addDeletedExtension(String id)
void	addExtension(WikittyExtension extension)
void	addRemoveDate(String wikittyId, Date date)
void	addType(WikittyEvent.WikittyEventType type)
void	addWikitty(Wikitty wikitty)
static WikittyEvent	fromXML(String xml) Inverse de la methode toXML
Set<String>	getDeletedExtensions()
long	getEventId()
Map<String,WikittyExtension>	getExtensions()
Map<String,Date>	getRemoveDate()
long	getTime() Return time of event creation.
EnumSet<WikittyEvent.WikittyEventType>	getType()
Map<String,Wikitty>	getWikitties()
boolean	isRemote() Is event remote.
void	setEventId(long eventId) This method must be call with right id, just before send message notification
void	setRemote(boolean remote) Change remote event property.
void	setSource(Object source) To allow set transient source after deserialisation.
String	toString()
String	toXML() Permet de serializer en XML l'event.
Wikitty	update(Wikitty e) Update data directly in object passed in argument.

Methods inherited from class java.util.EventObject

getSource

Methods inherited from class java.lang.Object

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

Field Detail

eventId

protected long eventId

unique event id, each event must have eventId, and event is sequence without hole. (ex: 0,1,2,3,4,5,6,...)

remote

protected boolean remote

Remote event (received from server).

type

protected EnumSet<WikittyEvent.WikittyEventType> type

event type, one event can have multiple type (ex: PUT_WIKITTY + PUT_EXTENSION

time

protected long time

heure de creation de l'event

wikitties

protected Map<String,Wikitty> wikitties

Use by PUT_WIKITTY, all wikitties added

removeDate

protected Map<String,Date> removeDate

Use by REMOVE_WIKITTY. key: wikittyId, value: removed date

extensions

protected Map<String,WikittyExtension> extensions

Use by PUT_EXTENSION, all extensions added

deletedExtensions

protected Set<String> deletedExtensions

Use by REMOVE_EXTENSION, all extensions id deleted

Constructor Detail

WikittyEvent

public WikittyEvent(Object source)

Constructor with source WikittyService.

Parameters:

source - wikitty service

Method Detail

getTime

public long getTime()

Return time of event creation.

Returns:

setSource

public void setSource(Object source)

To allow set transient source after deserialisation.

Parameters:

source - source

getType

public EnumSet<WikittyEvent.WikittyEventType> getType()

addType

public void addType(WikittyEvent.WikittyEventType type)

Parameters:

type -

isRemote

public boolean isRemote()

Is event remote.

Returns:

remote event

setRemote

public void setRemote(boolean remote)

Change remote event property.

Parameters:

remote - remote

getEventId

public long getEventId()

setEventId

public void setEventId(long eventId)

This method must be call with right id, just before send message notification

Parameters:

eventId -

getWikitties

public Map<String,Wikitty> getWikitties()

addWikitty

public void addWikitty(Wikitty wikitty)

getRemoveDate

public Map<String,Date> getRemoveDate()

addRemoveDate

public void addRemoveDate(String wikittyId,
                 Date date)

getExtensions

public Map<String,WikittyExtension> getExtensions()

addExtension

public void addExtension(WikittyExtension extension)

getDeletedExtensions

public Set<String> getDeletedExtensions()

addDeletedExtension

public void addDeletedExtension(String id)

add

public void add(WikittyEvent e)

Merge this event with event passed in arguement. Merged datas are:

type wikitties extensions removeDate

Parameters:

e -

update

public Wikitty update(Wikitty e)

Update data directly in object passed in argument. Actually only version and deletion date are updated.

rem: during store action, no migration has done. Migration is only done during restore process. This implies that extension don't change after store. But another client, may can load wikitty with migration and store it, or add manually some extension. In that case, stored wikitty has new/more extension that another client.

And internally wikitty object is marked clean (not dirty)

Parameters:

e -

Returns:

wikitty passed in argument or null, if event is CLEAR_WIKITTY

toString

public String toString()

Overrides:

toString in class EventObject

toXML

public String toXML()

Permet de serializer en XML l'event. Pourrait etre utilise pour l'envoi sur un transporteur qui ne permet pas la serialisation java

Returns:

fromXML

public static WikittyEvent fromXML(String xml)

Inverse de la methode toXML

Parameters:

xml -

Returns: