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)
169 jsonAlignmentPojo.getAppSettings().put("hiddenCols",
170 String.valueOf(hiddenSections[0]));
171 jsonAlignmentPojo.getAppSettings().put("hiddenSeqs",
172 String.valueOf(hiddenSections[1]));
176 if (jsonExportSettings.isExportAnnotations())
179 .setAlignAnnotation(annotationToJsonPojo(annotations));
182 if (jsonExportSettings.isExportSequenceFeatures())
185 .setSeqFeatures(sequenceFeatureToJsonPojo(seqs, fr));
188 if (jsonExportSettings.isExportGroups() && seqGroups != null
189 && seqGroups.size() > 0)
191 for (SequenceGroup seqGrp : seqGroups)
193 SequenceGrpPojo seqGrpPojo = new SequenceGrpPojo();
194 seqGrpPojo.setGroupName(seqGrp.getName());
195 seqGrpPojo.setColourScheme(ColourSchemeProperty
196 .getColourName(seqGrp.cs));
197 seqGrpPojo.setColourText(seqGrp.getColourText());
198 seqGrpPojo.setDescription(seqGrp.getDescription());
199 seqGrpPojo.setDisplayBoxes(seqGrp.getDisplayBoxes());
200 seqGrpPojo.setDisplayText(seqGrp.getDisplayText());
201 seqGrpPojo.setEndRes(seqGrp.getEndRes());
202 seqGrpPojo.setStartRes(seqGrp.getStartRes());
203 seqGrpPojo.setShowNonconserved(seqGrp.getShowNonconserved());
204 for (SequenceI seq : seqGrp.getSequences())
206 seqGrpPojo.getSeqsHash().add(String.valueOf(seq.hashCode()));
208 jsonAlignmentPojo.getSeqGroups().add(seqGrpPojo);
211 org.json.JSONObject generatedJSon = new org.json.JSONObject(
213 jsonOutput = generatedJSon.toString();
214 return jsonOutput.replaceAll("xstart", "xStart").replaceAll("xend",
216 } catch (Exception e)
223 public String[] exportHiddenSections()
225 String[] hiddenSections = new String[2];
226 if (getViewport() == null)
231 System.out.println("--- Hidden Sections ---");
232 // hidden column business
233 if (getViewport().hasHiddenColumns())
235 System.out.print("Hidden Cols : ");
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();
247 System.out.println(hiddenSections[0]);
250 // hidden rows/seqs business
251 HiddenSequences hiddenSeqsObj = getViewport().getAlignment()
252 .getHiddenSequences();
253 if (hiddenSeqsObj == null)
255 return hiddenSections;
258 SequenceI[] hiddenSeqs = hiddenSeqsObj.hiddenSequences;
259 System.out.print("Hidden Seqs : ");
260 StringBuilder hiddenSeqsBuilder = new StringBuilder();
261 for (SequenceI hiddenSeq : hiddenSeqs)
263 if (hiddenSeq != null)
265 hiddenSeqsBuilder.append(";").append(hiddenSeq.hashCode());
268 if (hiddenSeqsBuilder.length() > 0)
270 hiddenSeqsBuilder.deleteCharAt(0);
272 hiddenSections[1] = hiddenSeqsBuilder.toString();
273 System.out.println(hiddenSections[1]);
274 return hiddenSections;
277 public static List<SequenceFeaturesPojo> sequenceFeatureToJsonPojo(
278 List<SequenceI> seqs, FeatureRenderer fr)
280 FeaturesDisplayedI displayedFeatures = (fr == null) ? null : fr
281 .getFeaturesDisplayed();
282 List<SequenceFeaturesPojo> sequenceFeaturesPojo = new ArrayList<SequenceFeaturesPojo>();
283 for (SequenceI seq : seqs)
285 SequenceI dataSetSequence = seq.getDatasetSequence();
286 SequenceFeature[] seqFeatures = (dataSetSequence == null) ? null
287 : seq.getDatasetSequence().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 seqMap = new Hashtable<String, Sequence>();
387 for (Iterator<JSONObject> sequenceIter = seqJsonArray.iterator(); sequenceIter
390 JSONObject sequence = sequenceIter.next();
391 String sequcenceString = sequence.get("seq").toString();
392 String sequenceName = sequence.get("name").toString();
393 String seqUniqueId = sequence.get("id").toString();
394 int start = Integer.valueOf(sequence.get("start").toString());
395 int end = Integer.valueOf(sequence.get("end").toString());
396 Sequence seq = new Sequence(sequenceName, sequcenceString, start,
398 if (hiddenSeqRefs.contains(seqUniqueId))
403 seqMap.put(seqUniqueId, seq);
405 parseFeatures(jsonSeqArray);
407 for (Iterator<JSONObject> seqGrpIter = seqGrpJsonArray.iterator(); seqGrpIter
410 JSONObject seqGrpObj = seqGrpIter.next();
411 String grpName = seqGrpObj.get("groupName").toString();
412 String colourScheme = seqGrpObj.get("colourScheme").toString();
413 String description = (seqGrpObj.get("description") == null) ? null
414 : seqGrpObj.get("description").toString();
415 boolean displayBoxes = Boolean.valueOf(seqGrpObj
416 .get("displayBoxes").toString());
417 boolean displayText = Boolean.valueOf(seqGrpObj.get("displayText")
419 boolean colourText = Boolean.valueOf(seqGrpObj.get("colourText")
421 boolean showNonconserved = Boolean.valueOf(seqGrpObj.get(
422 "showNonconserved").toString());
423 int startRes = Integer
424 .valueOf(seqGrpObj.get("startRes").toString());
425 int endRes = Integer.valueOf(seqGrpObj.get("endRes").toString());
426 JSONArray seqsHashArray = (JSONArray) seqGrpObj.get("seqsHash");
428 ArrayList<SequenceI> grpSeqs = new ArrayList<SequenceI>();
429 if (seqsHashArray.size() > 0)
431 Iterator<String> seqHashIter = seqsHashArray.iterator();
432 while (seqHashIter.hasNext())
434 String seqHash = seqHashIter.next();
435 Sequence sequence = seqMap.get(seqHash);
436 if (sequence != null)
438 grpSeqs.add(sequence);
442 ColourSchemeI scheme = getJalviewColorScheme(colourScheme);
443 SequenceGroup seqGrp = new SequenceGroup(grpSeqs, grpName, scheme,
444 displayBoxes, displayText, colourText, startRes, endRes);
445 seqGrp.setShowNonconserved(showNonconserved);
446 seqGrp.setDescription(description);
447 this.seqGroups.add(seqGrp);
451 for (Iterator<JSONObject> alAnnotIter = alAnnotJsonArray.iterator(); alAnnotIter
454 JSONObject alAnnot = alAnnotIter.next();
455 JSONArray annotJsonArray = (JSONArray) alAnnot.get("annotations");
456 Annotation[] annotations = new Annotation[annotJsonArray.size()];
458 for (Iterator<JSONObject> annotIter = annotJsonArray.iterator(); annotIter
461 JSONObject annot = annotIter.next();
464 annotations[count] = null;
468 float val = annot.get("value") == null ? null : Float
469 .valueOf(annot.get("value").toString());
470 String desc = annot.get("description") == null ? null : annot
471 .get("description").toString();
473 char ss = annot.get("secondaryStructure") == null ? ' '
474 : annot.get("secondaryStructure").toString().charAt(0);
475 String displayChar = annot.get("displayCharacter").toString();
477 annotations[count] = new Annotation(displayChar, desc, ss, val);
482 AlignmentAnnotation alignAnnot = new AlignmentAnnotation(alAnnot
483 .get("label").toString(), alAnnot.get("description")
484 .toString(), annotations);
485 this.annotations.add(alignAnnot);
488 } catch (Exception e)
495 public void parseHiddenSeqRefsAsList(JSONObject jvSettingsJson)
497 hiddenSeqRefs = new ArrayList<String>();
498 String hiddenSeqs = (String) jvSettingsJson.get("hiddenSeqs");
499 if(hiddenSeqs != null && !hiddenSeqs.isEmpty()){
500 String[] seqRefs = hiddenSeqs.split(";");
501 for(String seqRef : seqRefs){
502 hiddenSeqRefs.add(seqRef);
507 public void parseHiddenCols(JSONObject jvSettingsJson)
509 hiddenColumns = new ArrayList<int[]>();
510 String hiddenCols = (String) jvSettingsJson.get("hiddenCols");
511 if(hiddenCols != null && !hiddenCols.isEmpty()){
512 String[] rangeStrings = hiddenCols.split(";");
513 for(String rangeString : rangeStrings){
514 String[] range = rangeString.split("-");
515 hiddenColumns.add(new int[]
516 { Integer.valueOf(range[0]), Integer.valueOf(range[1]) });
521 @SuppressWarnings("unchecked")
522 private void parseFeatures(JSONArray jsonSeqFeatures)
524 if (jsonSeqFeatures != null)
526 for (Iterator<JSONObject> seqFeatureItr = jsonSeqFeatures.iterator(); seqFeatureItr
529 JSONObject jsonFeature = seqFeatureItr.next();
530 Long begin = (Long) jsonFeature.get("xStart");
531 Long end = (Long) jsonFeature.get("xEnd");
532 String type = (String) jsonFeature.get("type");
533 String featureGrp = (String) jsonFeature.get("featureGroup");
534 String descripiton = (String) jsonFeature.get("description");
535 String seqRef = (String) jsonFeature.get("sequenceRef");
536 Float score = Float.valueOf(jsonFeature.get("score").toString());
537 // Hashtable otherDetails = (Hashtable) jsonFeature
538 // .get("otherDetails");
539 // sequenceFeature.otherDetails = otherDetails;
541 Sequence seq = seqMap.get(seqRef);
542 SequenceFeature sequenceFeature = new SequenceFeature();
543 JSONArray linksJsonArray = (JSONArray) jsonFeature.get("links");
544 if (linksJsonArray != null && linksJsonArray.size() > 0)
546 Iterator<String> linkList = linksJsonArray.iterator();
547 while (linkList.hasNext())
549 String link = linkList.next();
550 sequenceFeature.addLink(link);
553 sequenceFeature.setFeatureGroup(featureGrp);
554 sequenceFeature.setScore(score);
555 sequenceFeature.setDescription(descripiton);
556 sequenceFeature.setType(type);
557 sequenceFeature.setBegin(seq.findPosition(begin.intValue()));
558 sequenceFeature.setEnd(seq.findPosition(end.intValue()) - 1);
559 seq.addSequenceFeature(sequenceFeature);
564 public static ColourSchemeI getJalviewColorScheme(
565 String bioJsColourSchemeName)
567 ColourSchemeI jalviewColor = null;
568 for (JalviewBioJsColorSchemeMapper cs : JalviewBioJsColorSchemeMapper
571 if (cs.getBioJsName().equalsIgnoreCase(bioJsColourSchemeName))
573 jalviewColor = cs.getJvColourScheme();
580 public void applySettingsToAlignmentView(AlignViewControllerGuiI avc)
582 avc.setShowSeqFeatures(isShowSeqFeatures());
583 avc.changeColour(getColourScheme());
584 avc.setMenusForViewport();
585 avc.hideColumns(hiddenColumns);
586 avc.syncHiddenSequences();
589 public String getGlobalColorScheme()
591 return globalColorScheme;
594 public void setGlobalColorScheme(String globalColorScheme)
596 this.globalColorScheme = globalColorScheme;
599 public ColourSchemeI getColourScheme()
604 public void setColourScheme(ColourSchemeI colourScheme)
606 this.colourScheme = colourScheme;
609 public FeaturesDisplayedI getDisplayedFeatures()
611 return displayedFeatures;
614 public void setDisplayedFeatures(FeaturesDisplayedI displayedFeatures)
616 this.displayedFeatures = displayedFeatures;
619 public JSONExportSettings getJsonExportSettings()
621 return jsonExportSettings;
624 public void setJsonExportSettings(JSONExportSettings jsonExportSettings)
626 this.jsonExportSettings = jsonExportSettings;
629 public static String getJSONData(AlignViewportI av)
631 JSONFile jsonFile = new JSONFile();
632 jsonFile.setViewport(av);
633 jsonFile.seqGroups = av.getAlignment().getGroups();
634 jsonFile.setDisplayedFeatures(av.getFeaturesDisplayed());
636 for (SequenceI seq : av.getAlignment().getSequences())
638 jsonFile.seqs.add(seq);
641 // Add non auto calculated annotation to AlignFile
642 for (AlignmentAnnotation annot : av.getAlignment()
643 .getAlignmentAnnotation())
645 if (annot != null && !annot.autoCalculated)
647 if (annot.label.equals("PDB.CATempFactor"))
651 jsonFile.annotations.add(annot);
654 String jsonString = jsonFile.print();
658 public boolean isShowSeqFeatures()
660 return showSeqFeatures;
663 public void setShowSeqFeatures(boolean showSeqFeatures)
665 this.showSeqFeatures = showSeqFeatures;
668 public Vector<AlignmentAnnotation> getAnnotations()
673 public List<int[]> getHiddenColumns()
675 return hiddenColumns;
678 public class JSONExportSettings
680 private boolean exportSequence;
682 private boolean exportSequenceFeatures;
684 private boolean exportAnnotations;
686 private boolean exportGroups;
688 private boolean exportJalviewSettings;
690 public boolean isExportSequence()
692 return exportSequence;
695 public void setExportSequence(boolean exportSequence)
697 this.exportSequence = exportSequence;
700 public boolean isExportSequenceFeatures()
702 return exportSequenceFeatures;
705 public void setExportSequenceFeatures(boolean exportSequenceFeatures)
707 this.exportSequenceFeatures = exportSequenceFeatures;
710 public boolean isExportAnnotations()
712 return exportAnnotations;
715 public void setExportAnnotations(boolean exportAnnotations)
717 this.exportAnnotations = exportAnnotations;
720 public boolean isExportGroups()
725 public void setExportGroups(boolean exportGroups)
727 this.exportGroups = exportGroups;
730 public boolean isExportJalviewSettings()
732 return exportJalviewSettings;
735 public void setExportJalviewSettings(boolean exportJalviewSettings)
737 this.exportJalviewSettings = exportJalviewSettings;