From a5b27943b0852f66561044ea7df39cd056f387db Mon Sep 17 00:00:00 2001 From: jprocter Date: Thu, 16 Mar 2006 18:00:51 +0000 Subject: [PATCH] simplification of some events and clarification. git-svn-id: https://svn.lifesci.dundee.ac.uk/svn/repository/trunk@184 be28352e-c001-0410-b1a7-c7978e42abec --- docs/VamsasSessionEventAnalysis.xls | Bin 27648 -> 27136 bytes src/org/vamsas/client/Events.java | 26 ++++++++++++++++++-------- 2 files changed, 18 insertions(+), 8 deletions(-) diff --git a/docs/VamsasSessionEventAnalysis.xls b/docs/VamsasSessionEventAnalysis.xls index dbc3c6d948c088f7510be96e0e906eea6d585f24..87bdc46f66c59fc606844ac6487ea51a3940a87a 100644 GIT binary patch literal 27136 zcmeHQYiu0Xbw0ZsJ|x+CTXHB_8a-?+DT~MFMoNBqt z>?~!oXbQ$@0K-v%*iId=2oeM>j0OeV6a~^WC{j5sprlpMqCgO&znm0B(ZYZ1I)#ne zX20*;nc3L~A9`4}!X08B_s)IIz2|)A+;h)e{>wjacOL>s-Luy2ws&Wu78K~BF7DS`&6-zF1bZJb^KG0blCCZ5oG$V^$lFt$`)LkWvjGFOVjX#>z3|`Js*la_iRPV z!~=S@K89zJje6ar*M|_|@!y|*uJf=yCFF_ZQGNG^dflzpwYVnauM^DwZyIxtY?2=% z)Fxjgb>gswoxJ}+M(?mT&90B3q*PCr`VX&y`=cORH=( zFS`%M@*#k%JMjhE<8R}+O_BrBDV?LKy`6Sgvj$Qc>Nui--3NA~MWd;sqbRdeI%MBy zDxSX6E+_A_D^lMlU2>>gylG>s1~ww9q_?+R%^}$@cSqHP`NEolY+6}4*J}bu!SU;P zTQ1uAD2(G6BJQoF;z$71>FUL?ZlXfRVS{qPTZ=RIQA9l zJ@u@`C($wDJt6IN;_UVDwwQFCb<%CD6L&|Qxb}MGMR6}CEm=R?G|&5n*%rNToVE16 zX|`4GGAnxDJlj0~0uauC3m{umhy@o)G>yT-ESnu%W^tco01p>0Uc_xy=H}*Qt|trG zcUdkYeHMT7h?gwFmsudH{QR8EAv`~ayeN16@|^T!=cVWJ zWyB*j&pDh~6rY`wmtJ}af;THYbBKTd?!h^yC*peMqa|+Mz?PmNhdOKpz-r zCtWA+<;Sh$0YoJcb*BvGy^`mY+>AXoV>@}zz00J(Iamw0o`O9Y|s!$!*eK$or+Da+=?RHqneJH361?`mn2`4}9`gRuIGC7?qc?YI_=uy6Dg>QOwm25+= z<_jg)|Dn8z5nnCa8-FXN2j;~}ZUrZixzaI1+M@VvfwnS@)vM zn7lsBn5<&PJId1K54dt@LToO}ta^jV}Q zcb=~1&bY`6xf5(gCV^%~#&RiU@`bWEJnu~U5R{>)0mr?F(#gzU5vN9`QbHQu5Ap@d znw<(Xy-FEsKjoDs3Sf1U`dBFMGSo#=PodsI(HkdJ?DLS-EwVsOZ&Z4uRv0BLo zk&5#A-bgypq>^l3lJT1e2D4b z+o22;XUyOjy%=K_?}sh}bQr^QValUsGhHf7V&=eU!wmKMbkU{q4prYR8hyI5>|V9dj!(hyocBWEfp&-TH{xr}|@EqYnbS~K?a z6!;i`f*EIg2CK|%2pP~r0ofr|4vW=-^{oAM4Go za6lbQEU0lYA?7OakxUl=M;=r)&Ld`^VnORerzki_7}#suCsD4gGZ!dyFdG1#itgv9 zJ;{k%8eeXNLMu3=I!h$q^(W+MHYnZIon{M*~Fz z6k4URkRqM)1rO6@Y8ANxW$uqqFcIblOCe09@rsX06#F>cHO)^S;%-<3T)qlQlWXY>`-m0;7v6GV)n8TUs0>__=qLu zovWS^)zf=Qq&h{inD~W)MW=96&ORaIcJ<`;=3iZU>0T5;_5Wfl(T=?@OB@S^Zt|rb+!bZ znSk8f0OS=2$Xmgg1mtyPKsIb(B|nK*1mcH*mqs0k>j6Zu2*8LH3xYAtkS&V5otQlm zVn~buV1)eIZ4}2aX!N?4K(E8x6zdwVpcG=<%M#gioS2o>*pHw*dXtlGhD#~cb#;%s zr7D!*L>kK@ZjlBo7YtsS2#if-#Sk`ARdVo+nP9Ry8mPIcv@;Fx9*2?EeR|4;%Ln<* z$GU~zq43zU40wDH-*s(s$(9P8Zw{pqj-HoLGevi+9K@tr=bs*@rWBDz6O6$UfGsiv z8^{2_)M|k#e4ah*O-|(kV;(vk&$L^c6)RwpqMS3O)8IlDQ04iGGc66AS%En7IgluE zW<-VuhKI3EGdld}$eCk9k3R+(s7o1O>LLXzCKx_eK+HO5FhA=GWEozA7&B^Cfh_gi zbFMo@{-aH}Rnh8@s*RPiOI5i5B4wq`XfWaI&r0?pH+94N7c^F5^(9M>u23f!t=3!n zQ3MsUBRUPWhhU59wNnvP1?Fd6KvjX9Efyy2N>#HLv)MruLzL?SR{GOpKITl|stC$3 z=L(?{dH@V*nLwQ}utUQhAaI~qEEEAicc3t1>aOV!v+i^l35Y!hB~%P_ETEw1+L)cH z;_Hk%^I@jw1aXP|KRu0GQ}E zvIc)iyk5xJNF86~ANMz$jgnXoFwREv^1ar$^AI{uoriu7h~=@!An5y}xauHi2!mjb zr3PULZaoc;uNyE3!Fb%D+p0D=_O&$2rM*9GeRUR(V9Z~FJHKlgPw-!%9cN`qHi#_l z18!g6!?=_?aO+OUMbPL&2~OOS&_;}#d9B0vU#JWC-|DqK4=m4ld~>z)xESy84>o>> zMW;ISa^x#sb`#&G>P-1f+z%W+-P@rh01)Dy;z3?ITJNxSL5J90`95BPNpv?o$wkV} z-s;Q^$MUjsI06;k;a&74XO?Aplix4!CXZJU`h`ce1didRqOxcB4(nd}lgFwGbB4_e zGS+yM(}~o0lvkCtf|&YvNg(w&&fj-e)b2yNQQ0Zryl07H`^b(t|VVrpFeQ zy76#Vts5V&ccJnx+E?nu{@aR@E5(<6t^6_l!hwmQGy7WkBWQ?G47}Ob%3H>p-K6OW zUCUoda9K5Banlip=+xQ=ap#F}zHkK2;-TxtmAfip6=;C2lG|C-BA%1xHB1MA$27jC zU)LzAJSahQv{Hp@vo!t(v&~?&7E`#$uyv;_&)XV;;&go{Yc`{vZ#8lptM5_`Y93zD zllq~W;;zhr8cyL$_)Vj~VUKhD5j5k2u)jc7oq>I{#>$|6MGKi-?#DP7du(^59VFGU zgtY~p^pPFLn5#jKT>ZaFv&+MBjW+H+6mYHP8qo0a&EufJn$D(4hZGq4i&a^uNCI{* zHll`BkmZ_sPMX1uTmJ)-@zpKGzAQJ11^*fFm3o1P%M$Q}xZ$R)ACNXHT`+)vv6bf< z=7GH|0}mY9qqs2hVXjwW!_`OA90xpJc**+q7!y@_L#$uy~Vt&zAU9kbe3u%Y2rGJ#%88M-{g6%8NU8}aNL3ysi>}Bj@ zfgaaaL)UR%|Jv6!Xjg3aCV_H5Ouk(3%1m?Cj%1yi23l1+=6|bHd80pYL}qXaoh|Ws^8O*rVjz_5hg_UBus6C5Et+{(&io4;#Wl> zE~%4J%sZ}$gM@+*7r;q@<{g)`K~_PCOUmpi^NzbBL59-Ub-Z$RMuuNHuQWhgINd}H zMVO7opNK-Fzz3obDUb(g$LtdZoCP6LAlG@#J5nG^HX*ZvHw=*i$)$84Xza@kM`NYj z4b>6xxS!3?gxQ7*twHIKc1*;v=#Wo(!LR@xv$y>43+BG&DQLZmtyp@tKDd^A?d z^Ssar{w&Do0%+j(-)sB77vA3fzc2sK!8hvro<59C&SfX~1oH4$&>4Pl({GslJD9or zCYXNfcvT0cT+>Z7sM&uFC+8J>&oEaUXo~|!$x)nKWq1@P z*B(BPlUBalq^0*ge=89+wYn6$x zr$|f7IcQ;>4H7@1^`Bc#wz_FnOH%76-?1Ha6V-`)fkrhPkE8w~eqv_qD%*j7S)ujQ z!nfS|IsYA|(F8{`P@^De{7BxUxHRD2vf4(*l*Gex-elG5;h_F-3}UYq zef)>uZL?fiebt4gg8GRc%l&@#)$dgo)ChklJrKu#jtlXh797fD$~Jl%(8qwHmolC5 zeJxIU3{d8Cj!ij7`NugmEj^q~Q-*LJP3t2qJe)<-_DK5Bl9DV-)WeoVy+$uXh@bSQdQH~RfoGn?ncX< z_0Fzr77f5S4UifNP}hM20zrxZMSvoJo2ICn8bvD?1=OGl+y)Jd^p}%9fFk+fI8I@s zw%PBy_s;C>a!FAy+sf|9GduUrea)S7zH{!m=g|N1`kFVt`4^o(k(%QXX^{`-mP=bK zKY{zcFx???0Qb!MaBgmn+4thaZS%N=W?=cUWg@Mul3V`$b`rsBV&VGtI4|P-Db6Ql zo2+>}JLQ}#`l*svbdrxf{%DsIKORM;@7Q0*b(P$SYpZOKWzyC%n(@5Sf!KXt?7n{k zN+upuS9>GwMb@h8I(2;*DITw;y7wPccM16|>#%zE6?NUAuB&iO$X_Q||KC;40a+*i zgw!(mBT^?0d(_PbH#2*yy&f;UX4lT1ojdoR?K+gycU@cYVr_C~l>gaNUizuZ!%k_J z4fL#og_GGH5&MLLu6hI1& zU(Gpk(NVX;Jbpvuy>q2J5g4s*$?L9@w|rh6 z=L-Fv{IbnEQQwHa30Yew&*_MdMVH%Br(9>9yzY8=QF||1wsg$2%<*^4Oq=>$J7cTg zbu;biS7t>0uAgb0`(vP)1`@!tD1l`zlwK+aH!~cfxy;~qh6&tUym%2mGcr3nC$s$% zkaL&iGRjZj-yHH~0_n?a5MA;gZ&iD$1=R+7K_yl1GV0IG&B`p&bF-+6cIPh7O8>;1 z^k2S=e3a%ni*o|aPt3|oFTErvApNt*=*NFJXVr5_a&ZkP5p^et@~eVMUr zZzZFT8DHtCWc07Vy%qxvC=-QJshJA@AqvQCLpVM@=5bC5g_coNe9C9NCCB96s;mOSZL| zC6LiB$2~Wn%}?6aK4e+Q+ASmbY$@xOytFeu?YMczEfjLulv~RBc_-!Oawy*0Yg^k; zp#>E-$SE)7WzXyKSzXyLIs>+~1x0KWxkHBhd{8R7*?cK*(995;@rt^QR@KH4x8ynn zHwe&7$#;snNfaS1w4q3+jCw)9F$5(Hj;*jzfy1&bQb{{XJzU#U*pQQaCX-ENoNS<8 zDOJLNosm>7i}`S}7@V6=d0n=(2MsMlL)&C1wpq z!3SP0o0|U`Xa?rQwl;uu$W5zd=-9~c6JuwGP7M!^jhuMGwhrPE`D(umI(hGzD%Q!k zf%7>(n+Jh|sk~>iK?$4`(i52_p&0NE85vS!*~`*~=#wDL6(~T4vn21^)-I&TTbq%} zd(J+`BWo-A4yN;|OwrH#zbI+ zYBFO3GUG-t2AOe<962#``gpa7bMcU@_?cQ(jLWx>6_xU&6)&=pN1>AUE5a|XTBfN1 zLi!Y^ZOca|WZ+40=gCn@Ma}Q$-KhXV)o5f+(x`LQa#M*Mh)CTjrQ2YkptQ|wK9Xp_ zgSF_Ac(6jIy`Tr`Wo{bm{s8jG?gu0$jGbq)xtwPB3cq``>~354qB6O?N5U?rpllb) zIkyCmpJ~`loZ9R{Al*rFjB(gvLIWJ{|Ed(ae3R9=vBHqk&!Bf~p*{l={ zG#kBRZzR?;UM{V=kCbB!AXW6JR%?A} zJb3ctk-@P++j3Dxquf|E0r0{L`HsrVO4KA+*#s-V)ClefQ-e}fG!9hdd?}lAz#ay4 z0w?2Q39Pknthq5hrLWl5Aew5$di#O8u*EkvFH*zlP7)B3CU9be9vUHrJypRlg-Bd} zrwJP@t5DWS4s`X*$ENsHhOFx#S1w;~Mr=cN2X$4Z1GHwhs2OQ@(KDMJ4UeHG& zxYT4lUCtK0bT3iMZlYELqSiL>BvETa1+`8M|HkRz(Xp`;L&r{x4%^mg6d`CGmjyse zk*s2Mqced*Yk3(I>7MtqSnU(Pa()0C!aty40@bTm0;=jYQL;-jyRu3UU~*XFgLS81 z2PE;=n%`7umitYu*csc06CxkL3c8Qy_*#p%n6Kdl z$R%{1t6k95Q}V!ywTn7~?ZgDI{XQokM=NC|a2`8765@h>YsXcFMwixst2PHLMTJ^%5sS&0fJ!5LNBJKV(rQWc9 zHH>W^x+bLVUO?kxlNySt^`XK=R3KJ<4`aovkNfAnUgt3{?-i9gHts>xWc@OXr&@Tj zffOXqB<)tz88KtPys7MDM(K&JvnNFr(9K24J=C}W7Bdf@dyg~av353?LPdZl-aeZ@ z@1LWc3e!&+NBE_3NKsw%O64LXu>LUNY5}e1gMwQ`KhX4vtF293Z9rVz04^i0uCCy! zW(V8)G#(L89|7!XsU8>S1fys{LzZ6MxqXN}UEOu1zs$|Ow1-m?WPQLz>)dI7def-V5VF^rffcSHt^ z)j51WC(Jm?=CPfFHDIBj`8k@^us1C@FassDM^MZ~pcoYa2)O6nY|iCEl#628<2W+v zn?`X=mh(BRRcnXBs;N?0Vb%OCD89!^^cpvA&mv90dqGYs#q_vQ(># zG2p{GI5K!g`rmwYF^LIuMzd3eoH1JBv*MoidA${fQ7asE3+k0IfiyZQBx`FTSpy>3 zT_8~+S%-`ckB(wL>g?#z(_=?YoOyy~>vjcYeM&W)r*bH(TtzX{T1vQ3w53%T0VRnmH*=ubJ->LiUuBWOl1 zbYboLY5q^DJqBVI5x)u=qH*ZGa*XC17z+XGB>*vmiBY}^MSmO}O&cvN ze94%ug$BwK6UwNFK}FpF=)@GVBo#1b7SsEnU6rOCbV386erEtPWD{Wz zJMKXyl$l-BzuKFq)o`fwhOC!|b_%R4BHw-gci#KgU%ma-LqGq||E}*d`Uv*GUr{bE zhf#hDbhZ}48hu&FY>C9e4p7P&M;?c_RMP=!g>itIlULd|VD@-$=6KMd=?y?Ek3~L$ zdVUyJ^$}D`eF)xN=_9-jSEJ@f_y|6N{w&RFW6Z$vWpMUvYn4m8e$f8f3~u33@e`jk(x%pe|JE2u#mZMmKN|?YVsFQFxjh@8g0N~TV8A1$z9FG(*b?Ioo z)!q&rZgchXcniAFJ&Ys}sW|&9XMO}0RDuJLsEQ8gVJrcwEHRqkenB)ryo)d{AnL^g z2I!6|kpWxndl^p<>nf}n4$oAa7g0dRVjWSSZq((X^Cr{>N_Ke4i@Xy)Sv;SPM)k@s zl+RY{mH&0lPl&_UGePVwynObi#`AvI@0V?U zcb$*WqPqD`EMJdbmxoJo-SV9av*q97Hm#k~ipq4t!K)`opk-m$BX1A_<$pW&9LpRv*SMPo(oc_QZzi_j(8c1EF8a z)qAgQW>X70(ZZ|}y2zI*Zi(m}fojz11e7Bs>WgHAErsAu>^EGe0PYJ`~qzk$Obr`t}9}(ZKauvOrEt z-&O$8%$sal;7K&0w_lC%jzsSa?3b&yf*sc%H@<6P4B^+d6a6i@MRq=(11l&W{%E`7 zW3c+YO4_XUKmlmQHs0qkk3ypCCt|z)h}@7ZBZS#~G7X*xEQ{E!#`|oALL}pYnyVmo zB;aWCy-8bLpIMM&uixSA9AY1<-0X^Z*IUz3YP?-i-P%2y)U^@4ozHuJEGjHo1v zGSULeuMkEAGB?*T1hg?&jVCwGT|?NW2v5t(7tLw*LWz`_^V7(T-HWs-4w6# z2QXvCqdD&RO?}VE;E1PG|Lyo=K`8TY_Q+3S!{Kf|+Mg6CJ`8E)|x2xy4z zs4_&~W@&>B9-|k1Z0Wi2`#@iSS>U7mD+D*_?+I9|)RbV-aoh@jQ{V%$VYpG5Uv-ME za@;u7Df)}>eRPVhAIqZ@Jvc}y`Wam?Zi`ZM?;-{2XY`-|S(y|)7&ue(7HG!aH`-qw zm{U}M4-YDM(9nbqw}<7*JR{Y?CSy{hIv%7Y9W4(CGbvIXT?zCvQXLG6CPk`)WznQa zb;K-ET{AkpF{zHU!6;Bo6FL|jf3HVTh>kVCFG`W>p!u6;#JY!~RGjK`q<2VlI$%4b zIvuVZQe86)yD_PbXthz2hI+6Kf)xJ%6fsK&NW;ouQlz>aQHoS|Z>CRQh`=S)F4hwfhbPfMAq!@X#!&?!)2i62XSf6mqK*EZBle=IW)$A5ko;y=wBl*^QD+Y4&h%ZpXO;=T4lvaPG!QLorkaC0A)C grYUYO&K{gJ#F2H$K5Rccxvj?g4@iW~W63k{|5Q}YKmY&$ diff --git a/src/org/vamsas/client/Events.java b/src/org/vamsas/client/Events.java index c1b80e0..4a91f5a 100644 --- a/src/org/vamsas/client/Events.java +++ b/src/org/vamsas/client/Events.java @@ -3,13 +3,18 @@ package org.vamsas.client; /** * Enumerates the event types generated during the lifecycle of a Vamsas * session. + * See the excel spreadsheet in VamsasClient/docs/VamsasSessionEventAnalysis.xls for + * some more information about when these are generated and how they should be + * handled. + * */ public class Events { /** - * Generated when a client has finished updating the document. Passes - * applicationHandle of client so the updating client can recognise its own - * updates. + * Generated when a client has finished updating the document. + * Client which has completed an update should + * not receive the event. + * NewValue: org.vamsas.client.IClient for session. */ public static final String DOCUMENT_UPDATE = "org.vamsas.client.events.documentUpdateEvent"; @@ -17,7 +22,8 @@ public class Events { * Generated when a new vamsas document is created (perhaps from some existing * Vamsas data) so an application may do its own data space initialization. * Raised for a new application connecting to a vamsas document - * which contains no existing data for that application. + * NewValue: org.vamsas.client.IClient for session. + * LATER: DOCUMENT_CREATE event may be redundant */ public static final String DOCUMENT_CREATE = "org.vamsas.client.events.documentCreateEvent"; @@ -36,13 +42,16 @@ public class Events { /** * Generated prior to session Shutdown, after the last participating vamsas * client has finalized. + * Probably only useful to IClientFactory implementations. + * NewValue: */ public static final String SESSION_SHUTDOWN = "org.vamsas.client.events.SessionShutdownEvent"; /** * Generated for all clients when any client calls IClient.storeDocument() to * allow them to store any updates before an offline copy of the session is - * created. Any client that handles this should call the + * created. + * Any client that handles this should call the * IClient.getDocument(), update and then IClient.updateDocument in the same * handler thread (the lock on the document is held until the handler exits). * EventName: @@ -51,8 +60,9 @@ public class Events { public static final String DOCUMENT_FINALIZEAPPDATA = "org.vamsas.client.events.DocumentFinalizeAppData"; /** - * Generated by Vorba stub for the sole remaining client, after the penultimate - * client makes a call to finalizeClient(). It is only raised if the session has been modified since the + * Generated by Vorba stub for the sole remaining client instance in a session, + * when it makes a call to finalizeClient(). + * It is only raised if the session has been modified since the * last call to storeDocument() by any application. * LATER: copies of a document should be on a per-user basis for multi-user sessions. * Sequence is as follows : 1. All other vamsas clients have @@ -62,7 +72,7 @@ public class Events { * for future reference. * * Any call to finalizeClient in a thread other than the registered * EventListener will block until the RequestToClose handler has exited. - * + * NewValue: org.vamsas.client.IClient for session. */ public static final String DOCUMENT_REQUESTTOCLOSE = "org.vamas.client.DocumentRequestToCloseEvent"; -- 1.7.10.2