Class | Line # | Actions | |||
---|---|---|---|---|---|
AlignExportSettingsI | 29 | 0 | 0 |
1 | /* | |
2 | * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$) | |
3 | * Copyright (C) $$Year-Rel$$ The Jalview Authors | |
4 | * | |
5 | * This file is part of Jalview. | |
6 | * | |
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. | |
11 | * | |
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. | |
16 | * | |
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. | |
20 | */ | |
21 | ||
22 | package jalview.api; | |
23 | ||
24 | /** | |
25 | * An interface describing settings for including or excluding data when an | |
26 | * alignment is output | |
27 | * | |
28 | */ | |
29 | public interface AlignExportSettingsI | |
30 | { | |
31 | /** | |
32 | * Answers true if hidden sequences should be exported, false if not | |
33 | * | |
34 | * @return | |
35 | */ | |
36 | boolean isExportHiddenSequences(); | |
37 | ||
38 | /** | |
39 | * Answers true if hidden columns should be exported, false if not | |
40 | * | |
41 | * @return | |
42 | */ | |
43 | boolean isExportHiddenColumns(); | |
44 | ||
45 | /** | |
46 | * Answers true if Annotations should be exported. This is available for | |
47 | * complex flat file exports like JSON, HTML, GFF. | |
48 | * | |
49 | * @return | |
50 | */ | |
51 | boolean isExportAnnotations(); | |
52 | ||
53 | /** | |
54 | * Answers true if Sequence Features should be exported. This is available for | |
55 | * complex flat file exports like JSON, HTML, GFF. | |
56 | * | |
57 | * @return | |
58 | */ | |
59 | boolean isExportFeatures(); | |
60 | ||
61 | /** | |
62 | * Answers true if Sequence Groups should be exported. This is available for | |
63 | * complex flat file exports like JSON, HTML, GFF. | |
64 | * | |
65 | * @return | |
66 | */ | |
67 | boolean isExportGroups(); | |
68 | ||
69 | void setExportHiddenSequences(boolean b); | |
70 | ||
71 | void setExportHiddenColumns(boolean b); | |
72 | ||
73 | void setExportAnnotations(boolean b); | |
74 | ||
75 | void setExportFeatures(boolean b); | |
76 | ||
77 | void setExportGroups(boolean b); | |
78 | } |