JAL-1912 added documentation
[jalview.git] / src / jalview / io / JSONFile.java
1 /*
2  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
3  * Copyright (C) $$Year-Rel$$ The Jalview Authors
4  * 
5  * This file is part of Jalview.
6  * 
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
10  * of the License, or (at your option) any later version.
11  *  
12  * Jalview is distributed in the hope that it will be useful, but 
13  * WITHOUT ANY WARRANTY; without even the implied warranty 
14  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
15  * PURPOSE.  See the GNU General Public License for more details.
16  * 
17  * You should have received a copy of the GNU General Public License
18  * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
19  * The Jalview Authors are detailed in the 'AUTHORS' file.
20  */
21
22 package jalview.io;
23
24 import jalview.api.AlignExportSettingI;
25 import jalview.api.AlignViewportI;
26 import jalview.api.AlignmentViewPanel;
27 import jalview.api.ComplexAlignFile;
28 import jalview.api.FeatureRenderer;
29 import jalview.api.FeaturesDisplayedI;
30 import jalview.bin.BuildDetails;
31 import jalview.datamodel.AlignmentAnnotation;
32 import jalview.datamodel.AlignmentI;
33 import jalview.datamodel.Annotation;
34 import jalview.datamodel.ColumnSelection;
35 import jalview.datamodel.HiddenSequences;
36 import jalview.datamodel.Sequence;
37 import jalview.datamodel.SequenceFeature;
38 import jalview.datamodel.SequenceGroup;
39 import jalview.datamodel.SequenceI;
40 import jalview.json.binding.biojson.v1.AlignmentAnnotationPojo;
41 import jalview.json.binding.biojson.v1.AlignmentPojo;
42 import jalview.json.binding.biojson.v1.AnnotationDisplaySettingPojo;
43 import jalview.json.binding.biojson.v1.AnnotationPojo;
44 import jalview.json.binding.biojson.v1.ColourSchemeMapper;
45 import jalview.json.binding.biojson.v1.SequenceFeaturesPojo;
46 import jalview.json.binding.biojson.v1.SequenceGrpPojo;
47 import jalview.json.binding.biojson.v1.SequencePojo;
48 import jalview.schemes.ColourSchemeProperty;
49 import jalview.schemes.UserColourScheme;
50 import jalview.viewmodel.seqfeatures.FeaturesDisplayed;
51
52 import java.awt.Color;
53 import java.io.IOException;
54 import java.io.Reader;
55 import java.util.ArrayList;
56 import java.util.Hashtable;
57 import java.util.Iterator;
58 import java.util.List;
59 import java.util.Vector;
60
61 import org.json.simple.JSONArray;
62 import org.json.simple.JSONObject;
63 import org.json.simple.parser.JSONParser;
64
65 public class JSONFile extends AlignFile implements ComplexAlignFile
66 {
67   private static String version = new BuildDetails().getVersion();
68
69   private String webstartUrl = "http://www.jalview.org/services/launchApp";
70
71   private String application = "Jalview";
72
73   public static final String FILE_EXT = "json";
74
75   public static final String FILE_DESC = "JSON";
76
77   private String globalColourScheme;
78
79   private boolean showSeqFeatures;
80
81   private Hashtable<String, Sequence> seqMap;
82
83   private FeaturesDisplayedI displayedFeatures;
84
85   private FeatureRenderer fr;
86
87   private List<int[]> hiddenColumns;
88
89   private ColumnSelection columnSelection;
90
91   private List<String> hiddenSeqRefs;
92
93   private ArrayList<SequenceI> hiddenSequences;
94
95   private final static String TCOFFEE_SCORE = "TCoffeeScore";
96
97   public JSONFile()
98   {
99     super();
100   }
101
102   public JSONFile(FileParse source) throws IOException
103   {
104     super(source);
105   }
106
107   public JSONFile(String inFile, String type) throws IOException
108   {
109     super(inFile, type);
110   }
111
112   @Override
113   public void parse() throws IOException
114   {
115     parse(getReader());
116
117   }
118
119   @Override
120   public String print()
121   {
122     String jsonOutput = null;
123     try
124     {
125       AlignmentPojo jsonAlignmentPojo = new AlignmentPojo();
126       AlignExportSettingI exportSettings = getExportSettings();
127
128       // if no export settings were supplied use the following with all values
129       // defaulting to true
130       if (exportSettings == null)
131       {
132         exportSettings = new AlignExportSettingI()
133         {
134           @Override
135           public boolean isExportHiddenSequences()
136           {
137             return true;
138           }
139
140           @Override
141           public boolean isExportHiddenColumns()
142           {
143             return true;
144           }
145
146           @Override
147           public boolean isExportGroups()
148           {
149             return true;
150           }
151
152           @Override
153           public boolean isExportFeatures()
154           {
155             return true;
156           }
157
158           @Override
159           public boolean isExportAnnotations()
160           {
161             return true;
162           }
163
164           @Override
165           public boolean isCancelled()
166           {
167             return false;
168           }
169         };
170       }
171
172       int count = 0;
173       for (SequenceI seq : seqs)
174       {
175         StringBuilder name = new StringBuilder();
176         name.append(seq.getName()).append("/").append(seq.getStart())
177                 .append("-").append(seq.getEnd());
178         SequencePojo jsonSeqPojo = new SequencePojo();
179         jsonSeqPojo.setId(String.valueOf(seq.hashCode()));
180         jsonSeqPojo.setOrder(++count);
181         jsonSeqPojo.setEnd(seq.getEnd());
182         jsonSeqPojo.setStart(seq.getStart());
183         jsonSeqPojo.setName(name.toString());
184         jsonSeqPojo.setSeq(seq.getSequenceAsString());
185         jsonAlignmentPojo.getSeqs().add(jsonSeqPojo);
186       }
187       jsonAlignmentPojo.setGlobalColorScheme(globalColourScheme);
188       jsonAlignmentPojo.getAppSettings().put("application", application);
189       jsonAlignmentPojo.getAppSettings().put("version", version);
190       jsonAlignmentPojo.getAppSettings().put("webStartUrl", webstartUrl);
191       jsonAlignmentPojo.getAppSettings().put("showSeqFeatures",
192               String.valueOf(showSeqFeatures));
193
194       String[] hiddenSections = getHiddenSections();
195       if (hiddenSections != null)
196       {
197         if (hiddenSections[0] != null
198                 && exportSettings.isExportHiddenColumns())
199         {
200           jsonAlignmentPojo.getAppSettings().put("hiddenCols",
201                   String.valueOf(hiddenSections[0]));
202         }
203         if (hiddenSections[1] != null
204                 && exportSettings.isExportHiddenSequences())
205         {
206           jsonAlignmentPojo.getAppSettings().put("hiddenSeqs",
207                   String.valueOf(hiddenSections[1]));
208         }
209       }
210
211       if (exportSettings.isExportAnnotations())
212       {
213         jsonAlignmentPojo
214                 .setAlignAnnotation(annotationToJsonPojo(annotations));
215       }
216       else
217       {
218         // These color schemes require annotation, disable them if annotations
219         // are not exported
220         if (globalColourScheme.equalsIgnoreCase("RNA Helices")
221                 || globalColourScheme.equalsIgnoreCase("T-COFFEE SCORES"))
222         {
223           jsonAlignmentPojo.setGlobalColorScheme("None");
224         }
225       }
226
227       if (exportSettings.isExportFeatures())
228       {
229         jsonAlignmentPojo
230                 .setSeqFeatures(sequenceFeatureToJsonPojo(seqs, fr));
231       }
232
233       if (exportSettings.isExportGroups() && seqGroups != null
234               && seqGroups.size() > 0)
235       {
236         for (SequenceGroup seqGrp : seqGroups)
237         {
238           SequenceGrpPojo seqGrpPojo = new SequenceGrpPojo();
239           seqGrpPojo.setGroupName(seqGrp.getName());
240           seqGrpPojo.setColourScheme(ColourSchemeProperty
241                   .getColourName(seqGrp.cs));
242           seqGrpPojo.setColourText(seqGrp.getColourText());
243           seqGrpPojo.setDescription(seqGrp.getDescription());
244           seqGrpPojo.setDisplayBoxes(seqGrp.getDisplayBoxes());
245           seqGrpPojo.setDisplayText(seqGrp.getDisplayText());
246           seqGrpPojo.setEndRes(seqGrp.getEndRes());
247           seqGrpPojo.setStartRes(seqGrp.getStartRes());
248           seqGrpPojo.setShowNonconserved(seqGrp.getShowNonconserved());
249           for (SequenceI seq : seqGrp.getSequences())
250           {
251             seqGrpPojo.getSequenceRefs()
252                     .add(String.valueOf(seq.hashCode()));
253           }
254           jsonAlignmentPojo.getSeqGroups().add(seqGrpPojo);
255         }
256       }
257       org.json.JSONObject generatedJSon = new org.json.JSONObject(
258               jsonAlignmentPojo);
259       jsonOutput = generatedJSon.toString();
260       return jsonOutput.replaceAll("xstart", "xStart").replaceAll("xend",
261               "xEnd");
262     } catch (Exception e)
263     {
264       e.printStackTrace();
265     }
266     return jsonOutput;
267   }
268
269   public String[] getHiddenSections()
270   {
271     String[] hiddenSections = new String[2];
272     if (getViewport() == null)
273     {
274       return null;
275     }
276
277     // hidden column business
278     if (getViewport().hasHiddenColumns())
279     {
280       List<int[]> hiddenCols = getViewport().getColumnSelection()
281               .getHiddenColumns();
282       StringBuilder hiddenColsBuilder = new StringBuilder();
283       for (int[] range : hiddenCols)
284       {
285         hiddenColsBuilder.append(";").append(range[0]).append("-")
286                 .append(range[1]);
287       }
288
289       hiddenColsBuilder.deleteCharAt(0);
290       hiddenSections[0] = hiddenColsBuilder.toString();
291     }
292
293     // hidden rows/seqs business
294     HiddenSequences hiddenSeqsObj = getViewport().getAlignment()
295             .getHiddenSequences();
296     if (hiddenSeqsObj == null || hiddenSeqsObj.hiddenSequences == null)
297     {
298       return hiddenSections;
299     }
300
301     SequenceI[] hiddenSeqs = hiddenSeqsObj.hiddenSequences;
302     StringBuilder hiddenSeqsBuilder = new StringBuilder();
303     for (SequenceI hiddenSeq : hiddenSeqs)
304     {
305       if (hiddenSeq != null)
306       {
307         hiddenSeqsBuilder.append(";").append(hiddenSeq.hashCode());
308       }
309     }
310     if (hiddenSeqsBuilder.length() > 0)
311     {
312       hiddenSeqsBuilder.deleteCharAt(0);
313     }
314     hiddenSections[1] = hiddenSeqsBuilder.toString();
315
316     return hiddenSections;
317   }
318
319   public List<SequenceFeaturesPojo> sequenceFeatureToJsonPojo(
320           List<SequenceI> seqs, FeatureRenderer fr)
321   {
322     displayedFeatures = (fr == null) ? null : fr.getFeaturesDisplayed();
323     List<SequenceFeaturesPojo> sequenceFeaturesPojo = new ArrayList<SequenceFeaturesPojo>();
324     for (SequenceI seq : seqs)
325     {
326       SequenceI dataSetSequence = seq.getDatasetSequence();
327       SequenceFeature[] seqFeatures = (dataSetSequence == null) ? null
328               : seq.getDatasetSequence().getSequenceFeatures();
329
330       seqFeatures = (seqFeatures == null) ? seq.getSequenceFeatures()
331               : seqFeatures;
332       if (seqFeatures == null)
333       {
334         continue;
335       }
336
337       for (SequenceFeature sf : seqFeatures)
338       {
339         if (displayedFeatures != null
340                 && displayedFeatures.isVisible(sf.getType()))
341         {
342           SequenceFeaturesPojo jsonFeature = new SequenceFeaturesPojo(
343                   String.valueOf(seq.hashCode()));
344
345           String featureColour = (fr == null) ? null : jalview.util.Format
346                   .getHexString(fr.findFeatureColour(Color.white, seq,
347                           seq.findIndex(sf.getBegin())));
348           jsonFeature.setXstart(seq.findIndex(sf.getBegin()) - 1);
349           jsonFeature.setXend(seq.findIndex(sf.getEnd()));
350           jsonFeature.setType(sf.getType());
351           jsonFeature.setDescription(sf.getDescription());
352           jsonFeature.setLinks(sf.links);
353           jsonFeature.setOtherDetails(sf.otherDetails);
354           jsonFeature.setScore(sf.getScore());
355           jsonFeature.setFillColor(featureColour);
356           jsonFeature.setFeatureGroup(sf.getFeatureGroup());
357           sequenceFeaturesPojo.add(jsonFeature);
358         }
359       }
360     }
361     return sequenceFeaturesPojo;
362   }
363
364   public static List<AlignmentAnnotationPojo> annotationToJsonPojo(
365           Vector<AlignmentAnnotation> annotations)
366   {
367     List<AlignmentAnnotationPojo> jsonAnnotations = new ArrayList<AlignmentAnnotationPojo>();
368     if (annotations == null)
369     {
370       return jsonAnnotations;
371     }
372     for (AlignmentAnnotation annot : annotations)
373     {
374       AlignmentAnnotationPojo alignAnnotPojo = new AlignmentAnnotationPojo();
375       alignAnnotPojo.setDescription(annot.description);
376       alignAnnotPojo.setLabel(annot.label);
377       if (!Double.isNaN(annot.score))
378       {
379         alignAnnotPojo.setScore(annot.score);
380       }
381       alignAnnotPojo.setCalcId(annot.getCalcId());
382       alignAnnotPojo.setGraphType(annot.graph);
383
384       AnnotationDisplaySettingPojo annotSetting = new AnnotationDisplaySettingPojo();
385       annotSetting.setBelowAlignment(annot.belowAlignment);
386       annotSetting.setCentreColLabels(annot.centreColLabels);
387       annotSetting.setScaleColLabel(annot.scaleColLabel);
388       annotSetting.setShowAllColLabels(annot.showAllColLabels);
389       annotSetting.setVisible(annot.visible);
390       annotSetting.setHasIcon(annot.hasIcons);
391       alignAnnotPojo.setAnnotationSettings(annotSetting);
392       SequenceI refSeq = annot.sequenceRef;
393       if (refSeq != null)
394       {
395         alignAnnotPojo.setSequenceRef(String.valueOf(refSeq.hashCode()));
396       }
397       for (Annotation annotation : annot.annotations)
398       {
399         AnnotationPojo annotationPojo = new AnnotationPojo();
400         if (annotation != null)
401         {
402           annotationPojo.setDescription(annotation.description);
403           annotationPojo.setValue(annotation.value);
404           annotationPojo
405                   .setSecondaryStructure(annotation.secondaryStructure);
406           String displayChar = annotation.displayCharacter == null ? null
407                   : annotation.displayCharacter;
408           // System.out.println("--------------------->[" + displayChar + "]");
409           annotationPojo.setDisplayCharacter(displayChar);
410           if (annotation.colour != null)
411           {
412             annotationPojo.setColour(jalview.util.Format
413                     .getHexString(annotation.colour));
414           }
415           alignAnnotPojo.getAnnotations().add(annotationPojo);
416         }
417         else
418         {
419           if (annot.getCalcId() != null
420                   && annot.getCalcId().equalsIgnoreCase(TCOFFEE_SCORE))
421           {
422             // do nothing
423           }
424           else
425           {
426             alignAnnotPojo.getAnnotations().add(annotationPojo);
427           }
428         }
429       }
430       jsonAnnotations.add(alignAnnotPojo);
431     }
432     return jsonAnnotations;
433   }
434
435   @SuppressWarnings("unchecked")
436   public JSONFile parse(Reader jsonAlignmentString)
437   {
438     try
439     {
440       JSONParser jsonParser = new JSONParser();
441       JSONObject alignmentJsonObj = (JSONObject) jsonParser
442               .parse(jsonAlignmentString);
443       JSONArray seqJsonArray = (JSONArray) alignmentJsonObj.get("seqs");
444       JSONArray alAnnotJsonArray = (JSONArray) alignmentJsonObj
445               .get("alignAnnotation");
446       JSONArray jsonSeqArray = (JSONArray) alignmentJsonObj
447               .get("seqFeatures");
448       JSONArray seqGrpJsonArray = (JSONArray) alignmentJsonObj
449               .get("seqGroups");
450       JSONObject jvSettingsJsonObj = (JSONObject) alignmentJsonObj
451               .get("appSettings");
452
453       if (jvSettingsJsonObj != null)
454       {
455         globalColourScheme = (String) jvSettingsJsonObj
456                 .get("globalColorScheme");
457         Boolean showFeatures = Boolean.valueOf(jvSettingsJsonObj.get(
458                 "showSeqFeatures").toString());
459         setShowSeqFeatures(showFeatures);
460         parseHiddenSeqRefsAsList(jvSettingsJsonObj);
461         parseHiddenCols(jvSettingsJsonObj);
462       }
463
464       hiddenSequences = new ArrayList<SequenceI>();
465       seqMap = new Hashtable<String, Sequence>();
466       for (Iterator<JSONObject> sequenceIter = seqJsonArray.iterator(); sequenceIter
467               .hasNext();)
468       {
469         JSONObject sequence = sequenceIter.next();
470         String sequcenceString = sequence.get("seq").toString();
471         String sequenceName = sequence.get("name").toString();
472         String seqUniqueId = sequence.get("id").toString();
473         int start = Integer.valueOf(sequence.get("start").toString());
474         int end = Integer.valueOf(sequence.get("end").toString());
475         Sequence seq = new Sequence(sequenceName, sequcenceString, start,
476                 end);
477         if (hiddenSeqRefs != null && hiddenSeqRefs.contains(seqUniqueId))
478         {
479           hiddenSequences.add(seq);
480         }
481         seqs.add(seq);
482         seqMap.put(seqUniqueId, seq);
483       }
484
485
486       parseFeatures(jsonSeqArray);
487
488       for (Iterator<JSONObject> seqGrpIter = seqGrpJsonArray.iterator(); seqGrpIter
489               .hasNext();)
490       {
491         JSONObject seqGrpObj = seqGrpIter.next();
492         String grpName = seqGrpObj.get("groupName").toString();
493         String colourScheme = seqGrpObj.get("colourScheme").toString();
494         String description = (seqGrpObj.get("description") == null) ? null
495                 : seqGrpObj.get("description").toString();
496         boolean displayBoxes = Boolean.valueOf(seqGrpObj
497                 .get("displayBoxes").toString());
498         boolean displayText = Boolean.valueOf(seqGrpObj.get("displayText")
499                 .toString());
500         boolean colourText = Boolean.valueOf(seqGrpObj.get("colourText")
501                 .toString());
502         boolean showNonconserved = Boolean.valueOf(seqGrpObj.get(
503                 "showNonconserved").toString());
504         int startRes = Integer
505                 .valueOf(seqGrpObj.get("startRes").toString());
506         int endRes = Integer.valueOf(seqGrpObj.get("endRes").toString());
507         JSONArray sequenceRefs = (JSONArray) seqGrpObj.get("sequenceRefs");
508
509         ArrayList<SequenceI> grpSeqs = new ArrayList<SequenceI>();
510         if (sequenceRefs.size() > 0)
511         {
512           Iterator<String> seqHashIter = sequenceRefs.iterator();
513           while (seqHashIter.hasNext())
514           {
515             String seqHash = seqHashIter.next();
516             Sequence sequence = seqMap.get(seqHash);
517             if (sequence != null)
518             {
519               grpSeqs.add(sequence);
520             }
521           }
522         }
523         SequenceGroup seqGrp = new SequenceGroup(grpSeqs, grpName, null,
524                 displayBoxes, displayText, colourText,
525                 startRes, endRes);
526         seqGrp.cs = ColourSchemeMapper.getJalviewColourScheme(colourScheme,
527                 seqGrp);
528         seqGrp.setShowNonconserved(showNonconserved);
529         seqGrp.setDescription(description);
530         this.seqGroups.add(seqGrp);
531
532       }
533
534       for (Iterator<JSONObject> alAnnotIter = alAnnotJsonArray.iterator(); alAnnotIter
535               .hasNext();)
536       {
537         JSONObject alAnnot = alAnnotIter.next();
538         JSONArray annotJsonArray = (JSONArray) alAnnot.get("annotations");
539         Annotation[] annotations = new Annotation[annotJsonArray.size()];
540         int count = 0;
541         for (Iterator<JSONObject> annotIter = annotJsonArray.iterator(); annotIter
542                 .hasNext();)
543         {
544           JSONObject annot = annotIter.next();
545           if (annot == null)
546           {
547             annotations[count] = null;
548           }
549           else
550           {
551             float val = annot.get("value") == null ? null : Float
552                     .valueOf(annot.get("value").toString());
553             String desc = annot.get("description") == null ? null : annot
554                     .get("description").toString();
555             char ss = annot.get("secondaryStructure") == null
556                     || annot.get("secondaryStructure").toString()
557                             .equalsIgnoreCase("u0000") ? ' ' : annot
558                     .get("secondaryStructure").toString().charAt(0);
559             String displayChar = annot.get("displayCharacter") == null ? ""
560                     : annot.get("displayCharacter").toString();
561
562             annotations[count] = new Annotation(displayChar, desc, ss, val);
563             if (annot.get("colour") != null)
564             {
565               Color color = UserColourScheme.getColourFromString(annot.get(
566                       "colour").toString());
567               annotations[count].colour = color;
568             }
569           }
570           ++count;
571         }
572
573         AlignmentAnnotation alignAnnot = new AlignmentAnnotation(alAnnot
574                 .get("label").toString(), alAnnot.get("description")
575                 .toString(), annotations);
576         alignAnnot.graph = (alAnnot.get("graphType") == null) ? 0 : Integer
577                 .valueOf(alAnnot.get("graphType")
578                         .toString());
579
580         JSONObject diplaySettings = (JSONObject) alAnnot
581                 .get("annotationSettings");
582         if (diplaySettings != null)
583         {
584
585           alignAnnot.scaleColLabel = (diplaySettings.get("scaleColLabel") == null) ? false
586                   : Boolean.valueOf(diplaySettings.get("scaleColLabel")
587                           .toString());
588           alignAnnot.showAllColLabels = (diplaySettings
589                   .get("showAllColLabels") == null) ? true : Boolean
590                   .valueOf(diplaySettings.get("showAllColLabels")
591                           .toString());
592           alignAnnot.centreColLabels = (diplaySettings
593                   .get("centreColLabels") == null) ? true
594                   : Boolean.valueOf(diplaySettings.get("centreColLabels")
595                           .toString());
596           alignAnnot.belowAlignment = (diplaySettings.get("belowAlignment") == null) ? false
597                   : Boolean.valueOf(diplaySettings.get("belowAlignment")
598                           .toString());
599           alignAnnot.visible = (diplaySettings.get("visible") == null) ? true
600                   : Boolean.valueOf(diplaySettings.get("visible")
601                           .toString());
602           alignAnnot.hasIcons = (diplaySettings.get("hasIcon") == null) ? true
603                   : Boolean.valueOf(diplaySettings.get("hasIcon")
604                           .toString());
605
606         }
607         if (alAnnot.get("score") != null)
608         {
609           alignAnnot.score = Double
610                   .valueOf(alAnnot.get("score").toString());
611         }
612
613         String calcId = (alAnnot.get("calcId") == null) ? "" : alAnnot.get(
614                 "calcId").toString();
615         alignAnnot.setCalcId(calcId);
616         String seqHash = (alAnnot.get("sequenceRef") != null) ? alAnnot
617                 .get("sequenceRef").toString() : null;
618
619         Sequence sequence = (seqHash != null) ? seqMap.get(seqHash) : null;
620         if (sequence != null)
621         {
622           alignAnnot.sequenceRef = sequence;
623           sequence.addAlignmentAnnotation(alignAnnot);
624           if (alignAnnot.label.equalsIgnoreCase("T-COFFEE"))
625           {
626             alignAnnot.createSequenceMapping(sequence, sequence.getStart(),
627                     false);
628             sequence.addAlignmentAnnotation(alignAnnot);
629             alignAnnot.adjustForAlignment();
630           }
631         }
632         alignAnnot.validateRangeAndDisplay();
633         this.annotations.add(alignAnnot);
634
635       }
636     } catch (Exception e)
637     {
638       e.printStackTrace();
639     }
640     return this;
641   }
642
643   public void parseHiddenSeqRefsAsList(JSONObject jvSettingsJson)
644   {
645     hiddenSeqRefs = new ArrayList<String>();
646     String hiddenSeqs = (String) jvSettingsJson.get("hiddenSeqs");
647     if (hiddenSeqs != null && !hiddenSeqs.isEmpty())
648     {
649       String[] seqRefs = hiddenSeqs.split(";");
650       for (String seqRef : seqRefs)
651       {
652         hiddenSeqRefs.add(seqRef);
653       }
654     }
655   }
656
657   public void parseHiddenCols(JSONObject jvSettingsJson)
658   {
659     String hiddenCols = (String) jvSettingsJson.get("hiddenCols");
660     if (hiddenCols != null && !hiddenCols.isEmpty())
661     {
662       columnSelection = new ColumnSelection();
663       String[] rangeStrings = hiddenCols.split(";");
664       for (String rangeString : rangeStrings)
665       {
666         String[] range = rangeString.split("-");
667         columnSelection.hideColumns(Integer.valueOf(range[0]),
668                 Integer.valueOf(range[1]));
669       }
670     }
671   }
672
673   @SuppressWarnings("unchecked")
674   private void parseFeatures(JSONArray jsonSeqFeatures)
675   {
676     if (jsonSeqFeatures != null)
677     {
678       displayedFeatures = new FeaturesDisplayed();
679       for (Iterator<JSONObject> seqFeatureItr = jsonSeqFeatures.iterator(); seqFeatureItr
680               .hasNext();)
681       {
682         JSONObject jsonFeature = seqFeatureItr.next();
683         Long begin = (Long) jsonFeature.get("xStart");
684         Long end = (Long) jsonFeature.get("xEnd");
685         String type = (String) jsonFeature.get("type");
686         String featureGrp = (String) jsonFeature.get("featureGroup");
687         String descripiton = (String) jsonFeature.get("description");
688         String seqRef = (String) jsonFeature.get("sequenceRef");
689         Float score = Float.valueOf(jsonFeature.get("score").toString());
690
691         Sequence seq = seqMap.get(seqRef);
692         SequenceFeature sequenceFeature = new SequenceFeature();
693         JSONArray linksJsonArray = (JSONArray) jsonFeature.get("links");
694         if (linksJsonArray != null && linksJsonArray.size() > 0)
695         {
696           Iterator<String> linkList = linksJsonArray.iterator();
697           while (linkList.hasNext())
698           {
699             String link = linkList.next();
700             sequenceFeature.addLink(link);
701           }
702         }
703         sequenceFeature.setFeatureGroup(featureGrp);
704         sequenceFeature.setScore(score);
705         sequenceFeature.setDescription(descripiton);
706         sequenceFeature.setType(type);
707         sequenceFeature.setBegin(seq.findPosition(begin.intValue()));
708         sequenceFeature.setEnd(seq.findPosition(end.intValue()) - 1);
709         seq.addSequenceFeature(sequenceFeature);
710         displayedFeatures.setVisible(type);
711       }
712     }
713   }
714
715   public String getGlobalColourScheme()
716   {
717     return globalColourScheme;
718   }
719
720   public void setGlobalColorScheme(String globalColourScheme)
721   {
722     this.globalColourScheme = globalColourScheme;
723   }
724
725   @Override
726   public FeaturesDisplayedI getDisplayedFeatures()
727   {
728     return displayedFeatures;
729   }
730
731   public void setDisplayedFeatures(FeaturesDisplayedI displayedFeatures)
732   {
733     this.displayedFeatures = displayedFeatures;
734   }
735
736   public void configureForView(AlignmentViewPanel avpanel)
737   {
738     super.configureForView(avpanel);
739     AlignViewportI viewport = avpanel.getAlignViewport();
740     AlignmentI alignment = viewport.getAlignment();
741     AlignmentAnnotation[] annots = alignment.getAlignmentAnnotation();
742
743     seqGroups = alignment.getGroups();
744     fr = avpanel.cloneFeatureRenderer();
745
746     // Add non auto calculated annotation to AlignFile
747     for (AlignmentAnnotation annot : annots)
748     {
749       if (annot != null && !annot.autoCalculated)
750       {
751         annotations.add(annot);
752       }
753     }
754     globalColourScheme = ColourSchemeProperty.getColourName(viewport
755             .getGlobalColourScheme());
756     setDisplayedFeatures(viewport.getFeaturesDisplayed());
757     showSeqFeatures = viewport.isShowSequenceFeatures();
758
759   }
760
761   public boolean isShowSeqFeatures()
762   {
763     return showSeqFeatures;
764   }
765
766   public void setShowSeqFeatures(boolean showSeqFeatures)
767   {
768     this.showSeqFeatures = showSeqFeatures;
769   }
770
771   public Vector<AlignmentAnnotation> getAnnotations()
772   {
773     return annotations;
774   }
775
776   public List<int[]> getHiddenColumns()
777   {
778     return hiddenColumns;
779   }
780
781   public ColumnSelection getColumnSelection()
782   {
783     return columnSelection;
784   }
785
786   public void setColumnSelection(ColumnSelection columnSelection)
787   {
788     this.columnSelection = columnSelection;
789   }
790
791   public SequenceI[] getHiddenSequences()
792   {
793     if (hiddenSequences == null || hiddenSequences.isEmpty())
794     {
795       return new SequenceI[] {};
796     }
797     synchronized (hiddenSequences)
798     {
799       return hiddenSequences.toArray(new SequenceI[hiddenSequences.size()]);
800     }
801   }
802
803   public void setHiddenSequences(ArrayList<SequenceI> hiddenSequences)
804   {
805     this.hiddenSequences = hiddenSequences;
806   }
807
808   public class JSONExportSettings
809   {
810     private boolean exportSequence;
811
812     private boolean exportSequenceFeatures;
813
814     private boolean exportAnnotations;
815
816     private boolean exportGroups;
817
818     private boolean exportJalviewSettings;
819
820     public boolean isExportSequence()
821     {
822       return exportSequence;
823     }
824
825     public void setExportSequence(boolean exportSequence)
826     {
827       this.exportSequence = exportSequence;
828     }
829
830     public boolean isExportSequenceFeatures()
831     {
832       return exportSequenceFeatures;
833     }
834
835     public void setExportSequenceFeatures(boolean exportSequenceFeatures)
836     {
837       this.exportSequenceFeatures = exportSequenceFeatures;
838     }
839
840     public boolean isExportAnnotations()
841     {
842       return exportAnnotations;
843     }
844
845     public void setExportAnnotations(boolean exportAnnotations)
846     {
847       this.exportAnnotations = exportAnnotations;
848     }
849
850     public boolean isExportGroups()
851     {
852       return exportGroups;
853     }
854
855     public void setExportGroups(boolean exportGroups)
856     {
857       this.exportGroups = exportGroups;
858     }
859
860     public boolean isExportJalviewSettings()
861     {
862       return exportJalviewSettings;
863     }
864
865     public void setExportJalviewSettings(boolean exportJalviewSettings)
866     {
867       this.exportJalviewSettings = exportJalviewSettings;
868     }
869   }
870 }