Add comments to bean internal data

[proteocache.git] / datadb / compbio / beans / ProteinBean.java

diff --git a/datadb/compbio/beans/ProteinBean.java b/datadb/compbio/beans/ProteinBean.java
index 958eab5..8c7c446 100644 (file)
--- a/datadb/compbio/beans/ProteinBean.java
+++ b/datadb/compbio/beans/ProteinBean.java
@@ -7,14 +7,22 @@ import java.util.Map;
 
 import compbio.cassandra.PredictionIndex;
 
+/**
+ * POJO bean with information on a protein
+ * 
+ * @author Natasha Sherstneva
+ * 
+ * @version 1.0
+ * @since Jan 2014
+ */
 public class ProteinBean implements PredictionIndex {
-       private String sequence;
-       private String jnetpred;
-       private List<String> jobid;
-       private LinkedHashMap<String, String> predictions;
-       private List<String> subProt; // protein sequence divided by several parts
-                                                                       // for highlighting the particular part
-       private int size;
+       private String sequence; // protein sequence
+       private String jnetpred; // the main Jpred prediction sequence
+       private List<String> jobid;  // job IDd: all jobs with the protein
+       private LinkedHashMap<String, String> predictions; // predictions: Key - prediction ID, Value - prediction sequence
+       private List<String> subProt; // protein sequence divided in several parts
+                                                                       // for highlighting a particular part
+       private int size; // a number of predictions for the protein
 
        public ProteinBean(String seq, Map<String, String> pred) {
                this.sequence = seq;