datamodel/compbio/data/sequence/Score.java

   1 package compbio.data.sequence;\r
   2 \r
   3 import java.io.BufferedWriter;\r
   4 import java.io.IOException;\r
   5 import java.io.OutputStream;\r
   6 import java.io.OutputStreamWriter;\r
   7 import java.text.NumberFormat;\r
   8 import java.util.ArrayList;\r
   9 import java.util.Arrays;\r
  10 import java.util.List;\r
  11 import java.util.Locale;\r
  12 import java.util.Set;\r
  13 \r
  14 import javax.xml.bind.annotation.XmlAccessType;\r
  15 import javax.xml.bind.annotation.XmlAccessorType;\r
  16 \r
  17 import compbio.util.annotation.Immutable;\r
  18 \r
  19 /**\r
  20  * A value class for AACon annotation results storage. The objects of this type\r
  21  * are immutable\r
  22  * \r
  23  * @author pvtroshin\r
  24  * \r
  25  */\r
  26 @XmlAccessorType(XmlAccessType.FIELD)\r
  27 @Immutable\r
  28 public class Score {\r
  29 \r
  30         static final NumberFormat NUMBER_FORMAT = NumberFormat\r
  31                         .getNumberInstance(Locale.UK);\r
  32         static {\r
  33                 NUMBER_FORMAT.setGroupingUsed(false);\r
  34                 NUMBER_FORMAT.setMaximumFractionDigits(3);\r
  35         }\r
  36 \r
  37         private ConservationMethod method;\r
  38 \r
  39         private List<Float> scores;\r
  40 \r
  41         private Score() {\r
  42                 // JaXB default constructor\r
  43         }\r
  44 \r
  45         /**\r
  46          * Instantiate the Score\r
  47          * \r
  48          * @param method\r
  49          *            the ConservationMethod with which {@code scores} were\r
  50          *            calculated\r
  51          * @param scores\r
  52          *            the actual conservation values for each column of the\r
  53          *            alignment\r
  54          */\r
  55         public Score(ConservationMethod method, List<Float> scores) {\r
  56                 this.method = method;\r
  57                 this.scores = new ArrayList<Float>(scores);\r
  58         }\r
  59 \r
  60         /**\r
  61          * Returns the ConservationMethod\r
  62          * \r
  63          * @return the ConservationMethod\r
  64          */\r
  65         public ConservationMethod getMethod() {\r
  66                 return method;\r
  67         }\r
  68 \r
  69         /**\r
  70          * The column scores for the alignment\r
  71          * \r
  72          * @return the column scores for the alignment\r
  73          */\r
  74         public List<Float> getScores() {\r
  75                 return scores;\r
  76         }\r
  77 \r
  78         @Override\r
  79         public String toString() {\r
  80                 return "Score [method=" + method + ", scores=" + scores + "]";\r
  81         }\r
  82 \r
  83         @Override\r
  84         public int hashCode() {\r
  85                 final int prime = 31;\r
  86                 int result = 1;\r
  87                 result = prime * result + ((method == null) ? 0 : method.hashCode());\r
  88                 result = prime * result + ((scores == null) ? 0 : scores.hashCode());\r
  89                 return result;\r
  90         }\r
  91 \r
  92         /*\r
  93          * TODO test ! (non-Javadoc)\r
  94          * \r
  95          * @see java.lang.Object#equals(java.lang.Object)\r
  96          */\r
  97         @Override\r
  98         public boolean equals(Object obj) {\r
  99                 if (this == obj)\r
 100                         return true;\r
 101                 if (obj == null)\r
 102                         return false;\r
 103                 if (getClass() != obj.getClass())\r
 104                         return false;\r
 105                 Score other = (Score) obj;\r
 106                 if (method != other.method)\r
 107                         return false;\r
 108                 if (scores == other.scores) {\r
 109                         return true;\r
 110                 }\r
 111                 if (scores == null) {\r
 112                         return false;\r
 113                 }\r
 114                 if (!Arrays.deepEquals(scores.toArray(), other.scores.toArray()))\r
 115                         return false;\r
 116                 return true;\r
 117         }\r
 118 \r
 119         /**\r
 120          * Outputs the List of Score objects into the Output stream. The output\r
 121          * format is as follows:\r
 122          * \r
 123          * <pre>\r
 124          * {@code\r
 125          * #MethodName <space separated list of values>\r
 126          *        \r
 127          * For example:\r
 128          *       \r
 129          * #KABAT 0.2 0.3 0.2 0 0.645 0.333 1 1 0 0\r
 130          * #SMERFS 0.645 0.333 1 1 0 0 0.2 0.3 0.2 0\r
 131          * }\r
 132          * </pre>\r
 133          * \r
 134          * The maximum precision for values is 3 digits, but can be less.\r
 135          * \r
 136          * @param scores\r
 137          *            the list of scores to output\r
 138          * @param output\r
 139          *            the stream to output the data to\r
 140          * @throws IOException\r
 141          *             if the OutputStream cannot be written into\r
 142          * @throws NullPointerException\r
 143          *             if the output stream is null\r
 144          */\r
 145         public static void write(Set<Score> scores, OutputStream output)\r
 146                         throws IOException {\r
 147                 if (output == null) {\r
 148                         throw new NullPointerException("OutputStream must be provided!");\r
 149                 }\r
 150                 BufferedWriter writer = new BufferedWriter(new OutputStreamWriter(\r
 151                                 output));\r
 152                 for (Score score : scores) {\r
 153                         writer.write("#" + score.method + " ");\r
 154                         for (Float scoreVal : score.getScores()) {\r
 155                                 writer.write(NUMBER_FORMAT.format(scoreVal) + " ");\r
 156                         }\r
 157                         writer.write("\n");\r
 158                 }\r
 159                 writer.flush();\r
 160         }\r
 161 }\r