2 * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.1)
3 * Copyright (C) 2014 The Jalview Authors
5 * This file is part of Jalview.
7 * Jalview is free software: you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License
9 * as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
11 * Jalview is distributed in the hope that it will be useful, but
12 * WITHOUT ANY WARRANTY; without even the implied warranty
13 * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
14 * PURPOSE. See the GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License along with Jalview. If not, see <http://www.gnu.org/licenses/>.
17 * The Jalview Authors are detailed in the 'AUTHORS' file.
19 package jalview.io.vamsas;
21 import uk.ac.vamsas.client.Vobject;
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
26 * implemented in DatastoreItem, but probably more tedious to implement. ..
31 public abstract class LocalDocSyncObject extends DatastoreItem
35 * @return null or the local object that is being worked on.
37 public abstract Object getLObject();
41 * @return null or the document object that is being worked on
43 public abstract Vobject getVObject();
46 * endpoint for synchronize when all opreations are finished.
48 public abstract void nextObject();
51 * called if the local object can be safely updated from the bound document
52 * object. public abstract void updateToDoc();
56 * called if the associated document object can be safely updated with the
57 * local changes public abstract void updateToDoc();
61 * @return true if the local object is modified
63 public abstract boolean locallyModified();
67 * @return true if the bound document object is modified
69 public abstract boolean documentModified();
73 * @return true if the document object is locked w.r.t. this object's update.
75 public abstract boolean documentObjectLocked();
79 * @return a new datastore item instance which binds the local object to a new
82 public abstract LocalDocSyncObject newDocumentObject(); // could make this
84 // constructor(Lobject)
88 * @return a new datastore item instance which binds the document object to a
91 public abstract LocalDocSyncObject newLocalObject(); // make this
93 // constructor(Vobject)
96 * apply the update/commit logic as defined in the vamsas paper
98 * @param documentIsUpdated
99 * true if a document update event is being handled
101 public void synchronize(boolean documentIsUpdated)
103 Object Lobject = getLObject();
104 Vobject Vobject = getVObject();
107 // no local binding for document object
108 newLocalObject().synchronize(documentIsUpdated);
113 // no document binding for local object
114 newDocumentObject().synchronize(documentIsUpdated);
116 // Check binding is valid
117 if (getjv2vObj(Lobject) != Vobject)
119 // no local binding for document object
120 newLocalObject().synchronize(documentIsUpdated);
121 // no document binding for local object
122 newDocumentObject().synchronize(documentIsUpdated);