2 * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
3 * Copyright (C) $$Year-Rel$$ 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
10 * of the License, or (at your option) any later version.
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.
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.
24 import java.awt.Color;
25 import java.io.IOException;
26 import java.util.ArrayList;
27 import java.util.Hashtable;
28 import java.util.Iterator;
29 import java.util.List;
30 import java.util.Vector;
32 import org.json.simple.JSONArray;
33 import org.json.simple.JSONObject;
34 import org.json.simple.parser.JSONParser;
36 import jalview.api.AlignViewportI;
37 import jalview.api.ComplexAlignFile;
38 import jalview.api.FeatureRenderer;
39 import jalview.api.FeaturesDisplayedI;
40 import jalview.datamodel.AlignmentAnnotation;
41 import jalview.datamodel.Annotation;
42 import jalview.datamodel.ColumnSelection;
43 import jalview.datamodel.HiddenSequences;
44 import jalview.datamodel.Sequence;
45 import jalview.datamodel.SequenceFeature;
46 import jalview.datamodel.SequenceGroup;
47 import jalview.datamodel.SequenceI;
48 import jalview.json.binding.v1.AlignmentAnnotationPojo;
49 import jalview.json.binding.v1.AlignmentPojo;
50 import jalview.json.binding.v1.AlignmentPojo.JalviewBioJsColorSchemeMapper;
51 import jalview.json.binding.v1.AnnotationPojo;
52 import jalview.json.binding.v1.SequenceFeaturesPojo;
53 import jalview.json.binding.v1.SequenceGrpPojo;
54 import jalview.json.binding.v1.SequencePojo;
55 import jalview.schemes.ColourSchemeI;
56 import jalview.schemes.ColourSchemeProperty;
58 public class JSONFile extends AlignFile implements ComplexAlignFile
60 private ColourSchemeI colourScheme;
62 private String version = "2.9";
64 private String webstartUrl = "www.jalview.org/services/launchApp";
66 private String application = "Jalview";
68 public static final String FILE_EXT = "json";
70 public static final String FILE_DESC = "JSON";
72 private String globalColorScheme;
74 private boolean showSeqFeatures;
76 private Hashtable<String, Sequence> seqMap;
78 private FeaturesDisplayedI displayedFeatures;
80 private FeatureRenderer fr;
82 private List<int[]> hiddenColumns;
84 private ColumnSelection columnSelection;
86 private List<String> hiddenSeqRefs;
88 private ArrayList<SequenceI> hiddenSequences;
95 public JSONFile(FileParse source) throws IOException
100 public JSONFile(String inFile, String type) throws IOException
106 public void parse() throws IOException
108 StringBuilder jsonStringBuilder = new StringBuilder();
110 while ((currentLine = nextLine()) != null)
112 jsonStringBuilder.append(currentLine);
114 parse(jsonStringBuilder.toString());
119 public String print()
121 String jsonOutput = null;
124 AlignmentPojo jsonAlignmentPojo = new AlignmentPojo();
125 if (getViewport() != null)
127 globalColorScheme = ColourSchemeProperty
128 .getColourName(getViewport()
129 .getGlobalColourScheme());
130 setDisplayedFeatures(getViewport().getFeaturesDisplayed());
131 showSeqFeatures = getViewport().isShowSequenceFeatures();
132 fr = getViewport().getFeatureRenderer();
136 for (SequenceI seq : seqs)
138 StringBuilder name = new StringBuilder();
139 name.append(seq.getName()).append("/").append(seq.getStart())
140 .append("-").append(seq.getEnd());
141 SequencePojo jsonSeqPojo = new SequencePojo();
142 jsonSeqPojo.setId(String.valueOf(seq.hashCode()));
143 jsonSeqPojo.setOrder(++count);
144 jsonSeqPojo.setEnd(seq.getEnd());
145 jsonSeqPojo.setStart(seq.getStart());
146 jsonSeqPojo.setName(name.toString());
147 jsonSeqPojo.setSeq(seq.getSequenceAsString());
148 jsonAlignmentPojo.getSeqs().add(jsonSeqPojo);
151 jsonAlignmentPojo.setGlobalColorScheme(globalColorScheme);
152 jsonAlignmentPojo.getAppSettings().put("application", application);
153 jsonAlignmentPojo.getAppSettings().put("version", version);
154 jsonAlignmentPojo.getAppSettings().put("webStartUrl", webstartUrl);
155 jsonAlignmentPojo.getAppSettings().put("showSeqFeatures",
156 String.valueOf(showSeqFeatures));
158 String[] hiddenSections = getHiddenSections();
159 if (hiddenSections != null)
161 if (hiddenSections[0] != null
162 && getViewport().getExportSettings()
163 .isExportHiddenColumns())
165 jsonAlignmentPojo.getAppSettings().put("hiddenCols",
166 String.valueOf(hiddenSections[0]));
168 if (hiddenSections[1] != null
169 && getViewport().getExportSettings()
170 .isExportHiddenSequences())
172 jsonAlignmentPojo.getAppSettings().put("hiddenSeqs",
173 String.valueOf(hiddenSections[1]));
177 if (getViewport().getExportSettings().isExportAnnotations())
180 .setAlignAnnotation(annotationToJsonPojo(annotations));
183 if (getViewport().getExportSettings().isExportFeatures())
186 .setSeqFeatures(sequenceFeatureToJsonPojo(seqs, fr));
189 if (getViewport().getExportSettings().isExportGroups()
191 && seqGroups.size() > 0)
193 for (SequenceGroup seqGrp : seqGroups)
195 SequenceGrpPojo seqGrpPojo = new SequenceGrpPojo();
196 seqGrpPojo.setGroupName(seqGrp.getName());
197 seqGrpPojo.setColourScheme(ColourSchemeProperty
198 .getColourName(seqGrp.cs));
199 seqGrpPojo.setColourText(seqGrp.getColourText());
200 seqGrpPojo.setDescription(seqGrp.getDescription());
201 seqGrpPojo.setDisplayBoxes(seqGrp.getDisplayBoxes());
202 seqGrpPojo.setDisplayText(seqGrp.getDisplayText());
203 seqGrpPojo.setEndRes(seqGrp.getEndRes());
204 seqGrpPojo.setStartRes(seqGrp.getStartRes());
205 seqGrpPojo.setShowNonconserved(seqGrp.getShowNonconserved());
206 for (SequenceI seq : seqGrp.getSequences())
208 seqGrpPojo.getSeqsHash().add(String.valueOf(seq.hashCode()));
210 jsonAlignmentPojo.getSeqGroups().add(seqGrpPojo);
213 org.json.JSONObject generatedJSon = new org.json.JSONObject(
215 jsonOutput = generatedJSon.toString();
216 return jsonOutput.replaceAll("xstart", "xStart").replaceAll("xend",
218 } catch (Exception e)
225 public String[] getHiddenSections()
227 String[] hiddenSections = new String[2];
228 if (getViewport() == null)
233 // hidden column business
234 if (getViewport().hasHiddenColumns())
236 List<int[]> hiddenCols = getViewport().getColumnSelection()
238 StringBuilder hiddenColsBuilder = new StringBuilder();
239 for (int[] range : hiddenCols)
241 hiddenColsBuilder.append(";").append(range[0]).append("-")
245 hiddenColsBuilder.deleteCharAt(0);
246 hiddenSections[0] = hiddenColsBuilder.toString();
249 // hidden rows/seqs business
250 HiddenSequences hiddenSeqsObj = getViewport().getAlignment()
251 .getHiddenSequences();
252 if (hiddenSeqsObj == null || hiddenSeqsObj.hiddenSequences == null)
254 return hiddenSections;
257 SequenceI[] hiddenSeqs = hiddenSeqsObj.hiddenSequences;
258 StringBuilder hiddenSeqsBuilder = new StringBuilder();
259 for (SequenceI hiddenSeq : hiddenSeqs)
261 if (hiddenSeq != null)
263 hiddenSeqsBuilder.append(";").append(hiddenSeq.hashCode());
266 if (hiddenSeqsBuilder.length() > 0)
268 hiddenSeqsBuilder.deleteCharAt(0);
270 hiddenSections[1] = hiddenSeqsBuilder.toString();
272 return hiddenSections;
275 public static List<SequenceFeaturesPojo> sequenceFeatureToJsonPojo(
276 List<SequenceI> seqs, FeatureRenderer fr)
278 FeaturesDisplayedI displayedFeatures = (fr == null) ? null : fr
279 .getFeaturesDisplayed();
280 List<SequenceFeaturesPojo> sequenceFeaturesPojo = new ArrayList<SequenceFeaturesPojo>();
281 for (SequenceI seq : seqs)
283 SequenceI dataSetSequence = seq.getDatasetSequence();
284 SequenceFeature[] seqFeatures = (dataSetSequence == null) ? null
285 : seq.getDatasetSequence().getSequenceFeatures();
287 seqFeatures = (seqFeatures == null) ? seq.getSequenceFeatures()
289 if (seqFeatures == null)
294 for (SequenceFeature sf : seqFeatures)
296 if (displayedFeatures != null
297 && displayedFeatures.isVisible(sf.getType()))
299 SequenceFeaturesPojo jsonFeature = new SequenceFeaturesPojo(
300 String.valueOf(seq.hashCode()));
301 String featureColour = (fr == null) ? null : jalview.util.Format
303 .findFeatureColour(Color.white, seq,
304 seq.findIndex(sf.getBegin())));
305 jsonFeature.setXstart(seq.findIndex(sf.getBegin()) - 1);
306 jsonFeature.setXend(seq.findIndex(sf.getEnd()));
307 jsonFeature.setType(sf.getType());
308 jsonFeature.setDescription(sf.getDescription());
309 jsonFeature.setLinks(sf.links);
310 jsonFeature.setOtherDetails(sf.otherDetails);
311 jsonFeature.setScore(sf.getScore());
312 jsonFeature.setFillColor(featureColour);
313 jsonFeature.setFeatureGroup(sf.getFeatureGroup());
314 sequenceFeaturesPojo.add(jsonFeature);
318 return sequenceFeaturesPojo;
321 public static List<AlignmentAnnotationPojo> annotationToJsonPojo(
322 Vector<AlignmentAnnotation> annotations)
324 List<AlignmentAnnotationPojo> jsonAnnotations = new ArrayList<AlignmentAnnotationPojo>();
325 if (annotations == null)
327 return jsonAnnotations;
329 for (AlignmentAnnotation annot : annotations)
331 AlignmentAnnotationPojo alignAnnotPojo = new AlignmentAnnotationPojo();
332 alignAnnotPojo.setDescription(annot.description);
333 alignAnnotPojo.setLabel(annot.label);
334 for (Annotation annotation : annot.annotations)
336 AnnotationPojo annotationPojo = new AnnotationPojo();
337 if (annotation != null)
339 annotationPojo.setDescription(annotation.description);
340 annotationPojo.setValue(annotation.value);
342 .setSecondaryStructure(annotation.secondaryStructure);
343 annotationPojo.setDisplayCharacter(annotation.displayCharacter);
344 alignAnnotPojo.getAnnotations().add(annotationPojo);
348 alignAnnotPojo.getAnnotations().add(annotationPojo);
351 jsonAnnotations.add(alignAnnotPojo);
353 return jsonAnnotations;
356 @SuppressWarnings("unchecked")
357 public JSONFile parse(String jsonAlignmentString)
361 JSONParser jsonParser = new JSONParser();
362 JSONObject alignmentJsonObj = (JSONObject) jsonParser
363 .parse(jsonAlignmentString);
364 JSONArray seqJsonArray = (JSONArray) alignmentJsonObj.get("seqs");
365 JSONArray alAnnotJsonArray = (JSONArray) alignmentJsonObj
366 .get("alignAnnotation");
367 JSONArray jsonSeqArray = (JSONArray) alignmentJsonObj
369 JSONArray seqGrpJsonArray = (JSONArray) alignmentJsonObj
371 JSONObject jvSettingsJsonObj = (JSONObject) alignmentJsonObj
374 if (jvSettingsJsonObj != null)
376 String jsColourScheme = (String) jvSettingsJsonObj
377 .get("globalColorScheme");
378 Boolean showFeatures = Boolean.valueOf(jvSettingsJsonObj.get(
379 "showSeqFeatures").toString());
380 setColourScheme(getJalviewColorScheme(jsColourScheme));
381 setShowSeqFeatures(showFeatures);
382 parseHiddenSeqRefsAsList(jvSettingsJsonObj);
383 parseHiddenCols(jvSettingsJsonObj);
386 hiddenSequences = new ArrayList<SequenceI>();
387 seqMap = new Hashtable<String, Sequence>();
388 for (Iterator<JSONObject> sequenceIter = seqJsonArray.iterator(); sequenceIter
391 JSONObject sequence = sequenceIter.next();
392 String sequcenceString = sequence.get("seq").toString();
393 String sequenceName = sequence.get("name").toString();
394 String seqUniqueId = sequence.get("id").toString();
395 int start = Integer.valueOf(sequence.get("start").toString());
396 int end = Integer.valueOf(sequence.get("end").toString());
397 Sequence seq = new Sequence(sequenceName, sequcenceString, start,
399 if (hiddenSeqRefs != null && hiddenSeqRefs.contains(seqUniqueId))
401 hiddenSequences.add(seq);
404 seqMap.put(seqUniqueId, seq);
406 parseFeatures(jsonSeqArray);
408 for (Iterator<JSONObject> seqGrpIter = seqGrpJsonArray.iterator(); seqGrpIter
411 JSONObject seqGrpObj = seqGrpIter.next();
412 String grpName = seqGrpObj.get("groupName").toString();
413 String colourScheme = seqGrpObj.get("colourScheme").toString();
414 String description = (seqGrpObj.get("description") == null) ? null
415 : seqGrpObj.get("description").toString();
416 boolean displayBoxes = Boolean.valueOf(seqGrpObj
417 .get("displayBoxes").toString());
418 boolean displayText = Boolean.valueOf(seqGrpObj.get("displayText")
420 boolean colourText = Boolean.valueOf(seqGrpObj.get("colourText")
422 boolean showNonconserved = Boolean.valueOf(seqGrpObj.get(
423 "showNonconserved").toString());
424 int startRes = Integer
425 .valueOf(seqGrpObj.get("startRes").toString());
426 int endRes = Integer.valueOf(seqGrpObj.get("endRes").toString());
427 JSONArray seqsHashArray = (JSONArray) seqGrpObj.get("seqsHash");
429 ArrayList<SequenceI> grpSeqs = new ArrayList<SequenceI>();
430 if (seqsHashArray.size() > 0)
432 Iterator<String> seqHashIter = seqsHashArray.iterator();
433 while (seqHashIter.hasNext())
435 String seqHash = seqHashIter.next();
436 Sequence sequence = seqMap.get(seqHash);
437 if (sequence != null)
439 grpSeqs.add(sequence);
443 ColourSchemeI scheme = getJalviewColorScheme(colourScheme);
444 SequenceGroup seqGrp = new SequenceGroup(grpSeqs, grpName, scheme,
445 displayBoxes, displayText, colourText, startRes, endRes);
446 seqGrp.setShowNonconserved(showNonconserved);
447 seqGrp.setDescription(description);
448 this.seqGroups.add(seqGrp);
452 for (Iterator<JSONObject> alAnnotIter = alAnnotJsonArray.iterator(); alAnnotIter
455 JSONObject alAnnot = alAnnotIter.next();
456 JSONArray annotJsonArray = (JSONArray) alAnnot.get("annotations");
457 Annotation[] annotations = new Annotation[annotJsonArray.size()];
459 for (Iterator<JSONObject> annotIter = annotJsonArray.iterator(); annotIter
462 JSONObject annot = annotIter.next();
465 annotations[count] = null;
469 float val = annot.get("value") == null ? null : Float
470 .valueOf(annot.get("value").toString());
471 String desc = annot.get("description") == null ? null : annot
472 .get("description").toString();
474 char ss = annot.get("secondaryStructure") == null ? ' '
475 : annot.get("secondaryStructure").toString().charAt(0);
476 String displayChar = annot.get("displayCharacter").toString();
478 annotations[count] = new Annotation(displayChar, desc, ss, val);
483 AlignmentAnnotation alignAnnot = new AlignmentAnnotation(alAnnot
484 .get("label").toString(), alAnnot.get("description")
485 .toString(), annotations);
486 this.annotations.add(alignAnnot);
489 } catch (Exception e)
496 public void parseHiddenSeqRefsAsList(JSONObject jvSettingsJson)
498 hiddenSeqRefs = new ArrayList<String>();
499 String hiddenSeqs = (String) jvSettingsJson.get("hiddenSeqs");
500 if(hiddenSeqs != null && !hiddenSeqs.isEmpty()){
501 String[] seqRefs = hiddenSeqs.split(";");
502 for(String seqRef : seqRefs){
503 hiddenSeqRefs.add(seqRef);
508 public void parseHiddenCols(JSONObject jvSettingsJson)
510 String hiddenCols = (String) jvSettingsJson.get("hiddenCols");
511 if(hiddenCols != null && !hiddenCols.isEmpty()){
512 columnSelection = new ColumnSelection();
513 String[] rangeStrings = hiddenCols.split(";");
514 for(String rangeString : rangeStrings){
515 String[] range = rangeString.split("-");
516 columnSelection.hideColumns(Integer.valueOf(range[0]),
517 Integer.valueOf(range[1]));
522 @SuppressWarnings("unchecked")
523 private void parseFeatures(JSONArray jsonSeqFeatures)
525 if (jsonSeqFeatures != null)
527 for (Iterator<JSONObject> seqFeatureItr = jsonSeqFeatures.iterator(); seqFeatureItr
530 JSONObject jsonFeature = seqFeatureItr.next();
531 Long begin = (Long) jsonFeature.get("xStart");
532 Long end = (Long) jsonFeature.get("xEnd");
533 String type = (String) jsonFeature.get("type");
534 String featureGrp = (String) jsonFeature.get("featureGroup");
535 String descripiton = (String) jsonFeature.get("description");
536 String seqRef = (String) jsonFeature.get("sequenceRef");
537 Float score = Float.valueOf(jsonFeature.get("score").toString());
539 Sequence seq = seqMap.get(seqRef);
540 SequenceFeature sequenceFeature = new SequenceFeature();
541 JSONArray linksJsonArray = (JSONArray) jsonFeature.get("links");
542 if (linksJsonArray != null && linksJsonArray.size() > 0)
544 Iterator<String> linkList = linksJsonArray.iterator();
545 while (linkList.hasNext())
547 String link = linkList.next();
548 sequenceFeature.addLink(link);
551 sequenceFeature.setFeatureGroup(featureGrp);
552 sequenceFeature.setScore(score);
553 sequenceFeature.setDescription(descripiton);
554 sequenceFeature.setType(type);
555 sequenceFeature.setBegin(seq.findPosition(begin.intValue()));
556 sequenceFeature.setEnd(seq.findPosition(end.intValue()) - 1);
557 seq.addSequenceFeature(sequenceFeature);
562 public static ColourSchemeI getJalviewColorScheme(
563 String bioJsColourSchemeName)
565 ColourSchemeI jalviewColor = null;
566 for (JalviewBioJsColorSchemeMapper cs : JalviewBioJsColorSchemeMapper
569 if (cs.getBioJsName().equalsIgnoreCase(bioJsColourSchemeName))
571 jalviewColor = cs.getJvColourScheme();
578 public String getGlobalColorScheme()
580 return globalColorScheme;
583 public void setGlobalColorScheme(String globalColorScheme)
585 this.globalColorScheme = globalColorScheme;
588 public ColourSchemeI getColourScheme()
593 public void setColourScheme(ColourSchemeI colourScheme)
595 this.colourScheme = colourScheme;
598 public FeaturesDisplayedI getDisplayedFeatures()
600 return displayedFeatures;
603 public void setDisplayedFeatures(FeaturesDisplayedI displayedFeatures)
605 this.displayedFeatures = displayedFeatures;
609 public static String getJSONData(AlignViewportI av)
611 JSONFile jsonFile = new JSONFile();
612 jsonFile.setViewport(av);
613 jsonFile.seqGroups = av.getAlignment().getGroups();
614 jsonFile.setDisplayedFeatures(av.getFeaturesDisplayed());
616 for (SequenceI seq : av.getAlignment().getSequences())
618 jsonFile.seqs.add(seq);
621 // Add non auto calculated annotation to AlignFile
622 for (AlignmentAnnotation annot : av.getAlignment()
623 .getAlignmentAnnotation())
625 if (annot != null && !annot.autoCalculated)
627 if (annot.label.equals("PDB.CATempFactor"))
631 jsonFile.annotations.add(annot);
634 String jsonString = jsonFile.print();
638 public boolean isShowSeqFeatures()
640 return showSeqFeatures;
643 public void setShowSeqFeatures(boolean showSeqFeatures)
645 this.showSeqFeatures = showSeqFeatures;
648 public Vector<AlignmentAnnotation> getAnnotations()
653 public List<int[]> getHiddenColumns()
655 return hiddenColumns;
658 public ColumnSelection getColumnSelection()
660 return columnSelection;
663 public void setColumnSelection(ColumnSelection columnSelection)
665 this.columnSelection = columnSelection;
668 public SequenceI[] getHiddenSequences()
670 if (hiddenSequences == null || hiddenSequences.isEmpty())
672 return new SequenceI[]
675 synchronized (hiddenSequences)
677 return hiddenSequences.toArray(new SequenceI[hiddenSequences.size()]);
681 public void setHiddenSequences(ArrayList<SequenceI> hiddenSequences)
683 this.hiddenSequences = hiddenSequences;
686 public class JSONExportSettings
688 private boolean exportSequence;
690 private boolean exportSequenceFeatures;
692 private boolean exportAnnotations;
694 private boolean exportGroups;
696 private boolean exportJalviewSettings;
698 public boolean isExportSequence()
700 return exportSequence;
703 public void setExportSequence(boolean exportSequence)
705 this.exportSequence = exportSequence;
708 public boolean isExportSequenceFeatures()
710 return exportSequenceFeatures;
713 public void setExportSequenceFeatures(boolean exportSequenceFeatures)
715 this.exportSequenceFeatures = exportSequenceFeatures;
718 public boolean isExportAnnotations()
720 return exportAnnotations;
723 public void setExportAnnotations(boolean exportAnnotations)
725 this.exportAnnotations = exportAnnotations;
728 public boolean isExportGroups()
733 public void setExportGroups(boolean exportGroups)
735 this.exportGroups = exportGroups;
738 public boolean isExportJalviewSettings()
740 return exportJalviewSettings;
743 public void setExportJalviewSettings(boolean exportJalviewSettings)
745 this.exportJalviewSettings = exportJalviewSettings;