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.AlignViewControllerGuiI;
37 import jalview.api.AlignViewportI;
38 import jalview.api.FeatureRenderer;
39 import jalview.api.FeaturesDisplayedI;
40 import jalview.datamodel.AlignmentAnnotation;
41 import jalview.datamodel.Annotation;
42 import jalview.datamodel.HiddenSequences;
43 import jalview.datamodel.Sequence;
44 import jalview.datamodel.SequenceFeature;
45 import jalview.datamodel.SequenceGroup;
46 import jalview.datamodel.SequenceI;
47 import jalview.json.binding.v1.AlignmentAnnotationPojo;
48 import jalview.json.binding.v1.AlignmentPojo;
49 import jalview.json.binding.v1.AlignmentPojo.JalviewBioJsColorSchemeMapper;
50 import jalview.json.binding.v1.AnnotationPojo;
51 import jalview.json.binding.v1.SequenceFeaturesPojo;
52 import jalview.json.binding.v1.SequenceGrpPojo;
53 import jalview.json.binding.v1.SequencePojo;
54 import jalview.schemes.ColourSchemeI;
55 import jalview.schemes.ColourSchemeProperty;
57 public class JSONFile extends AlignFile
59 private ColourSchemeI colourScheme;
61 private String version = "2.9";
63 private String webstartUrl = "www.jalview.org/services/launchApp";
65 private String application = "Jalview";
67 public static final String FILE_EXT = "json";
69 public static final String FILE_DESC = "JSON";
71 private String globalColorScheme;
73 private boolean showSeqFeatures;
75 private Hashtable<String, Sequence> seqMap;
77 private FeaturesDisplayedI displayedFeatures;
79 private FeatureRenderer fr;
81 private JSONExportSettings jsonExportSettings;
83 private List<int[]> hiddenColumns;
85 private List<String> hiddenSeqRefs;
92 public JSONFile(FileParse source) throws IOException
97 public JSONFile(String inFile, String type) throws IOException
103 public void parse() throws IOException
105 StringBuilder jsonStringBuilder = new StringBuilder();
107 while ((currentLine = nextLine()) != null)
109 jsonStringBuilder.append(currentLine);
111 parse(jsonStringBuilder.toString());
116 public String print()
118 String jsonOutput = null;
121 if (getJsonExportSettings() == null)
123 jsonExportSettings = new JSONExportSettings();
124 jsonExportSettings.setExportAnnotations(true);
125 jsonExportSettings.setExportGroups(true);
126 jsonExportSettings.setExportJalviewSettings(true);
127 jsonExportSettings.setExportSequenceFeatures(true);
130 AlignmentPojo jsonAlignmentPojo = new AlignmentPojo();
131 if (getViewport() != null)
133 globalColorScheme = ColourSchemeProperty
134 .getColourName(getViewport()
135 .getGlobalColourScheme());
136 setDisplayedFeatures(getViewport().getFeaturesDisplayed());
137 showSeqFeatures = getViewport().isShowSequenceFeatures();
138 fr = getViewport().getFeatureRenderer();
142 for (SequenceI seq : seqs)
144 StringBuilder name = new StringBuilder();
145 name.append(seq.getName()).append("/").append(seq.getStart())
146 .append("-").append(seq.getEnd());
147 SequencePojo jsonSeqPojo = new SequencePojo();
148 jsonSeqPojo.setId(String.valueOf(seq.hashCode()));
149 jsonSeqPojo.setOrder(++count);
150 jsonSeqPojo.setEnd(seq.getEnd());
151 jsonSeqPojo.setStart(seq.getStart());
152 jsonSeqPojo.setName(name.toString());
153 jsonSeqPojo.setSeq(seq.getSequenceAsString());
154 jsonAlignmentPojo.getSeqs().add(jsonSeqPojo);
157 if (jsonExportSettings.isExportJalviewSettings())
159 jsonAlignmentPojo.setGlobalColorScheme(globalColorScheme);
160 jsonAlignmentPojo.getAppSettings().put("application", application);
161 jsonAlignmentPojo.getAppSettings().put("version", version);
162 jsonAlignmentPojo.getAppSettings().put("webStartUrl", webstartUrl);
163 jsonAlignmentPojo.getAppSettings().put("showSeqFeatures",
164 String.valueOf(showSeqFeatures));
166 String[] hiddenSections = exportHiddenSections();
167 if (hiddenSections != null && getViewport().isIncludeHiddenRegion())
169 if (hiddenSections[0] != null)
171 jsonAlignmentPojo.getAppSettings().put("hiddenCols",
172 String.valueOf(hiddenSections[0]));
174 if (hiddenSections[1] != null)
176 jsonAlignmentPojo.getAppSettings().put("hiddenSeqs",
177 String.valueOf(hiddenSections[1]));
182 if (jsonExportSettings.isExportAnnotations())
185 .setAlignAnnotation(annotationToJsonPojo(annotations));
188 if (jsonExportSettings.isExportSequenceFeatures())
191 .setSeqFeatures(sequenceFeatureToJsonPojo(seqs, fr));
194 if (jsonExportSettings.isExportGroups() && seqGroups != null
195 && seqGroups.size() > 0)
197 for (SequenceGroup seqGrp : seqGroups)
199 SequenceGrpPojo seqGrpPojo = new SequenceGrpPojo();
200 seqGrpPojo.setGroupName(seqGrp.getName());
201 seqGrpPojo.setColourScheme(ColourSchemeProperty
202 .getColourName(seqGrp.cs));
203 seqGrpPojo.setColourText(seqGrp.getColourText());
204 seqGrpPojo.setDescription(seqGrp.getDescription());
205 seqGrpPojo.setDisplayBoxes(seqGrp.getDisplayBoxes());
206 seqGrpPojo.setDisplayText(seqGrp.getDisplayText());
207 seqGrpPojo.setEndRes(seqGrp.getEndRes());
208 seqGrpPojo.setStartRes(seqGrp.getStartRes());
209 seqGrpPojo.setShowNonconserved(seqGrp.getShowNonconserved());
210 for (SequenceI seq : seqGrp.getSequences())
212 seqGrpPojo.getSeqsHash().add(String.valueOf(seq.hashCode()));
214 jsonAlignmentPojo.getSeqGroups().add(seqGrpPojo);
217 org.json.JSONObject generatedJSon = new org.json.JSONObject(
219 jsonOutput = generatedJSon.toString();
220 return jsonOutput.replaceAll("xstart", "xStart").replaceAll("xend",
222 } catch (Exception e)
229 public String[] exportHiddenSections()
231 String[] hiddenSections = new String[2];
232 if (getViewport() == null)
237 System.out.println("--- Hidden Sections ---");
238 // hidden column business
239 if (getViewport().hasHiddenColumns())
241 System.out.print("Hidden Cols : ");
242 List<int[]> hiddenCols = getViewport().getColumnSelection()
244 StringBuilder hiddenColsBuilder = new StringBuilder();
245 for (int[] range : hiddenCols)
247 hiddenColsBuilder.append(";").append(range[0]).append("-")
251 hiddenColsBuilder.deleteCharAt(0);
252 hiddenSections[0] = hiddenColsBuilder.toString();
253 System.out.println(hiddenSections[0]);
256 // hidden rows/seqs business
257 HiddenSequences hiddenSeqsObj = getViewport().getAlignment()
258 .getHiddenSequences();
259 if (hiddenSeqsObj == null || hiddenSeqsObj.hiddenSequences == null)
261 return hiddenSections;
264 SequenceI[] hiddenSeqs = hiddenSeqsObj.hiddenSequences;
265 StringBuilder hiddenSeqsBuilder = new StringBuilder();
266 for (SequenceI hiddenSeq : hiddenSeqs)
268 if (hiddenSeq != null)
270 hiddenSeqsBuilder.append(";").append(hiddenSeq.hashCode());
273 if (hiddenSeqsBuilder.length() > 0)
275 hiddenSeqsBuilder.deleteCharAt(0);
277 hiddenSections[1] = hiddenSeqsBuilder.toString();
279 return hiddenSections;
282 public static List<SequenceFeaturesPojo> sequenceFeatureToJsonPojo(
283 List<SequenceI> seqs, FeatureRenderer fr)
285 FeaturesDisplayedI displayedFeatures = (fr == null) ? null : fr
286 .getFeaturesDisplayed();
287 List<SequenceFeaturesPojo> sequenceFeaturesPojo = new ArrayList<SequenceFeaturesPojo>();
288 for (SequenceI seq : seqs)
290 SequenceI dataSetSequence = seq.getDatasetSequence();
291 SequenceFeature[] seqFeatures = (dataSetSequence == null) ? null
292 : seq.getDatasetSequence().getSequenceFeatures();
294 seqFeatures = (seqFeatures == null) ? seq.getSequenceFeatures()
296 if (seqFeatures == null)
301 for (SequenceFeature sf : seqFeatures)
303 if (displayedFeatures != null
304 && displayedFeatures.isVisible(sf.getType()))
306 SequenceFeaturesPojo jsonFeature = new SequenceFeaturesPojo(
307 String.valueOf(seq.hashCode()));
308 String featureColour = (fr == null) ? null : jalview.util.Format
310 .findFeatureColour(Color.white, seq,
311 seq.findIndex(sf.getBegin())));
312 jsonFeature.setXstart(seq.findIndex(sf.getBegin()) - 1);
313 jsonFeature.setXend(seq.findIndex(sf.getEnd()));
314 jsonFeature.setType(sf.getType());
315 jsonFeature.setDescription(sf.getDescription());
316 jsonFeature.setLinks(sf.links);
317 jsonFeature.setOtherDetails(sf.otherDetails);
318 jsonFeature.setScore(sf.getScore());
319 jsonFeature.setFillColor(featureColour);
320 jsonFeature.setFeatureGroup(sf.getFeatureGroup());
321 sequenceFeaturesPojo.add(jsonFeature);
325 return sequenceFeaturesPojo;
328 public static List<AlignmentAnnotationPojo> annotationToJsonPojo(
329 Vector<AlignmentAnnotation> annotations)
331 List<AlignmentAnnotationPojo> jsonAnnotations = new ArrayList<AlignmentAnnotationPojo>();
332 if (annotations == null)
334 return jsonAnnotations;
336 for (AlignmentAnnotation annot : annotations)
338 AlignmentAnnotationPojo alignAnnotPojo = new AlignmentAnnotationPojo();
339 alignAnnotPojo.setDescription(annot.description);
340 alignAnnotPojo.setLabel(annot.label);
341 for (Annotation annotation : annot.annotations)
343 AnnotationPojo annotationPojo = new AnnotationPojo();
344 if (annotation != null)
346 annotationPojo.setDescription(annotation.description);
347 annotationPojo.setValue(annotation.value);
349 .setSecondaryStructure(annotation.secondaryStructure);
350 annotationPojo.setDisplayCharacter(annotation.displayCharacter);
351 alignAnnotPojo.getAnnotations().add(annotationPojo);
355 alignAnnotPojo.getAnnotations().add(annotationPojo);
358 jsonAnnotations.add(alignAnnotPojo);
360 return jsonAnnotations;
363 @SuppressWarnings("unchecked")
364 public JSONFile parse(String jsonAlignmentString)
368 JSONParser jsonParser = new JSONParser();
369 JSONObject alignmentJsonObj = (JSONObject) jsonParser
370 .parse(jsonAlignmentString);
371 JSONArray seqJsonArray = (JSONArray) alignmentJsonObj.get("seqs");
372 JSONArray alAnnotJsonArray = (JSONArray) alignmentJsonObj
373 .get("alignAnnotation");
374 JSONArray jsonSeqArray = (JSONArray) alignmentJsonObj
376 JSONArray seqGrpJsonArray = (JSONArray) alignmentJsonObj
378 JSONObject jvSettingsJsonObj = (JSONObject) alignmentJsonObj
381 if (jvSettingsJsonObj != null)
383 String jsColourScheme = (String) jvSettingsJsonObj
384 .get("globalColorScheme");
385 Boolean showFeatures = Boolean.valueOf(jvSettingsJsonObj.get(
386 "showSeqFeatures").toString());
387 setColourScheme(getJalviewColorScheme(jsColourScheme));
388 setShowSeqFeatures(showFeatures);
389 parseHiddenSeqRefsAsList(jvSettingsJsonObj);
390 parseHiddenCols(jvSettingsJsonObj);
393 seqMap = new Hashtable<String, Sequence>();
394 for (Iterator<JSONObject> sequenceIter = seqJsonArray.iterator(); sequenceIter
397 JSONObject sequence = sequenceIter.next();
398 String sequcenceString = sequence.get("seq").toString();
399 String sequenceName = sequence.get("name").toString();
400 String seqUniqueId = sequence.get("id").toString();
401 int start = Integer.valueOf(sequence.get("start").toString());
402 int end = Integer.valueOf(sequence.get("end").toString());
403 Sequence seq = new Sequence(sequenceName, sequcenceString, start,
405 if (hiddenSeqRefs != null && hiddenSeqRefs.contains(seqUniqueId))
410 seqMap.put(seqUniqueId, seq);
412 parseFeatures(jsonSeqArray);
414 for (Iterator<JSONObject> seqGrpIter = seqGrpJsonArray.iterator(); seqGrpIter
417 JSONObject seqGrpObj = seqGrpIter.next();
418 String grpName = seqGrpObj.get("groupName").toString();
419 String colourScheme = seqGrpObj.get("colourScheme").toString();
420 String description = (seqGrpObj.get("description") == null) ? null
421 : seqGrpObj.get("description").toString();
422 boolean displayBoxes = Boolean.valueOf(seqGrpObj
423 .get("displayBoxes").toString());
424 boolean displayText = Boolean.valueOf(seqGrpObj.get("displayText")
426 boolean colourText = Boolean.valueOf(seqGrpObj.get("colourText")
428 boolean showNonconserved = Boolean.valueOf(seqGrpObj.get(
429 "showNonconserved").toString());
430 int startRes = Integer
431 .valueOf(seqGrpObj.get("startRes").toString());
432 int endRes = Integer.valueOf(seqGrpObj.get("endRes").toString());
433 JSONArray seqsHashArray = (JSONArray) seqGrpObj.get("seqsHash");
435 ArrayList<SequenceI> grpSeqs = new ArrayList<SequenceI>();
436 if (seqsHashArray.size() > 0)
438 Iterator<String> seqHashIter = seqsHashArray.iterator();
439 while (seqHashIter.hasNext())
441 String seqHash = seqHashIter.next();
442 Sequence sequence = seqMap.get(seqHash);
443 if (sequence != null)
445 grpSeqs.add(sequence);
449 ColourSchemeI scheme = getJalviewColorScheme(colourScheme);
450 SequenceGroup seqGrp = new SequenceGroup(grpSeqs, grpName, scheme,
451 displayBoxes, displayText, colourText, startRes, endRes);
452 seqGrp.setShowNonconserved(showNonconserved);
453 seqGrp.setDescription(description);
454 this.seqGroups.add(seqGrp);
458 for (Iterator<JSONObject> alAnnotIter = alAnnotJsonArray.iterator(); alAnnotIter
461 JSONObject alAnnot = alAnnotIter.next();
462 JSONArray annotJsonArray = (JSONArray) alAnnot.get("annotations");
463 Annotation[] annotations = new Annotation[annotJsonArray.size()];
465 for (Iterator<JSONObject> annotIter = annotJsonArray.iterator(); annotIter
468 JSONObject annot = annotIter.next();
471 annotations[count] = null;
475 float val = annot.get("value") == null ? null : Float
476 .valueOf(annot.get("value").toString());
477 String desc = annot.get("description") == null ? null : annot
478 .get("description").toString();
480 char ss = annot.get("secondaryStructure") == null ? ' '
481 : annot.get("secondaryStructure").toString().charAt(0);
482 String displayChar = annot.get("displayCharacter").toString();
484 annotations[count] = new Annotation(displayChar, desc, ss, val);
489 AlignmentAnnotation alignAnnot = new AlignmentAnnotation(alAnnot
490 .get("label").toString(), alAnnot.get("description")
491 .toString(), annotations);
492 this.annotations.add(alignAnnot);
495 } catch (Exception e)
502 public void parseHiddenSeqRefsAsList(JSONObject jvSettingsJson)
504 hiddenSeqRefs = new ArrayList<String>();
505 String hiddenSeqs = (String) jvSettingsJson.get("hiddenSeqs");
506 if(hiddenSeqs != null && !hiddenSeqs.isEmpty()){
507 String[] seqRefs = hiddenSeqs.split(";");
508 for(String seqRef : seqRefs){
509 hiddenSeqRefs.add(seqRef);
514 public void parseHiddenCols(JSONObject jvSettingsJson)
516 hiddenColumns = new ArrayList<int[]>();
517 String hiddenCols = (String) jvSettingsJson.get("hiddenCols");
518 if(hiddenCols != null && !hiddenCols.isEmpty()){
519 String[] rangeStrings = hiddenCols.split(";");
520 for(String rangeString : rangeStrings){
521 String[] range = rangeString.split("-");
522 hiddenColumns.add(new int[]
523 { Integer.valueOf(range[0]), Integer.valueOf(range[1]) });
528 @SuppressWarnings("unchecked")
529 private void parseFeatures(JSONArray jsonSeqFeatures)
531 if (jsonSeqFeatures != null)
533 for (Iterator<JSONObject> seqFeatureItr = jsonSeqFeatures.iterator(); seqFeatureItr
536 JSONObject jsonFeature = seqFeatureItr.next();
537 Long begin = (Long) jsonFeature.get("xStart");
538 Long end = (Long) jsonFeature.get("xEnd");
539 String type = (String) jsonFeature.get("type");
540 String featureGrp = (String) jsonFeature.get("featureGroup");
541 String descripiton = (String) jsonFeature.get("description");
542 String seqRef = (String) jsonFeature.get("sequenceRef");
543 Float score = Float.valueOf(jsonFeature.get("score").toString());
544 // Hashtable otherDetails = (Hashtable) jsonFeature
545 // .get("otherDetails");
546 // sequenceFeature.otherDetails = otherDetails;
548 Sequence seq = seqMap.get(seqRef);
549 SequenceFeature sequenceFeature = new SequenceFeature();
550 JSONArray linksJsonArray = (JSONArray) jsonFeature.get("links");
551 if (linksJsonArray != null && linksJsonArray.size() > 0)
553 Iterator<String> linkList = linksJsonArray.iterator();
554 while (linkList.hasNext())
556 String link = linkList.next();
557 sequenceFeature.addLink(link);
560 sequenceFeature.setFeatureGroup(featureGrp);
561 sequenceFeature.setScore(score);
562 sequenceFeature.setDescription(descripiton);
563 sequenceFeature.setType(type);
564 sequenceFeature.setBegin(seq.findPosition(begin.intValue()));
565 sequenceFeature.setEnd(seq.findPosition(end.intValue()) - 1);
566 seq.addSequenceFeature(sequenceFeature);
571 public static ColourSchemeI getJalviewColorScheme(
572 String bioJsColourSchemeName)
574 ColourSchemeI jalviewColor = null;
575 for (JalviewBioJsColorSchemeMapper cs : JalviewBioJsColorSchemeMapper
578 if (cs.getBioJsName().equalsIgnoreCase(bioJsColourSchemeName))
580 jalviewColor = cs.getJvColourScheme();
587 public void applySettingsToAlignmentView(AlignViewControllerGuiI avc)
589 avc.setShowSeqFeatures(isShowSeqFeatures());
590 avc.changeColour(getColourScheme());
591 avc.setMenusForViewport();
592 avc.hideColumns(hiddenColumns);
593 avc.syncHiddenSequences();
596 public String getGlobalColorScheme()
598 return globalColorScheme;
601 public void setGlobalColorScheme(String globalColorScheme)
603 this.globalColorScheme = globalColorScheme;
606 public ColourSchemeI getColourScheme()
611 public void setColourScheme(ColourSchemeI colourScheme)
613 this.colourScheme = colourScheme;
616 public FeaturesDisplayedI getDisplayedFeatures()
618 return displayedFeatures;
621 public void setDisplayedFeatures(FeaturesDisplayedI displayedFeatures)
623 this.displayedFeatures = displayedFeatures;
626 public JSONExportSettings getJsonExportSettings()
628 return jsonExportSettings;
631 public void setJsonExportSettings(JSONExportSettings jsonExportSettings)
633 this.jsonExportSettings = jsonExportSettings;
636 public static String getJSONData(AlignViewportI av)
638 JSONFile jsonFile = new JSONFile();
639 jsonFile.setViewport(av);
640 jsonFile.seqGroups = av.getAlignment().getGroups();
641 jsonFile.setDisplayedFeatures(av.getFeaturesDisplayed());
643 for (SequenceI seq : av.getAlignment().getSequences())
645 jsonFile.seqs.add(seq);
648 // Add non auto calculated annotation to AlignFile
649 for (AlignmentAnnotation annot : av.getAlignment()
650 .getAlignmentAnnotation())
652 if (annot != null && !annot.autoCalculated)
654 if (annot.label.equals("PDB.CATempFactor"))
658 jsonFile.annotations.add(annot);
661 String jsonString = jsonFile.print();
665 public boolean isShowSeqFeatures()
667 return showSeqFeatures;
670 public void setShowSeqFeatures(boolean showSeqFeatures)
672 this.showSeqFeatures = showSeqFeatures;
675 public Vector<AlignmentAnnotation> getAnnotations()
680 public List<int[]> getHiddenColumns()
682 return hiddenColumns;
685 public class JSONExportSettings
687 private boolean exportSequence;
689 private boolean exportSequenceFeatures;
691 private boolean exportAnnotations;
693 private boolean exportGroups;
695 private boolean exportJalviewSettings;
697 public boolean isExportSequence()
699 return exportSequence;
702 public void setExportSequence(boolean exportSequence)
704 this.exportSequence = exportSequence;
707 public boolean isExportSequenceFeatures()
709 return exportSequenceFeatures;
712 public void setExportSequenceFeatures(boolean exportSequenceFeatures)
714 this.exportSequenceFeatures = exportSequenceFeatures;
717 public boolean isExportAnnotations()
719 return exportAnnotations;
722 public void setExportAnnotations(boolean exportAnnotations)
724 this.exportAnnotations = exportAnnotations;
727 public boolean isExportGroups()
732 public void setExportGroups(boolean exportGroups)
734 this.exportGroups = exportGroups;
737 public boolean isExportJalviewSettings()
739 return exportJalviewSettings;
742 public void setExportJalviewSettings(boolean exportJalviewSettings)
744 this.exportJalviewSettings = exportJalviewSettings;