structure ids are not IDs, but simply references

[jalview.git] / src / jalview / schemabinding / version2 / StructureState.java

diff --git a/src/jalview/schemabinding/version2/StructureState.java b/src/jalview/schemabinding/version2/StructureState.java
index 6f43108..24eed77 100644 (file)
--- a/src/jalview/schemabinding/version2/StructureState.java
+++ b/src/jalview/schemabinding/version2/StructureState.java
@@ -82,7 +82,14 @@ public class StructureState implements java.io.Serializable {
     private boolean _has_height;
 
     /**
-     * Field _viewId.
+     * additional identifier which properly disambiguates
+     *  the structure view from any other view with the same
+     * attributes. This is not an ID,
+     *  because it is possible to have many references to the same
+     * physical structure view
+     *  from different sequences in an alignment. A structureState
+     * element citing the same
+     *  viewId will appear for each instance.
      */
     private java.lang.String _viewId;
 
@@ -158,7 +165,16 @@ public class StructureState implements java.io.Serializable {
     }
 
     /**
-     * Returns the value of field 'viewId'.
+     * Returns the value of field 'viewId'. The field 'viewId' has
+     * the following description: additional identifier which
+     * properly disambiguates
+     *  the structure view from any other view with the same
+     * attributes. This is not an ID,
+     *  because it is possible to have many references to the same
+     * physical structure view
+     *  from different sequences in an alignment. A structureState
+     * element citing the same
+     *  viewId will appear for each instance.
      * 
      * @return the value of field 'ViewId'.
      */
@@ -337,7 +353,16 @@ public class StructureState implements java.io.Serializable {
     }
 
     /**
-     * Sets the value of field 'viewId'.
+     * Sets the value of field 'viewId'. The field 'viewId' has the
+     * following description: additional identifier which properly
+     * disambiguates
+     *  the structure view from any other view with the same
+     * attributes. This is not an ID,
+     *  because it is possible to have many references to the same
+     * physical structure view
+     *  from different sequences in an alignment. A structureState
+     * element citing the same
+     *  viewId will appear for each instance.
      * 
      * @param viewId the value of field 'viewId'.
      */