1 <?xml version="1.0" encoding="UTF-8"?>
2 <!-- * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
3 * Copyright (C) $$Year-Rel$$ The Jalview Authors * * This file is part of
4 Jalview. * * Jalview is free software: you can redistribute it and/or * modify
5 it under the terms of the GNU General Public License * as published by the
6 Free Software Foundation, either version 3 of the License, or (at your option)
7 any later version. * * Jalview is distributed in the hope that it will be
8 useful, but * WITHOUT ANY WARRANTY; without even the implied warranty * of
9 MERCHANTABILITY or FITNESS FOR A PARTICULAR * PURPOSE. See the GNU General
10 Public License for more details. * * You should have received a copy of the
11 GNU General Public License along with Jalview. If not, see <http://www.gnu.org/licenses/>.
12 * The Jalview Authors are detailed in the 'AUTHORS' file. -->
14 Java JAXB binding classes are generated by running command line tool xjc:
15 xjc schemas/jalview.xsd -d src -p jalview.xml.binding.jalview
16 Note this also generates code for included schemas
18 <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
19 xmlns:vamsas="www.vamsas.ac.uk/jalview/version2" xmlns:jalview="www.jalview.org/colours"
20 xmlns:jv="www.jalview.org" xmlns:jvws="www.jalview.org/xml/wsparamset"
21 targetNamespace="www.jalview.org" elementFormDefault="qualified"
22 attributeFormDefault="unqualified">
23 <xs:import namespace="www.vamsas.ac.uk/jalview/version2"
24 schemaLocation="vamsas.xsd" />
25 <xs:import namespace="www.jalview.org/colours"
26 schemaLocation="JalviewUserColours.xsd" />
27 <xs:import namespace="www.jalview.org/xml/wsparamset"
28 schemaLocation="JalviewWsParamSet.xsd" />
29 <xs:element name="JalviewModel" type="jv:JalviewModel" />
30 <xs:complexType name="JalviewModel">
32 <xs:element name="creationDate" type="xs:dateTime" />
33 <xs:element name="version" type="xs:string" />
34 <xs:element name="vamsasModel" type="vamsas:VAMSAS" />
36 <xs:element name="JSeq" maxOccurs="unbounded" minOccurs="0">
39 <xs:element name="features" type="jv:feature"
40 minOccurs="0" maxOccurs="unbounded" />
41 <xs:element name="pdbids" minOccurs="0" maxOccurs="unbounded">
44 <xs:extension base="jv:pdbentry">
46 <xs:element name="structureState" minOccurs="0"
47 maxOccurs="unbounded">
50 <xs:extension base="xs:string">
51 <xs:attributeGroup ref="jv:swingwindow" />
52 <xs:attribute name="visible" type="xs:boolean" />
53 <xs:attribute name="viewId" type="xs:string"
113 <xs:attribute name="alignwithAlignPanel"
114 type="xs:boolean" use="optional" default="true">
143 <xs:attribute name="colourwithAlignPanel"
144 type="xs:boolean" use="optional" default="false">
175 <xs:attribute name="colourByJmol" type="xs:boolean"
176 use="optional" default="true">
203 <xs:attribute name="type" type="xs:string"
231 <xs:element name="hiddenSequences" type="xs:int"
232 minOccurs="0" maxOccurs="unbounded" />
233 <xs:element name="rnaViewer" minOccurs="0" maxOccurs="unbounded">
235 <xs:documentation>Reference to a viewer showing RNA structure
236 for this sequence. Schema supports one viewer showing multiple
237 annotations for multiple sequences, though currently only one
238 annotation for one sequence (gapped or trimmed) is used
243 <xs:element name="secondaryStructure" minOccurs="1"
244 maxOccurs="unbounded">
246 <xs:attribute name="title" type="xs:string" />
247 <xs:attribute name="annotationId" type="xs:string"
250 <xs:documentation>id attribute of Annotation in
252 the secondary structure annotation shown
257 <xs:attribute name="gapped" type="xs:boolean">
259 <xs:documentation>if true the RNA structure is shown with gaps, if false without
263 <xs:attribute name="viewerState" type="xs:string">
265 <xs:documentation>name of the project jar entry that holds
266 the VARNA viewer state for the structure
273 <xs:attributeGroup ref="jv:swingwindow" />
274 <xs:attribute name="title" type="xs:string" />
275 <xs:attribute name="viewId" type="xs:string">
277 <xs:documentation>An id unique to the RNA viewer panel
281 <xs:attribute name="dividerLocation" type="xs:int">
283 <xs:documentation>horizontal position of split pane divider
287 <xs:attribute name="selectedRna" type="xs:int">
289 <xs:documentation>Index of the selected structure in the
296 <xs:element name="hmmerProfile" minOccurs="0" type="xs:string">
298 <xs:documentation>name of the project jar entry that holds the HMM file with the profile for the sequence</xs:documentation>
302 <xs:attribute name="colour" type="xs:int" use="optional" />
303 <xs:attribute name="start" type="xs:int" use="required" />
304 <xs:attribute name="end" type="xs:int" use="required" />
305 <xs:attribute name="id" type="xs:string" use="required" />
306 <xs:attribute name="hidden" type="xs:boolean" />
307 <xs:attribute name="viewreference" type="xs:boolean" use="optional"/>
310 <xs:element name="JGroup" minOccurs="0" maxOccurs="unbounded">
313 <xs:element name="seq" type="xs:string" maxOccurs="unbounded" />
314 <xs:element name="annotationColours" type="jv:AnnotationColourScheme"
315 minOccurs="0" maxOccurs="1" />
317 <xs:attribute name="start" type="xs:int" />
318 <xs:attribute name="end" type="xs:int" />
319 <xs:attribute name="name" type="xs:string" />
320 <xs:attribute name="colour" type="xs:string" />
321 <xs:attribute name="consThreshold" type="xs:int" />
322 <xs:attribute name="pidThreshold" type="xs:int" />
323 <xs:attribute name="outlineColour" type="xs:int" />
324 <xs:attribute name="displayBoxes" type="xs:boolean" />
325 <xs:attribute name="displayText" type="xs:boolean" />
326 <xs:attribute name="colourText" type="xs:boolean" />
327 <xs:attribute name="textCol1" type="xs:int" />
328 <xs:attribute name="textCol2" type="xs:int" />
329 <xs:attribute name="textColThreshold" type="xs:int" />
330 <xs:attribute name="showUnconserved" type="xs:boolean"
332 <xs:attribute name="ignoreGapsinConsensus" type="xs:boolean"
333 use="optional" default="true" />
334 <xs:attribute name="showConsensusHistogram" type="xs:boolean"
335 use="optional" default="true" />
336 <xs:attribute name="showSequenceLogo" type="xs:boolean"
337 use="optional" default="false" />
338 <xs:attribute name="normaliseSequenceLogo" type="xs:boolean"
339 use="optional" default="false" />
340 <xs:attribute name="id" type="xs:string" use="optional">
343 Optional sequence group ID (only
352 <xs:element name="Viewport" maxOccurs="unbounded"
356 <xs:element name="AnnotationColours" type="jv:AnnotationColourScheme"
357 minOccurs="0" maxOccurs="1">
359 <xs:element name="hiddenColumns" minOccurs="0"
360 maxOccurs="unbounded">
362 <xs:attribute name="start" type="xs:int" />
363 <xs:attribute name="end" type="xs:int" />
366 <xs:element name="calcIdParam" minOccurs="0"
367 maxOccurs="unbounded">
370 <xs:extension base="jvws:WebServiceParameterSet">
371 <xs:attribute name="calcId" type="xs:string"
374 <xs:documentation>handle for the calculation which uses
379 <xs:attribute name="needsUpdate" type="xs:boolean"
380 use="optional" default="false">
382 <xs:documentation>should the calculation be performed
383 immediately after loading in order to refresh results
387 <xs:attribute name="autoUpdate" type="xs:boolean"
390 <xs:documentation>should the calculation be automatically
400 <xs:attributeGroup ref="jv:swingwindow" />
401 <xs:attribute name="conservationSelected" type="xs:boolean" />
402 <xs:attribute name="pidSelected" type="xs:boolean" />
403 <xs:attribute name="bgColour" type="xs:string" />
404 <xs:attribute name="consThreshold" type="xs:int" />
405 <xs:attribute name="pidThreshold" type="xs:int" />
406 <xs:attribute name="title" type="xs:string" />
407 <xs:attribute name="showFullId" type="xs:boolean" />
408 <xs:attribute name="rightAlignIds" type="xs:boolean" />
409 <xs:attribute name="showText" type="xs:boolean" />
410 <xs:attribute name="showColourText" type="xs:boolean" />
411 <xs:attribute name="showUnconserved" type="xs:boolean"
412 use="optional" default="false" />
413 <xs:attribute name="showBoxes" type="xs:boolean" />
414 <xs:attribute name="wrapAlignment" type="xs:boolean" />
415 <xs:attribute name="renderGaps" type="xs:boolean" />
416 <xs:attribute name="showSequenceFeatures" type="xs:boolean" />
417 <xs:attribute name="showNPfeatureTooltip" type="xs:boolean"
419 <xs:attribute name="showDbRefTooltip" type="xs:boolean"
421 <xs:attribute name="followHighlight" type="xs:boolean"
422 use="optional" default="true" />
423 <xs:attribute name="followSelection" type="xs:boolean"
424 use="optional" default="true" />
425 <xs:attribute name="showAnnotation" type="xs:boolean" />
426 <xs:attribute name="centreColumnLabels" type="xs:boolean"
427 use="optional" default="false" />
428 <xs:attribute name="showGroupConservation" type="xs:boolean"
429 use="optional" default="false" />
430 <xs:attribute name="showGroupConsensus" type="xs:boolean"
431 use="optional" default="false" />
432 <xs:attribute name="showConsensusHistogram" type="xs:boolean"
433 use="optional" default="true" />
434 <xs:attribute name="showSequenceLogo" type="xs:boolean"
435 use="optional" default="false" />
436 <xs:attribute name="normaliseSequenceLogo" type="xs:boolean"
437 use="optional" default="false" />
438 <xs:attribute name="ignoreGapsinConsensus" type="xs:boolean"
439 use="optional" default="true" />
440 <xs:attribute name="startRes" type="xs:int" />
441 <xs:attribute name="startSeq" type="xs:int" />
442 <xs:attribute name="fontName" type="xs:string" />
443 <xs:attribute name="fontSize" type="xs:int" />
444 <xs:attribute name="fontStyle" type="xs:int" />
445 <xs:attribute name="scaleProteinAsCdna" type="xs:boolean" use="optional" default="true" />
446 <xs:attribute name="viewName" type="xs:string" />
447 <xs:attribute name="sequenceSetId" type="xs:string" />
448 <xs:attribute name="gatheredViews" type="xs:boolean" />
449 <xs:attribute name="textCol1" type="xs:int" />
450 <xs:attribute name="textCol2" type="xs:int" />
451 <xs:attribute name="textColThreshold" type="xs:int" />
452 <xs:attribute name="id" type="xs:ID" use="optional">
455 unique id used by jalview to
462 <xs:attribute name="complementId" type="xs:string"
466 The viewport id of this viewport's
467 (cdna/protein) coding complement, if any
471 <xs:attribute name="showComplementFeatures" type="xs:boolean" use="optional" default="false" />
472 <xs:attribute name="showComplementFeaturesOnTop" type="xs:boolean" use="optional" default="false" />
475 <xs:element name="UserColours" minOccurs="0" maxOccurs="unbounded">
478 <xs:element name="UserColourScheme" type="jalview:JalviewUserColours" />
480 <xs:attribute name="id" type="xs:string" />
483 <xs:element name="tree" minOccurs="0" maxOccurs="unbounded">
485 <xs:sequence minOccurs="0">
486 <xs:element name="title" type="xs:string" />
487 <xs:element name="newick" type="xs:string" />
489 <xs:attribute name="fontName" type="xs:string" />
490 <xs:attribute name="fontSize" type="xs:int" />
491 <xs:attribute name="fontStyle" type="xs:int" />
492 <xs:attribute name="threshold" type="xs:float" />
493 <xs:attribute name="showBootstrap" type="xs:boolean" />
494 <xs:attribute name="showDistances" type="xs:boolean" />
495 <xs:attribute name="markUnlinked" type="xs:boolean" />
496 <xs:attribute name="fitToWindow" type="xs:boolean" />
497 <xs:attribute name="currentTree" type="xs:boolean" />
498 <xs:attribute name="id" type="xs:ID" use="optional">
501 Tree ID added for binding tree
504 document trees in jalview 2.4.1
508 <xs:attributeGroup ref="jv:swingwindow" />
509 <xs:attribute name="linkToAllViews" use="optional" default="false" type="xs:boolean" />
512 <xs:element name="PcaViewer" minOccurs="0" maxOccurs="unbounded">
515 <xs:element name="sequencePoint" minOccurs="1" maxOccurs="unbounded">
517 <xs:attribute name="sequenceRef" type="xs:string" />
518 <xs:attributeGroup ref="jv:position" />
521 <xs:element name="axis" minOccurs="3" maxOccurs="3">
524 endpoints of X, Y and Z axes in that order
528 <xs:attributeGroup ref="jv:position" />
531 <xs:element name="seqPointMin">
533 <xs:attributeGroup ref="jv:position" />
536 <xs:element name="seqPointMax">
538 <xs:attributeGroup ref="jv:position" />
541 <xs:element name="pcaData" type="jv:PcaDataType" />
543 <xs:attribute name="title" type="xs:string" />
544 <xs:attribute name="scoreModelName" type="xs:string" />
545 <xs:attribute name="xDim" type="xs:int" />
546 <xs:attribute name="yDim" type="xs:int" />
547 <xs:attribute name="zDim" type="xs:int" />
548 <xs:attribute name="bgColour" type="xs:int" />
549 <xs:attribute name="scaleFactor" type="xs:float" />
550 <xs:attribute name="showLabels" type="xs:boolean" />
551 <xs:attribute name="linkToAllViews" type="xs:boolean" />
552 <xs:attributeGroup ref="jv:SimilarityParams" />
553 <xs:attributeGroup ref="jv:swingwindow" />
556 <xs:element name="FeatureSettings" minOccurs="0">
559 <xs:element name="setting" minOccurs="0" maxOccurs="unbounded">
562 <xs:element name="attributeName" type="xs:string" minOccurs="0" maxOccurs="2">
564 <xs:documentation>name of feature attribute to colour by, or attribute and sub-attribute</xs:documentation>
567 <xs:element name="matcherSet" minOccurs="0" type="jalview:FeatureMatcherSet">
569 <xs:documentation>optional filter(s) applied to the feature type</xs:documentation>
573 <xs:attribute name="type" type="xs:string" use="required" />
574 <xs:attribute name="colour" type="xs:int" use="required" />
575 <xs:attribute name="display" type="xs:boolean"
577 <xs:attribute name="order" type="xs:float" use="optional" />
578 <xs:attribute name="mincolour" type="xs:int" use="optional">
581 Optional minimum colour
588 <xs:attribute name="noValueColour" use="optional" type="jalview:NoValueColour" default="Min" />
589 <xs:attribute name="threshold" type="xs:float"
594 graduated feature colour
598 <xs:attribute name="threshstate" type="xs:int"
603 graduated feature colour
607 <xs:attribute name="max" type="xs:float" use="optional" />
608 <xs:attribute name="min" type="xs:float" use="optional" />
609 <xs:attribute name="colourByLabel" type="xs:boolean"
611 <xs:attribute name="autoScale" type="xs:boolean"
615 <xs:element name="group" minOccurs="0" maxOccurs="unbounded">
617 <xs:attribute name="name" type="xs:string" use="required" />
618 <xs:attribute name="display" type="xs:boolean"
628 <xs:complexType name="feature">
630 <xs:element name="otherData" minOccurs="0" maxOccurs="unbounded">
632 <xs:attribute name="key" type="xs:string" use="required" />
633 <xs:attribute name="key2" type="xs:string" use="optional">
635 <xs:documentation>key2 may be used for a sub-attribute of key</xs:documentation>
638 <xs:attribute name="value" type="xs:string" use="required" />
642 <xs:attribute name="begin" type="xs:int" use="required" />
643 <xs:attribute name="end" type="xs:int" use="required" />
644 <xs:attribute name="type" type="xs:string" use="required" />
645 <xs:attribute name="description" type="xs:string" use="optional" />
646 <xs:attribute name="status" type="xs:string" use="optional" />
647 <xs:attribute name="featureGroup" type="xs:string" use="optional" />
648 <xs:attribute name="score" type="xs:float" use="optional" />
650 <xs:complexType name="pdbentry">
651 <xs:sequence minOccurs="0" maxOccurs="unbounded">
652 <xs:element name="property" minOccurs="0" maxOccurs="unbounded">
654 <xs:attribute name="name" type="xs:string" use="required" />
655 <xs:attribute name="value" type="xs:string" use="required" />
659 <xs:attribute name="id" type="xs:string" use="required" />
660 <xs:attribute name="type" type="xs:string" use="optional" />
661 <xs:attribute name="file" type="xs:string" />
663 <!-- <xs:complexType name="reportWindow"> <xs:annotation> <xs:documentation>Generic
664 type for windows containing mime-typed data associated with other jalview
665 windows</xs:documentation> </xs:annotation> <xs:sequence> </xs:sequence>
666 <xs:attribute name="id" type="xs:string" use="required"/> <xs:attribute name="type"
667 type="xs:string" use="optional"/> <xs:attribute name="file" type="xs:string"
668 use="optional"/> </xs:complexType> -->
669 <xs:attributeGroup name="swingwindow">
672 base attributes for windows displayed in Jalview
676 <xs:attribute name="width" type="xs:int" />
677 <xs:attribute name="height" type="xs:int" />
678 <xs:attribute name="xpos" type="xs:int" />
679 <xs:attribute name="ypos" type="xs:int" />
681 <xs:complexType name="AnnotationColourScheme">
682 <xs:attribute name="aboveThreshold" type="xs:int" />
683 <xs:attribute name="annotation" type="xs:string" />
684 <xs:attribute name="minColour" type="xs:int" />
685 <xs:attribute name="maxColour" type="xs:int" />
686 <xs:attribute name="colourScheme" type="xs:string" />
687 <xs:attribute name="threshold" type="xs:float" />
688 <xs:attribute name="perSequence" type="xs:boolean" use="optional" />
689 <xs:attribute name="predefinedColours" type="xs:boolean"
692 <xs:attributeGroup name="SimilarityParams">
695 parameters that condition a similarity score calculation
698 <xs:attribute name="includeGaps" type="xs:boolean" />
699 <xs:attribute name="matchGaps" type="xs:boolean" />
700 <xs:attribute name="includeGappedColumns" type="xs:boolean" />
701 <xs:attribute name="denominateByShortestLength" type="xs:boolean" />
703 <xs:attributeGroup name="position">
704 <xs:attribute name="xPos" type="xs:float" />
705 <xs:attribute name="yPos" type="xs:float" />
706 <xs:attribute name="zPos" type="xs:float" />
708 <xs:complexType name="PcaDataType">
711 The results of a PCA calculation
715 <xs:element name="pairwiseMatrix" type="jv:DoubleMatrix" />
716 <xs:element name="tridiagonalMatrix" type="jv:DoubleMatrix" />
717 <xs:element name="eigenMatrix" type="jv:DoubleMatrix" />
720 <xs:complexType name="DoubleVector">
722 <xs:element name="v" type="xs:double" minOccurs="0" maxOccurs="unbounded" />
725 <xs:complexType name="DoubleMatrix">
727 <xs:element name="row" type="jv:DoubleVector" minOccurs="0" maxOccurs="unbounded" />
728 <xs:element name="D" minOccurs="0" type="jv:DoubleVector" />
729 <xs:element name="E" minOccurs="0" type="jv:DoubleVector" />
731 <xs:attribute name="rows" type="xs:int" />
732 <xs:attribute name="columns" type="xs:int" />