src/jalview/io/vamsas/LocalDocSyncObject.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.4)
   3  * Copyright (C) 2008 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle
   4  *
   5  * This program is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU General Public License
   7  * as published by the Free Software Foundation; either version 2
   8  * of the License, or (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program; if not, write to the Free Software
  17  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
  18  */
  19 package jalview.io.vamsas;
  20
  21 import uk.ac.vamsas.client.Vobject;
  22
  23 /**
  24  * Implement the basic logic for synchronising changes to or from the Vamsas
  25  * Document. This is a more generic and normalised framework than the one implemented in DatastoreItem,
  26  * but probably more tedious to implement.
  27  * .. abandoned. Nov 2008
  28  * @author JimP
  29  */
  30 public abstract class LocalDocSyncObject extends DatastoreItem
  31 {
  32   /**
  33    *
  34    * @return null or the local object that is being worked on.
  35    */
  36   public abstract Object getLObject();
  37
  38   /**
  39    *
  40    * @return null or the document object that is being worked on
  41    */
  42   public abstract Vobject getVObject();
  43
  44   /**
  45    * endpoint for synchronize when all opreations are finished.
  46    */
  47   public abstract void nextObject();
  48
  49   /**
  50    * called if the local object can be safely updated from the bound document
  51    * object.
  52   public abstract void updateToDoc();
  53    */
  54
  55   /**
  56    * called if the associated document object can be safely updated with the
  57    * local changes
  58   public abstract void updateToDoc();
  59    */
  60
  61   /**
  62    * @return true if the local object is modified
  63    */
  64   public abstract boolean locallyModified();
  65
  66   /**
  67    *
  68    * @return true if the bound document object is modified
  69    */
  70   public abstract boolean documentModified();
  71
  72   /**
  73    *
  74    * @return true if the document object is locked w.r.t. this object's update.
  75    */
  76   public abstract boolean documentObjectLocked();
  77
  78   /**
  79    *
  80    * @return a new datastore item instance which binds the local object to a new
  81    *         document object
  82    */
  83   public abstract LocalDocSyncObject newDocumentObject(); // could make this
  84                                                           // constructor(Lobject)
  85
  86   /**
  87    *
  88    * @return a new datastore item instance which binds the document object to a
  89    *         new local object.
  90    */
  91   public abstract LocalDocSyncObject newLocalObject(); // make this
  92                                                         // constructor(Vobject)
  93
  94   /**
  95    * apply the update/commit logic as defined in the vamsas paper
  96    *
  97    * @param documentIsUpdated
  98    *                true if a document update event is being handled
  99    */
 100   public void synchronize(boolean documentIsUpdated)
 101   {
 102     Object Lobject = getLObject();
 103     Vobject Vobject = getVObject();
 104     if (Lobject == null)
 105     {
 106       // no local binding for document object
 107       newLocalObject().synchronize(documentIsUpdated);
 108       return;
 109     }
 110     if (Vobject == null)
 111     {
 112       // no document binding for local object
 113       newDocumentObject().synchronize(documentIsUpdated);
 114     }
 115     // Check binding is valid
 116     if (getjv2vObj(Lobject) != Vobject)
 117     {
 118       // no local binding for document object
 119       newLocalObject().synchronize(documentIsUpdated);
 120       // no document binding for local object
 121       newDocumentObject().synchronize(documentIsUpdated);
 122     }
 123   }
 124 }