Jalview.isJS() --> Platform.isJS(), DBRefEntry[] --> List<DBRefEntry>
[jalview.git] / src / jalview / gui / AnnotationExporter.java
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 package jalview.gui;
22
23 import jalview.api.FeatureColourI;
24 import jalview.bin.Cache;
25 import jalview.datamodel.AlignmentAnnotation;
26 import jalview.datamodel.SequenceI;
27 import jalview.datamodel.features.FeatureMatcherSetI;
28 import jalview.io.AnnotationFile;
29 import jalview.io.FeaturesFile;
30 import jalview.io.JalviewFileChooser;
31 import jalview.io.JalviewFileView;
32 import jalview.util.MessageManager;
33
34 import java.awt.BorderLayout;
35 import java.awt.Color;
36 import java.awt.FlowLayout;
37 import java.awt.event.ActionEvent;
38 import java.awt.event.ActionListener;
39 import java.io.FileWriter;
40 import java.io.PrintWriter;
41 import java.util.List;
42 import java.util.Map;
43
44 import javax.swing.BorderFactory;
45 import javax.swing.ButtonGroup;
46 import javax.swing.JButton;
47 import javax.swing.JInternalFrame;
48 import javax.swing.JLabel;
49 import javax.swing.JLayeredPane;
50 import javax.swing.JPanel;
51 import javax.swing.JRadioButton;
52 import javax.swing.SwingConstants;
53
54 /**
55  * 
56  * GUI dialog for exporting features or alignment annotations depending upon
57  * which method is called.
58  * 
59  * @author AMW
60  * 
61  */
62 public class AnnotationExporter extends JPanel
63 {
64   private JInternalFrame frame;
65
66   private AlignmentPanel ap;
67
68   /*
69    * true if exporting features, false if exporting annotations
70    */
71   private boolean exportFeatures = true;
72
73   private AlignmentAnnotation[] annotations;
74
75   private boolean wholeView;
76
77   public AnnotationExporter(AlignmentPanel panel)
78   {
79     this.ap = panel;
80     try
81     {
82       jbInit();
83     } catch (Exception ex)
84     {
85       ex.printStackTrace();
86     }
87
88     frame = new JInternalFrame();
89     frame.setContentPane(this);
90     frame.setLayer(JLayeredPane.PALETTE_LAYER);
91     Desktop.addInternalFrame(frame, "", frame.getPreferredSize().width,
92             frame.getPreferredSize().height);
93   }
94
95   /**
96    * Configures the diglog for options to export visible features
97    */
98   public void exportFeatures()
99   {
100     exportFeatures = true;
101     CSVFormat.setVisible(false);
102     frame.setTitle(MessageManager.getString("label.export_features"));
103   }
104
105   /**
106    * Configures the dialog for options to export all visible annotations
107    */
108   public void exportAnnotations()
109   {
110     boolean showAnnotation = ap.av.isShowAnnotation();
111     exportAnnotation(showAnnotation ? null
112             : ap.av.getAlignment().getAlignmentAnnotation(), true);
113   }
114
115   /**
116    * Configures the dialog for options to export the given annotation row
117    * 
118    * @param toExport
119    */
120   public void exportAnnotation(AlignmentAnnotation toExport)
121   {
122     exportAnnotation(new AlignmentAnnotation[] { toExport }, false);
123   }
124
125   private void exportAnnotation(AlignmentAnnotation[] toExport,
126           boolean forWholeView)
127   {
128     wholeView = forWholeView;
129     annotations = toExport;
130     exportFeatures = false;
131     GFFFormat.setVisible(false);
132     CSVFormat.setVisible(true);
133     frame.setTitle(MessageManager.getString("label.export_annotations"));
134   }
135
136   private void toFile_actionPerformed()
137   {
138     // TODO: JAL-3048 JalviewFileChooser - Save option
139     JalviewFileChooser chooser = new JalviewFileChooser(
140             Cache.getProperty("LAST_DIRECTORY"));
141
142     chooser.setFileView(new JalviewFileView());
143     chooser.setDialogTitle(exportFeatures
144             ? MessageManager.getString("label.save_features_to_file")
145             : MessageManager.getString("label.save_annotation_to_file"));
146     chooser.setToolTipText(MessageManager.getString("action.save"));
147
148     int value = chooser.showSaveDialog(this);
149
150     if (value == JalviewFileChooser.APPROVE_OPTION)
151     {
152       String text = getText();
153
154       try
155       {
156         PrintWriter out = new PrintWriter(
157                 new FileWriter(chooser.getSelectedFile()));
158         out.print(text);
159         out.close();
160       } catch (Exception ex)
161       {
162         ex.printStackTrace();
163       }
164     }
165
166     close_actionPerformed();
167   }
168
169   /**
170    * Answers the text to output for either Features (in GFF or Jalview format) or
171    * Annotations (in CSV or Jalview format)
172    * 
173    * @return
174    */
175   private String getText()
176   {
177     return exportFeatures ? getFeaturesText() : getAnnotationsText();
178   }
179
180   /**
181    * Returns the text contents for output of annotations in either CSV or Jalview
182    * format
183    * 
184    * @return
185    */
186   private String getAnnotationsText()
187   {
188     String text;
189     if (CSVFormat.isSelected())
190     {
191       text = new AnnotationFile().printCSVAnnotations(annotations);
192     }
193     else
194     {
195       if (wholeView)
196       {
197         text = new AnnotationFile().printAnnotationsForView(ap.av);
198       }
199       else
200       {
201         text = new AnnotationFile().printAnnotations(annotations, null,
202                 null);
203       }
204     }
205     return text;
206   }
207
208   /**
209    * Returns the text contents for output of features in either GFF or Jalview
210    * format
211    * 
212    * @return
213    */
214   private String getFeaturesText()
215   {
216     String text;
217     SequenceI[] sequences = ap.av.getAlignment().getSequencesArray();
218     Map<String, FeatureColourI> featureColours = ap.getFeatureRenderer()
219             .getDisplayedFeatureCols();
220     Map<String, FeatureMatcherSetI> featureFilters = ap.getFeatureRenderer()
221             .getFeatureFilters();
222     List<String> featureGroups = ap.getFeatureRenderer()
223             .getDisplayedFeatureGroups();
224     boolean includeNonPositional = ap.av.isShowNPFeats();
225
226     FeaturesFile formatter = new FeaturesFile();
227     if (GFFFormat.isSelected())
228     {
229       text = formatter.printGffFormat(sequences, featureColours,
230               featureGroups, includeNonPositional);
231     }
232     else
233     {
234       text = formatter.printJalviewFormat(sequences, featureColours,
235               featureFilters, featureGroups, includeNonPositional);
236     }
237     return text;
238   }
239
240   private void toTextbox_actionPerformed()
241   {
242     CutAndPasteTransfer cap = new CutAndPasteTransfer();
243
244     try
245     {
246       String text = getText();
247       cap.setText(text);
248       Desktop.addInternalFrame(cap, (exportFeatures ? MessageManager
249               .formatMessage("label.features_for_params", new String[]
250               { ap.alignFrame.getTitle() })
251               : MessageManager.formatMessage("label.annotations_for_params",
252                       new String[]
253                       { ap.alignFrame.getTitle() })),
254               600, 500);
255     } catch (OutOfMemoryError oom)
256     {
257       new OOMWarning((exportFeatures ? MessageManager.formatMessage(
258               "label.generating_features_for_params", new String[]
259               { ap.alignFrame.getTitle() })
260               : MessageManager.formatMessage(
261                       "label.generating_annotations_for_params",
262                       new String[]
263                       { ap.alignFrame.getTitle() })),
264               oom);
265       cap.dispose();
266     }
267
268     close_actionPerformed();
269   }
270
271   private void close_actionPerformed()
272   {
273     try
274     {
275       frame.setClosed(true);
276     } catch (java.beans.PropertyVetoException ex)
277     {
278     }
279   }
280
281   private void jbInit() throws Exception
282   {
283     this.setLayout(new BorderLayout());
284
285     toFile.setText(MessageManager.getString("label.to_file"));
286     toFile.addActionListener(new ActionListener()
287     {
288       @Override
289       public void actionPerformed(ActionEvent e)
290       {
291         toFile_actionPerformed();
292       }
293     });
294     toTextbox.setText(MessageManager.getString("label.to_textbox"));
295     toTextbox.addActionListener(new ActionListener()
296     {
297       @Override
298       public void actionPerformed(ActionEvent e)
299       {
300         toTextbox_actionPerformed();
301       }
302     });
303     close.setText(MessageManager.getString("action.close"));
304     close.addActionListener(new ActionListener()
305     {
306       @Override
307       public void actionPerformed(ActionEvent e)
308       {
309         close_actionPerformed();
310       }
311     });
312     jalviewFormat.setOpaque(false);
313     jalviewFormat.setSelected(true);
314     jalviewFormat.setText("Jalview");
315     GFFFormat.setOpaque(false);
316     GFFFormat.setText("GFF");
317     CSVFormat.setOpaque(false);
318     CSVFormat.setText(MessageManager.getString("label.csv_spreadsheet"));
319     jLabel1.setHorizontalAlignment(SwingConstants.TRAILING);
320     jLabel1.setText(MessageManager.getString("action.format") + " ");
321     this.setBackground(Color.white);
322     jPanel3.setBorder(BorderFactory.createEtchedBorder());
323     jPanel3.setOpaque(false);
324     jPanel1.setOpaque(false);
325     jPanel1.add(toFile);
326     jPanel1.add(toTextbox);
327     jPanel1.add(close);
328     jPanel3.add(jLabel1);
329     jPanel3.add(jalviewFormat);
330     jPanel3.add(GFFFormat);
331     jPanel3.add(CSVFormat);
332     buttonGroup.add(jalviewFormat);
333     buttonGroup.add(GFFFormat);
334     buttonGroup.add(CSVFormat);
335     this.add(jPanel3, BorderLayout.CENTER);
336     this.add(jPanel1, BorderLayout.SOUTH);
337   }
338
339   JPanel jPanel1 = new JPanel();
340
341   JButton toFile = new JButton();
342
343   JButton toTextbox = new JButton();
344
345   JButton close = new JButton();
346
347   ButtonGroup buttonGroup = new ButtonGroup();
348
349   JRadioButton jalviewFormat = new JRadioButton();
350
351   JRadioButton GFFFormat = new JRadioButton();
352
353   JRadioButton CSVFormat = new JRadioButton();
354
355   JLabel jLabel1 = new JLabel();
356
357   JPanel jPanel3 = new JPanel();
358
359   FlowLayout flowLayout1 = new FlowLayout();
360 }