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 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.v1.AlignmentAnnotationPojo;
41 import jalview.json.binding.v1.AlignmentPojo;
42 import jalview.json.binding.v1.AlignmentPojo.JalviewBioJsColorSchemeMapper;
43 import jalview.json.binding.v1.AnnotationPojo;
44 import jalview.json.binding.v1.SequenceFeaturesPojo;
45 import jalview.json.binding.v1.SequenceGrpPojo;
46 import jalview.json.binding.v1.SequencePojo;
47 import jalview.schemes.ColourSchemeI;
48 import jalview.schemes.ColourSchemeProperty;
49 import jalview.viewmodel.seqfeatures.FeaturesDisplayed;
51 import java.awt.Color;
52 import java.io.IOException;
53 import java.io.Reader;
54 import java.util.ArrayList;
55 import java.util.Hashtable;
56 import java.util.Iterator;
57 import java.util.List;
58 import java.util.Vector;
60 import org.json.simple.JSONArray;
61 import org.json.simple.JSONObject;
62 import org.json.simple.parser.JSONParser;
64 public class JSONFile extends AlignFile implements ComplexAlignFile
66 private ColourSchemeI colourScheme;
68 private static String version = new BuildDetails().getVersion();
70 private String webstartUrl = "http://www.jalview.org/services/launchApp";
72 private String application = "Jalview";
74 public static final String FILE_EXT = "json";
76 public static final String FILE_DESC = "JSON";
78 private String globalColorScheme;
80 private boolean showSeqFeatures;
82 private Hashtable<String, Sequence> seqMap;
84 private FeaturesDisplayedI displayedFeatures;
86 private FeatureRenderer fr;
88 private List<int[]> hiddenColumns;
90 private ColumnSelection columnSelection;
92 private List<String> hiddenSeqRefs;
94 private ArrayList<SequenceI> hiddenSequences;
102 public JSONFile(FileParse source) throws IOException
107 public JSONFile(String inFile, String type) throws IOException
113 public void parse() throws IOException
119 public String print()
121 String jsonOutput = null;
124 AlignmentPojo jsonAlignmentPojo = new AlignmentPojo();
125 AlignExportSettingI exportSettings = getExportSettings();
127 // if no export settings were supplied use the following with all values
128 // defaulting to true
129 if (exportSettings == null)
131 exportSettings = new AlignExportSettingI()
134 public boolean isExportHiddenSequences()
140 public boolean isExportHiddenColumns()
146 public boolean isExportGroups()
152 public boolean isExportFeatures()
158 public boolean isExportAnnotations()
166 for (SequenceI seq : seqs)
168 StringBuilder name = new StringBuilder();
169 name.append(seq.getName()).append("/").append(seq.getStart())
170 .append("-").append(seq.getEnd());
171 SequencePojo jsonSeqPojo = new SequencePojo();
172 jsonSeqPojo.setId(String.valueOf(seq.hashCode()));
173 jsonSeqPojo.setOrder(++count);
174 jsonSeqPojo.setEnd(seq.getEnd());
175 jsonSeqPojo.setStart(seq.getStart());
176 jsonSeqPojo.setName(name.toString());
177 jsonSeqPojo.setSeq(seq.getSequenceAsString());
178 jsonAlignmentPojo.getSeqs().add(jsonSeqPojo);
180 jsonAlignmentPojo.setGlobalColorScheme(globalColorScheme);
181 jsonAlignmentPojo.getAppSettings().put("application", application);
182 jsonAlignmentPojo.getAppSettings().put("version", version);
183 jsonAlignmentPojo.getAppSettings().put("webStartUrl", webstartUrl);
184 jsonAlignmentPojo.getAppSettings().put("showSeqFeatures",
185 String.valueOf(showSeqFeatures));
187 String[] hiddenSections = getHiddenSections();
188 if (hiddenSections != null)
190 if (hiddenSections[0] != null
192 .isExportHiddenColumns())
194 jsonAlignmentPojo.getAppSettings().put("hiddenCols",
195 String.valueOf(hiddenSections[0]));
197 if (hiddenSections[1] != null
199 .isExportHiddenSequences())
201 jsonAlignmentPojo.getAppSettings().put("hiddenSeqs",
202 String.valueOf(hiddenSections[1]));
206 if (exportSettings.isExportAnnotations())
209 .setAlignAnnotation(annotationToJsonPojo(annotations));
212 if (exportSettings.isExportFeatures())
215 .setSeqFeatures(sequenceFeatureToJsonPojo(seqs, fr));
218 if (exportSettings.isExportGroups()
220 && seqGroups.size() > 0)
222 for (SequenceGroup seqGrp : seqGroups)
224 SequenceGrpPojo seqGrpPojo = new SequenceGrpPojo();
225 seqGrpPojo.setGroupName(seqGrp.getName());
226 seqGrpPojo.setColourScheme(ColourSchemeProperty
227 .getColourName(seqGrp.cs));
228 seqGrpPojo.setColourText(seqGrp.getColourText());
229 seqGrpPojo.setDescription(seqGrp.getDescription());
230 seqGrpPojo.setDisplayBoxes(seqGrp.getDisplayBoxes());
231 seqGrpPojo.setDisplayText(seqGrp.getDisplayText());
232 seqGrpPojo.setEndRes(seqGrp.getEndRes());
233 seqGrpPojo.setStartRes(seqGrp.getStartRes());
234 seqGrpPojo.setShowNonconserved(seqGrp.getShowNonconserved());
235 for (SequenceI seq : seqGrp.getSequences())
237 seqGrpPojo.getSequenceRefs()
238 .add(String.valueOf(seq.hashCode()));
240 jsonAlignmentPojo.getSeqGroups().add(seqGrpPojo);
243 org.json.JSONObject generatedJSon = new org.json.JSONObject(
245 jsonOutput = generatedJSon.toString();
246 return jsonOutput.replaceAll("xstart", "xStart").replaceAll("xend",
248 } catch (Exception e)
255 public String[] getHiddenSections()
257 String[] hiddenSections = new String[2];
258 if (getViewport() == null)
263 // hidden column business
264 if (getViewport().hasHiddenColumns())
266 List<int[]> hiddenCols = getViewport().getColumnSelection()
268 StringBuilder hiddenColsBuilder = new StringBuilder();
269 for (int[] range : hiddenCols)
271 hiddenColsBuilder.append(";").append(range[0]).append("-")
275 hiddenColsBuilder.deleteCharAt(0);
276 hiddenSections[0] = hiddenColsBuilder.toString();
279 // hidden rows/seqs business
280 HiddenSequences hiddenSeqsObj = getViewport().getAlignment()
281 .getHiddenSequences();
282 if (hiddenSeqsObj == null || hiddenSeqsObj.hiddenSequences == null)
284 return hiddenSections;
287 SequenceI[] hiddenSeqs = hiddenSeqsObj.hiddenSequences;
288 StringBuilder hiddenSeqsBuilder = new StringBuilder();
289 for (SequenceI hiddenSeq : hiddenSeqs)
291 if (hiddenSeq != null)
293 hiddenSeqsBuilder.append(";").append(hiddenSeq.hashCode());
296 if (hiddenSeqsBuilder.length() > 0)
298 hiddenSeqsBuilder.deleteCharAt(0);
300 hiddenSections[1] = hiddenSeqsBuilder.toString();
302 return hiddenSections;
305 public List<SequenceFeaturesPojo> sequenceFeatureToJsonPojo(
306 List<SequenceI> seqs, FeatureRenderer fr)
308 displayedFeatures = (fr == null) ? null : fr
309 .getFeaturesDisplayed();
310 List<SequenceFeaturesPojo> sequenceFeaturesPojo = new ArrayList<SequenceFeaturesPojo>();
311 for (SequenceI seq : seqs)
313 SequenceI dataSetSequence = seq.getDatasetSequence();
314 SequenceFeature[] seqFeatures = (dataSetSequence == null) ? null
315 : seq.getDatasetSequence().getSequenceFeatures();
317 seqFeatures = (seqFeatures == null) ? seq.getSequenceFeatures()
319 if (seqFeatures == null)
324 for (SequenceFeature sf : seqFeatures)
326 if (displayedFeatures != null
327 && displayedFeatures.isVisible(sf.getType()))
329 SequenceFeaturesPojo jsonFeature = new SequenceFeaturesPojo(
330 String.valueOf(seq.hashCode()));
332 String featureColour = (fr == null) ? null : jalview.util.Format
334 .findFeatureColour(Color.white, seq,
335 seq.findIndex(sf.getBegin())));
336 jsonFeature.setXstart(seq.findIndex(sf.getBegin()) - 1);
337 jsonFeature.setXend(seq.findIndex(sf.getEnd()));
338 jsonFeature.setType(sf.getType());
339 jsonFeature.setDescription(sf.getDescription());
340 jsonFeature.setLinks(sf.links);
341 jsonFeature.setOtherDetails(sf.otherDetails);
342 jsonFeature.setScore(sf.getScore());
343 jsonFeature.setFillColor(featureColour);
344 jsonFeature.setFeatureGroup(sf.getFeatureGroup());
345 sequenceFeaturesPojo.add(jsonFeature);
349 return sequenceFeaturesPojo;
352 public static List<AlignmentAnnotationPojo> annotationToJsonPojo(
353 Vector<AlignmentAnnotation> annotations)
355 List<AlignmentAnnotationPojo> jsonAnnotations = new ArrayList<AlignmentAnnotationPojo>();
356 if (annotations == null)
358 return jsonAnnotations;
360 for (AlignmentAnnotation annot : annotations)
362 AlignmentAnnotationPojo alignAnnotPojo = new AlignmentAnnotationPojo();
363 alignAnnotPojo.setDescription(annot.description);
364 alignAnnotPojo.setLabel(annot.label);
365 for (Annotation annotation : annot.annotations)
367 AnnotationPojo annotationPojo = new AnnotationPojo();
368 if (annotation != null)
370 annotationPojo.setDescription(annotation.description);
371 annotationPojo.setValue(annotation.value);
373 .setSecondaryStructure(annotation.secondaryStructure);
374 annotationPojo.setDisplayCharacter(annotation.displayCharacter);
375 alignAnnotPojo.getAnnotations().add(annotationPojo);
379 alignAnnotPojo.getAnnotations().add(annotationPojo);
382 jsonAnnotations.add(alignAnnotPojo);
384 return jsonAnnotations;
387 @SuppressWarnings("unchecked")
388 public JSONFile parse(Reader jsonAlignmentString)
392 JSONParser jsonParser = new JSONParser();
393 JSONObject alignmentJsonObj = (JSONObject) jsonParser
394 .parse(jsonAlignmentString);
395 JSONArray seqJsonArray = (JSONArray) alignmentJsonObj.get("seqs");
396 JSONArray alAnnotJsonArray = (JSONArray) alignmentJsonObj
397 .get("alignAnnotation");
398 JSONArray jsonSeqArray = (JSONArray) alignmentJsonObj
400 JSONArray seqGrpJsonArray = (JSONArray) alignmentJsonObj
402 JSONObject jvSettingsJsonObj = (JSONObject) alignmentJsonObj
405 if (jvSettingsJsonObj != null)
407 String jsColourScheme = (String) jvSettingsJsonObj
408 .get("globalColorScheme");
409 Boolean showFeatures = Boolean.valueOf(jvSettingsJsonObj.get(
410 "showSeqFeatures").toString());
411 setColourScheme(getJalviewColorScheme(jsColourScheme));
412 setShowSeqFeatures(showFeatures);
413 parseHiddenSeqRefsAsList(jvSettingsJsonObj);
414 parseHiddenCols(jvSettingsJsonObj);
417 hiddenSequences = new ArrayList<SequenceI>();
418 seqMap = new Hashtable<String, Sequence>();
419 for (Iterator<JSONObject> sequenceIter = seqJsonArray.iterator(); sequenceIter
422 JSONObject sequence = sequenceIter.next();
423 String sequcenceString = sequence.get("seq").toString();
424 String sequenceName = sequence.get("name").toString();
425 String seqUniqueId = sequence.get("id").toString();
426 int start = Integer.valueOf(sequence.get("start").toString());
427 int end = Integer.valueOf(sequence.get("end").toString());
428 Sequence seq = new Sequence(sequenceName, sequcenceString, start,
430 if (hiddenSeqRefs != null && hiddenSeqRefs.contains(seqUniqueId))
432 hiddenSequences.add(seq);
435 seqMap.put(seqUniqueId, seq);
437 parseFeatures(jsonSeqArray);
439 for (Iterator<JSONObject> seqGrpIter = seqGrpJsonArray.iterator(); seqGrpIter
442 JSONObject seqGrpObj = seqGrpIter.next();
443 String grpName = seqGrpObj.get("groupName").toString();
444 String colourScheme = seqGrpObj.get("colourScheme").toString();
445 String description = (seqGrpObj.get("description") == null) ? null
446 : seqGrpObj.get("description").toString();
447 boolean displayBoxes = Boolean.valueOf(seqGrpObj
448 .get("displayBoxes").toString());
449 boolean displayText = Boolean.valueOf(seqGrpObj.get("displayText")
451 boolean colourText = Boolean.valueOf(seqGrpObj.get("colourText")
453 boolean showNonconserved = Boolean.valueOf(seqGrpObj.get(
454 "showNonconserved").toString());
455 int startRes = Integer
456 .valueOf(seqGrpObj.get("startRes").toString());
457 int endRes = Integer.valueOf(seqGrpObj.get("endRes").toString());
458 JSONArray sequenceRefs = (JSONArray) seqGrpObj.get("sequenceRefs");
460 ArrayList<SequenceI> grpSeqs = new ArrayList<SequenceI>();
461 if (sequenceRefs.size() > 0)
463 Iterator<String> seqHashIter = sequenceRefs.iterator();
464 while (seqHashIter.hasNext())
466 String seqHash = seqHashIter.next();
467 Sequence sequence = seqMap.get(seqHash);
468 if (sequence != null)
470 grpSeqs.add(sequence);
474 ColourSchemeI grpColourScheme = getJalviewColorScheme(colourScheme);
475 SequenceGroup seqGrp = new SequenceGroup(grpSeqs, grpName,
477 displayBoxes, displayText, colourText, startRes, endRes);
478 seqGrp.setShowNonconserved(showNonconserved);
479 seqGrp.setDescription(description);
480 this.seqGroups.add(seqGrp);
484 for (Iterator<JSONObject> alAnnotIter = alAnnotJsonArray.iterator(); alAnnotIter
487 JSONObject alAnnot = alAnnotIter.next();
488 JSONArray annotJsonArray = (JSONArray) alAnnot.get("annotations");
489 Annotation[] annotations = new Annotation[annotJsonArray.size()];
491 for (Iterator<JSONObject> annotIter = annotJsonArray.iterator(); annotIter
494 JSONObject annot = annotIter.next();
497 annotations[count] = null;
501 float val = annot.get("value") == null ? null : Float
502 .valueOf(annot.get("value").toString());
503 String desc = annot.get("description") == null ? null : annot
504 .get("description").toString();
506 char ss = annot.get("secondaryStructure") == null ? ' '
507 : annot.get("secondaryStructure").toString().charAt(0);
508 String displayChar = annot.get("displayCharacter").toString();
510 annotations[count] = new Annotation(displayChar, desc, ss, val);
515 AlignmentAnnotation alignAnnot = new AlignmentAnnotation(alAnnot
516 .get("label").toString(), alAnnot.get("description")
517 .toString(), annotations);
518 this.annotations.add(alignAnnot);
521 } catch (Exception e)
528 public void parseHiddenSeqRefsAsList(JSONObject jvSettingsJson)
530 hiddenSeqRefs = new ArrayList<String>();
531 String hiddenSeqs = (String) jvSettingsJson.get("hiddenSeqs");
532 if(hiddenSeqs != null && !hiddenSeqs.isEmpty()){
533 String[] seqRefs = hiddenSeqs.split(";");
534 for(String seqRef : seqRefs){
535 hiddenSeqRefs.add(seqRef);
540 public void parseHiddenCols(JSONObject jvSettingsJson)
542 String hiddenCols = (String) jvSettingsJson.get("hiddenCols");
543 if(hiddenCols != null && !hiddenCols.isEmpty()){
544 columnSelection = new ColumnSelection();
545 String[] rangeStrings = hiddenCols.split(";");
546 for(String rangeString : rangeStrings){
547 String[] range = rangeString.split("-");
548 columnSelection.hideColumns(Integer.valueOf(range[0]),
549 Integer.valueOf(range[1]));
554 @SuppressWarnings("unchecked")
555 private void parseFeatures(JSONArray jsonSeqFeatures)
557 if (jsonSeqFeatures != null)
559 displayedFeatures = new FeaturesDisplayed();
560 for (Iterator<JSONObject> seqFeatureItr = jsonSeqFeatures.iterator(); seqFeatureItr
563 JSONObject jsonFeature = seqFeatureItr.next();
564 Long begin = (Long) jsonFeature.get("xStart");
565 Long end = (Long) jsonFeature.get("xEnd");
566 String type = (String) jsonFeature.get("type");
567 String featureGrp = (String) jsonFeature.get("featureGroup");
568 String descripiton = (String) jsonFeature.get("description");
569 String seqRef = (String) jsonFeature.get("sequenceRef");
570 Float score = Float.valueOf(jsonFeature.get("score").toString());
572 Sequence seq = seqMap.get(seqRef);
573 SequenceFeature sequenceFeature = new SequenceFeature();
574 JSONArray linksJsonArray = (JSONArray) jsonFeature.get("links");
575 if (linksJsonArray != null && linksJsonArray.size() > 0)
577 Iterator<String> linkList = linksJsonArray.iterator();
578 while (linkList.hasNext())
580 String link = linkList.next();
581 sequenceFeature.addLink(link);
584 sequenceFeature.setFeatureGroup(featureGrp);
585 sequenceFeature.setScore(score);
586 sequenceFeature.setDescription(descripiton);
587 sequenceFeature.setType(type);
588 sequenceFeature.setBegin(seq.findPosition(begin.intValue()));
589 sequenceFeature.setEnd(seq.findPosition(end.intValue()) - 1);
590 seq.addSequenceFeature(sequenceFeature);
591 displayedFeatures.setVisible(type);
596 public static ColourSchemeI getJalviewColorScheme(
597 String bioJsColourSchemeName)
599 ColourSchemeI jalviewColor = null;
600 for (JalviewBioJsColorSchemeMapper cs : JalviewBioJsColorSchemeMapper
603 if (cs.getBioJsName().equalsIgnoreCase(bioJsColourSchemeName))
605 jalviewColor = cs.getJvColourScheme();
612 public String getGlobalColorScheme()
614 return globalColorScheme;
617 public void setGlobalColorScheme(String globalColorScheme)
619 this.globalColorScheme = globalColorScheme;
622 public ColourSchemeI getColourScheme()
627 public void setColourScheme(ColourSchemeI colourScheme)
629 this.colourScheme = colourScheme;
633 public FeaturesDisplayedI getDisplayedFeatures()
635 return displayedFeatures;
638 public void setDisplayedFeatures(FeaturesDisplayedI displayedFeatures)
640 this.displayedFeatures = displayedFeatures;
644 public void configureForView(AlignmentViewPanel avpanel)
646 super.configureForView(avpanel);
647 AlignViewportI viewport = avpanel.getAlignViewport();
648 AlignmentI alignment = viewport.getAlignment();
649 AlignmentAnnotation[] annots = alignment.getAlignmentAnnotation();
651 seqGroups = alignment.getGroups();
652 fr = avpanel.cloneFeatureRenderer();
654 // Add non auto calculated annotation to AlignFile
655 for (AlignmentAnnotation annot : annots)
657 if (annot != null && !annot.autoCalculated)
663 annotations.add(annot);
666 globalColorScheme = ColourSchemeProperty.getColourName(viewport
667 .getGlobalColourScheme());
668 setDisplayedFeatures(viewport.getFeaturesDisplayed());
669 showSeqFeatures = viewport.isShowSequenceFeatures();
673 public boolean isShowSeqFeatures()
675 return showSeqFeatures;
678 public void setShowSeqFeatures(boolean showSeqFeatures)
680 this.showSeqFeatures = showSeqFeatures;
683 public Vector<AlignmentAnnotation> getAnnotations()
688 public List<int[]> getHiddenColumns()
690 return hiddenColumns;
693 public ColumnSelection getColumnSelection()
695 return columnSelection;
698 public void setColumnSelection(ColumnSelection columnSelection)
700 this.columnSelection = columnSelection;
703 public SequenceI[] getHiddenSequences()
705 if (hiddenSequences == null || hiddenSequences.isEmpty())
707 return new SequenceI[]
710 synchronized (hiddenSequences)
712 return hiddenSequences.toArray(new SequenceI[hiddenSequences.size()]);
716 public void setHiddenSequences(ArrayList<SequenceI> hiddenSequences)
718 this.hiddenSequences = hiddenSequences;
721 public class JSONExportSettings
723 private boolean exportSequence;
725 private boolean exportSequenceFeatures;
727 private boolean exportAnnotations;
729 private boolean exportGroups;
731 private boolean exportJalviewSettings;
733 public boolean isExportSequence()
735 return exportSequence;
738 public void setExportSequence(boolean exportSequence)
740 this.exportSequence = exportSequence;
743 public boolean isExportSequenceFeatures()
745 return exportSequenceFeatures;
748 public void setExportSequenceFeatures(boolean exportSequenceFeatures)
750 this.exportSequenceFeatures = exportSequenceFeatures;
753 public boolean isExportAnnotations()
755 return exportAnnotations;
758 public void setExportAnnotations(boolean exportAnnotations)
760 this.exportAnnotations = exportAnnotations;
763 public boolean isExportGroups()
768 public void setExportGroups(boolean exportGroups)
770 this.exportGroups = exportGroups;
773 public boolean isExportJalviewSettings()
775 return exportJalviewSettings;
778 public void setExportJalviewSettings(boolean exportJalviewSettings)
780 this.exportJalviewSettings = exportJalviewSettings;