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.biojson.v1.AlignmentAnnotationPojo;
41 import jalview.json.binding.biojson.v1.AlignmentPojo;
42 import jalview.json.binding.biojson.v1.AnnotationPojo;
43 import jalview.json.binding.biojson.v1.ColourSchemeMapper;
44 import jalview.json.binding.biojson.v1.SequenceFeaturesPojo;
45 import jalview.json.binding.biojson.v1.SequenceGrpPojo;
46 import jalview.json.binding.biojson.v1.SequencePojo;
47 import jalview.schemes.ColourSchemeProperty;
48 import jalview.viewmodel.seqfeatures.FeaturesDisplayed;
50 import java.awt.Color;
51 import java.io.IOException;
52 import java.io.Reader;
53 import java.util.ArrayList;
54 import java.util.Hashtable;
55 import java.util.Iterator;
56 import java.util.List;
57 import java.util.Vector;
59 import org.json.simple.JSONArray;
60 import org.json.simple.JSONObject;
61 import org.json.simple.parser.JSONParser;
63 public class JSONFile extends AlignFile implements ComplexAlignFile
65 private static String version = new BuildDetails().getVersion();
67 private String webstartUrl = "http://www.jalview.org/services/launchApp";
69 private String application = "Jalview";
71 public static final String FILE_EXT = "json";
73 public static final String FILE_DESC = "JSON";
75 private String globalColourScheme;
77 private boolean showSeqFeatures;
79 private Hashtable<String, Sequence> seqMap;
81 private FeaturesDisplayedI displayedFeatures;
83 private FeatureRenderer fr;
85 private List<int[]> hiddenColumns;
87 private ColumnSelection columnSelection;
89 private List<String> hiddenSeqRefs;
91 private ArrayList<SequenceI> hiddenSequences;
98 public JSONFile(FileParse source) throws IOException
103 public JSONFile(String inFile, String type) throws IOException
109 public void parse() throws IOException
116 public String print()
118 String jsonOutput = null;
121 AlignmentPojo jsonAlignmentPojo = new AlignmentPojo();
122 AlignExportSettingI exportSettings = getExportSettings();
124 // if no export settings were supplied use the following with all values
125 // defaulting to true
126 if (exportSettings == null)
128 exportSettings = new AlignExportSettingI()
131 public boolean isExportHiddenSequences()
137 public boolean isExportHiddenColumns()
143 public boolean isExportGroups()
149 public boolean isExportFeatures()
155 public boolean isExportAnnotations()
161 public boolean isCancelled()
169 for (SequenceI seq : seqs)
171 StringBuilder name = new StringBuilder();
172 name.append(seq.getName()).append("/").append(seq.getStart())
173 .append("-").append(seq.getEnd());
174 SequencePojo jsonSeqPojo = new SequencePojo();
175 jsonSeqPojo.setId(String.valueOf(seq.hashCode()));
176 jsonSeqPojo.setOrder(++count);
177 jsonSeqPojo.setEnd(seq.getEnd());
178 jsonSeqPojo.setStart(seq.getStart());
179 jsonSeqPojo.setName(name.toString());
180 jsonSeqPojo.setSeq(seq.getSequenceAsString());
181 jsonAlignmentPojo.getSeqs().add(jsonSeqPojo);
183 jsonAlignmentPojo.setGlobalColorScheme(globalColourScheme);
184 jsonAlignmentPojo.getAppSettings().put("application", application);
185 jsonAlignmentPojo.getAppSettings().put("version", version);
186 jsonAlignmentPojo.getAppSettings().put("webStartUrl", webstartUrl);
187 jsonAlignmentPojo.getAppSettings().put("showSeqFeatures",
188 String.valueOf(showSeqFeatures));
190 String[] hiddenSections = getHiddenSections();
191 if (hiddenSections != null)
193 if (hiddenSections[0] != null
194 && exportSettings.isExportHiddenColumns())
196 jsonAlignmentPojo.getAppSettings().put("hiddenCols",
197 String.valueOf(hiddenSections[0]));
199 if (hiddenSections[1] != null
200 && exportSettings.isExportHiddenSequences())
202 jsonAlignmentPojo.getAppSettings().put("hiddenSeqs",
203 String.valueOf(hiddenSections[1]));
207 if (exportSettings.isExportAnnotations())
210 .setAlignAnnotation(annotationToJsonPojo(annotations));
213 if (exportSettings.isExportFeatures())
216 .setSeqFeatures(sequenceFeatureToJsonPojo(seqs, fr));
219 if (exportSettings.isExportGroups() && seqGroups != null
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.getFeaturesDisplayed();
309 List<SequenceFeaturesPojo> sequenceFeaturesPojo = new ArrayList<SequenceFeaturesPojo>();
310 for (SequenceI seq : seqs)
312 SequenceI dataSetSequence = seq.getDatasetSequence();
313 SequenceFeature[] seqFeatures = (dataSetSequence == null) ? null
314 : seq.getDatasetSequence().getSequenceFeatures();
316 seqFeatures = (seqFeatures == null) ? seq.getSequenceFeatures()
318 if (seqFeatures == null)
323 for (SequenceFeature sf : seqFeatures)
325 if (displayedFeatures != null
326 && displayedFeatures.isVisible(sf.getType()))
328 SequenceFeaturesPojo jsonFeature = new SequenceFeaturesPojo(
329 String.valueOf(seq.hashCode()));
331 String featureColour = (fr == null) ? null : jalview.util.Format
332 .getHexString(fr.findFeatureColour(Color.white, seq,
333 seq.findIndex(sf.getBegin())));
334 jsonFeature.setXstart(seq.findIndex(sf.getBegin()) - 1);
335 jsonFeature.setXend(seq.findIndex(sf.getEnd()));
336 jsonFeature.setType(sf.getType());
337 jsonFeature.setDescription(sf.getDescription());
338 jsonFeature.setLinks(sf.links);
339 jsonFeature.setOtherDetails(sf.otherDetails);
340 jsonFeature.setScore(sf.getScore());
341 jsonFeature.setFillColor(featureColour);
342 jsonFeature.setFeatureGroup(sf.getFeatureGroup());
343 sequenceFeaturesPojo.add(jsonFeature);
347 return sequenceFeaturesPojo;
350 public static List<AlignmentAnnotationPojo> annotationToJsonPojo(
351 Vector<AlignmentAnnotation> annotations)
353 List<AlignmentAnnotationPojo> jsonAnnotations = new ArrayList<AlignmentAnnotationPojo>();
354 if (annotations == null)
356 return jsonAnnotations;
358 for (AlignmentAnnotation annot : annotations)
360 AlignmentAnnotationPojo alignAnnotPojo = new AlignmentAnnotationPojo();
361 alignAnnotPojo.setDescription(annot.description);
362 alignAnnotPojo.setLabel(annot.label);
363 for (Annotation annotation : annot.annotations)
365 AnnotationPojo annotationPojo = new AnnotationPojo();
366 if (annotation != null)
368 annotationPojo.setDescription(annotation.description);
369 annotationPojo.setValue(annotation.value);
371 .setSecondaryStructure(annotation.secondaryStructure);
372 annotationPojo.setDisplayCharacter(annotation.displayCharacter);
373 alignAnnotPojo.getAnnotations().add(annotationPojo);
377 alignAnnotPojo.getAnnotations().add(annotationPojo);
380 jsonAnnotations.add(alignAnnotPojo);
382 return jsonAnnotations;
385 @SuppressWarnings("unchecked")
386 public JSONFile parse(Reader jsonAlignmentString)
390 JSONParser jsonParser = new JSONParser();
391 JSONObject alignmentJsonObj = (JSONObject) jsonParser
392 .parse(jsonAlignmentString);
393 JSONArray seqJsonArray = (JSONArray) alignmentJsonObj.get("seqs");
394 JSONArray alAnnotJsonArray = (JSONArray) alignmentJsonObj
395 .get("alignAnnotation");
396 JSONArray jsonSeqArray = (JSONArray) alignmentJsonObj
398 JSONArray seqGrpJsonArray = (JSONArray) alignmentJsonObj
400 JSONObject jvSettingsJsonObj = (JSONObject) alignmentJsonObj
403 if (jvSettingsJsonObj != null)
405 globalColourScheme = (String) jvSettingsJsonObj
406 .get("globalColorScheme");
407 Boolean showFeatures = Boolean.valueOf(jvSettingsJsonObj.get(
408 "showSeqFeatures").toString());
409 setShowSeqFeatures(showFeatures);
410 parseHiddenSeqRefsAsList(jvSettingsJsonObj);
411 parseHiddenCols(jvSettingsJsonObj);
414 hiddenSequences = new ArrayList<SequenceI>();
415 seqMap = new Hashtable<String, Sequence>();
416 for (Iterator<JSONObject> sequenceIter = seqJsonArray.iterator(); sequenceIter
419 JSONObject sequence = sequenceIter.next();
420 String sequcenceString = sequence.get("seq").toString();
421 String sequenceName = sequence.get("name").toString();
422 String seqUniqueId = sequence.get("id").toString();
423 int start = Integer.valueOf(sequence.get("start").toString());
424 int end = Integer.valueOf(sequence.get("end").toString());
425 Sequence seq = new Sequence(sequenceName, sequcenceString, start,
427 if (hiddenSeqRefs != null && hiddenSeqRefs.contains(seqUniqueId))
429 hiddenSequences.add(seq);
432 seqMap.put(seqUniqueId, seq);
436 parseFeatures(jsonSeqArray);
438 for (Iterator<JSONObject> seqGrpIter = seqGrpJsonArray.iterator(); seqGrpIter
441 JSONObject seqGrpObj = seqGrpIter.next();
442 String grpName = seqGrpObj.get("groupName").toString();
443 String colourScheme = seqGrpObj.get("colourScheme").toString();
444 String description = (seqGrpObj.get("description") == null) ? null
445 : seqGrpObj.get("description").toString();
446 boolean displayBoxes = Boolean.valueOf(seqGrpObj
447 .get("displayBoxes").toString());
448 boolean displayText = Boolean.valueOf(seqGrpObj.get("displayText")
450 boolean colourText = Boolean.valueOf(seqGrpObj.get("colourText")
452 boolean showNonconserved = Boolean.valueOf(seqGrpObj.get(
453 "showNonconserved").toString());
454 int startRes = Integer
455 .valueOf(seqGrpObj.get("startRes").toString());
456 int endRes = Integer.valueOf(seqGrpObj.get("endRes").toString());
457 JSONArray sequenceRefs = (JSONArray) seqGrpObj.get("sequenceRefs");
459 ArrayList<SequenceI> grpSeqs = new ArrayList<SequenceI>();
460 if (sequenceRefs.size() > 0)
462 Iterator<String> seqHashIter = sequenceRefs.iterator();
463 while (seqHashIter.hasNext())
465 String seqHash = seqHashIter.next();
466 Sequence sequence = seqMap.get(seqHash);
467 if (sequence != null)
469 grpSeqs.add(sequence);
473 SequenceGroup seqGrp = new SequenceGroup(grpSeqs, grpName, null,
474 displayBoxes, displayText, colourText,
476 seqGrp.cs = ColourSchemeMapper.getJalviewColourScheme(colourScheme,
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();
505 char ss = annot.get("secondaryStructure") == null
506 || annot.get("secondaryStructure").toString()
507 .equalsIgnoreCase("u0000") ? ' ' : annot
508 .get("secondaryStructure").toString().charAt(0);
509 String displayChar = annot.get("displayCharacter") == null ? ""
510 : annot.get("displayCharacter").toString();
512 annotations[count] = new Annotation(displayChar, desc, ss, val);
517 AlignmentAnnotation alignAnnot = new AlignmentAnnotation(alAnnot
518 .get("label").toString(), alAnnot.get("description")
519 .toString(), annotations);
520 this.annotations.add(alignAnnot);
522 } catch (Exception e)
529 public void parseHiddenSeqRefsAsList(JSONObject jvSettingsJson)
531 hiddenSeqRefs = new ArrayList<String>();
532 String hiddenSeqs = (String) jvSettingsJson.get("hiddenSeqs");
533 if (hiddenSeqs != null && !hiddenSeqs.isEmpty())
535 String[] seqRefs = hiddenSeqs.split(";");
536 for (String seqRef : seqRefs)
538 hiddenSeqRefs.add(seqRef);
543 public void parseHiddenCols(JSONObject jvSettingsJson)
545 String hiddenCols = (String) jvSettingsJson.get("hiddenCols");
546 if (hiddenCols != null && !hiddenCols.isEmpty())
548 columnSelection = new ColumnSelection();
549 String[] rangeStrings = hiddenCols.split(";");
550 for (String rangeString : rangeStrings)
552 String[] range = rangeString.split("-");
553 columnSelection.hideColumns(Integer.valueOf(range[0]),
554 Integer.valueOf(range[1]));
559 @SuppressWarnings("unchecked")
560 private void parseFeatures(JSONArray jsonSeqFeatures)
562 if (jsonSeqFeatures != null)
564 displayedFeatures = new FeaturesDisplayed();
565 for (Iterator<JSONObject> seqFeatureItr = jsonSeqFeatures.iterator(); seqFeatureItr
568 JSONObject jsonFeature = seqFeatureItr.next();
569 Long begin = (Long) jsonFeature.get("xStart");
570 Long end = (Long) jsonFeature.get("xEnd");
571 String type = (String) jsonFeature.get("type");
572 String featureGrp = (String) jsonFeature.get("featureGroup");
573 String descripiton = (String) jsonFeature.get("description");
574 String seqRef = (String) jsonFeature.get("sequenceRef");
575 Float score = Float.valueOf(jsonFeature.get("score").toString());
577 Sequence seq = seqMap.get(seqRef);
578 SequenceFeature sequenceFeature = new SequenceFeature();
579 JSONArray linksJsonArray = (JSONArray) jsonFeature.get("links");
580 if (linksJsonArray != null && linksJsonArray.size() > 0)
582 Iterator<String> linkList = linksJsonArray.iterator();
583 while (linkList.hasNext())
585 String link = linkList.next();
586 sequenceFeature.addLink(link);
589 sequenceFeature.setFeatureGroup(featureGrp);
590 sequenceFeature.setScore(score);
591 sequenceFeature.setDescription(descripiton);
592 sequenceFeature.setType(type);
593 sequenceFeature.setBegin(seq.findPosition(begin.intValue()));
594 sequenceFeature.setEnd(seq.findPosition(end.intValue()) - 1);
595 seq.addSequenceFeature(sequenceFeature);
596 displayedFeatures.setVisible(type);
601 public String getGlobalColourScheme()
603 return globalColourScheme;
606 public void setGlobalColorScheme(String globalColourScheme)
608 this.globalColourScheme = globalColourScheme;
612 public FeaturesDisplayedI getDisplayedFeatures()
614 return displayedFeatures;
617 public void setDisplayedFeatures(FeaturesDisplayedI displayedFeatures)
619 this.displayedFeatures = displayedFeatures;
622 public void configureForView(AlignmentViewPanel avpanel)
624 super.configureForView(avpanel);
625 AlignViewportI viewport = avpanel.getAlignViewport();
626 AlignmentI alignment = viewport.getAlignment();
627 AlignmentAnnotation[] annots = alignment.getAlignmentAnnotation();
629 seqGroups = alignment.getGroups();
630 fr = avpanel.cloneFeatureRenderer();
632 // Add non auto calculated annotation to AlignFile
633 for (AlignmentAnnotation annot : annots)
635 if (annot != null && !annot.autoCalculated)
641 annotations.add(annot);
644 globalColourScheme = ColourSchemeProperty.getColourName(viewport
645 .getGlobalColourScheme());
646 setDisplayedFeatures(viewport.getFeaturesDisplayed());
647 showSeqFeatures = viewport.isShowSequenceFeatures();
651 public boolean isShowSeqFeatures()
653 return showSeqFeatures;
656 public void setShowSeqFeatures(boolean showSeqFeatures)
658 this.showSeqFeatures = showSeqFeatures;
661 public Vector<AlignmentAnnotation> getAnnotations()
666 public List<int[]> getHiddenColumns()
668 return hiddenColumns;
671 public ColumnSelection getColumnSelection()
673 return columnSelection;
676 public void setColumnSelection(ColumnSelection columnSelection)
678 this.columnSelection = columnSelection;
681 public SequenceI[] getHiddenSequences()
683 if (hiddenSequences == null || hiddenSequences.isEmpty())
685 return new SequenceI[] {};
687 synchronized (hiddenSequences)
689 return hiddenSequences.toArray(new SequenceI[hiddenSequences.size()]);
693 public void setHiddenSequences(ArrayList<SequenceI> hiddenSequences)
695 this.hiddenSequences = hiddenSequences;
698 public class JSONExportSettings
700 private boolean exportSequence;
702 private boolean exportSequenceFeatures;
704 private boolean exportAnnotations;
706 private boolean exportGroups;
708 private boolean exportJalviewSettings;
710 public boolean isExportSequence()
712 return exportSequence;
715 public void setExportSequence(boolean exportSequence)
717 this.exportSequence = exportSequence;
720 public boolean isExportSequenceFeatures()
722 return exportSequenceFeatures;
725 public void setExportSequenceFeatures(boolean exportSequenceFeatures)
727 this.exportSequenceFeatures = exportSequenceFeatures;
730 public boolean isExportAnnotations()
732 return exportAnnotations;
735 public void setExportAnnotations(boolean exportAnnotations)
737 this.exportAnnotations = exportAnnotations;
740 public boolean isExportGroups()
745 public void setExportGroups(boolean exportGroups)
747 this.exportGroups = exportGroups;
750 public boolean isExportJalviewSettings()
752 return exportJalviewSettings;
755 public void setExportJalviewSettings(boolean exportJalviewSettings)
757 this.exportJalviewSettings = exportJalviewSettings;