Newer
Older
/* WriteMenu.java
*
* created: Mon Jan 11 1999
*
* This file is part of Artemis
*
* Copyright (C) 1998,1999,2000 Genome Research Limited
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
*
* $Header: //tmp/pathsoft/artemis/uk/ac/sanger/artemis/components/WriteMenu.java,v 1.12 2009-05-06 10:53:51 tjc Exp $
import uk.ac.sanger.artemis.EntryGroup;
import uk.ac.sanger.artemis.Feature;
import uk.ac.sanger.artemis.FeatureVector;
import uk.ac.sanger.artemis.Selection;
import uk.ac.sanger.artemis.sequence.Bases;
import uk.ac.sanger.artemis.sequence.MarkerRange;
import uk.ac.sanger.artemis.sequence.Strand;
import uk.ac.sanger.artemis.circular.TextFieldInt;
import uk.ac.sanger.artemis.io.EntryInformationException;
import uk.ac.sanger.artemis.io.Qualifier;
import uk.ac.sanger.artemis.io.StreamSequence;
import uk.ac.sanger.artemis.io.FastaStreamSequence;
import uk.ac.sanger.artemis.io.RawStreamSequence;
import uk.ac.sanger.artemis.io.EmblStreamSequence;
import uk.ac.sanger.artemis.io.GenbankStreamSequence;
import uk.ac.sanger.artemis.io.StreamSequenceFactory;
import java.awt.Dimension;
import java.awt.GridBagConstraints;
import java.awt.GridBagLayout;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
import java.io.File;
import java.io.FileWriter;
import java.io.IOException;
import java.io.PrintWriter;
import javax.swing.Box;
import javax.swing.JCheckBox;
import javax.swing.JFileChooser;
import javax.swing.JFrame;
import javax.swing.JLabel;
import javax.swing.JMenu;
import javax.swing.JMenuItem;
import javax.swing.JOptionPane;
import javax.swing.JPanel;
/**
* A menu of commands for writing out protein and bases.
*
* @author Kim Rutherford
* @version $Id: WriteMenu.java,v 1.12 2009-05-06 10:53:51 tjc Exp $
/**
* Create a new WriteMenu component.
* @param frame The JFrame that owns this JMenu.
* @param selection The Selection that the commands in the menu will
* operate on.
* @param entry_group The EntryGroup object to use when writing a sequence.
* @param menu_name The name of the new menu.
**/
public WriteMenu(final JFrame frame, final Selection selection,
final EntryGroup entry_group, final String menu_name)
final JMenuItem aa_item = new JMenuItem("Amino Acids Of Selected Features");
aa_item.addActionListener(new ActionListener()
{
public void actionPerformed(ActionEvent event)
{
writeAminoAcids();
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
final JMenuItem aa_to_qualifier_item = new JMenuItem("Amino Acids Of Selected Features to Qualifier");
aa_to_qualifier_item.addActionListener(new ActionListener()
{
public void actionPerformed(ActionEvent event)
{
final FeatureVector features_to_write =
getSelection().getAllFeatures();
try
{
for(int i = 0; i < features_to_write.size(); ++i)
{
final Feature selection_feature = features_to_write.elementAt(i);
final String translation_string =
selection_feature.getTranslation().toString().toUpperCase();
selection_feature.setQualifier(new Qualifier("translation", translation_string));
}
}
catch(ReadOnlyException e)
{
e.printStackTrace();
}
catch(EntryInformationException e)
{
e.printStackTrace();
}
}
});
add(aa_to_qualifier_item);
new JMenuItem("PIR Database Of Selected Features");
pir_item.addActionListener(new ActionListener()
{
public void actionPerformed(ActionEvent event)
{
writePIRDataBase();
final JMenu bases_menu = new JMenu("Bases Of Selection");
final JMenuItem raw_bases_item = new JMenuItem("Raw Format");
raw_bases_item.addActionListener(new ActionListener()
{
public void actionPerformed(ActionEvent event)
{
writeBasesOfSelection(StreamSequenceFactory.RAW_FORMAT);
final JMenuItem fasta_bases_item = new JMenuItem("FASTA Format");
fasta_bases_item.addActionListener(new ActionListener()
{
public void actionPerformed(ActionEvent event)
{
writeBasesOfSelection(StreamSequenceFactory.FASTA_FORMAT);
final JMenuItem embl_bases_item = new JMenuItem("EMBL Format");
embl_bases_item.addActionListener(new ActionListener()
{
public void actionPerformed(ActionEvent event)
{
writeBasesOfSelection(StreamSequenceFactory.EMBL_FORMAT);
final JMenuItem genbank_bases_item = new JMenuItem("Genbank Format");
genbank_bases_item.addActionListener(new ActionListener()
{
public void actionPerformed(ActionEvent event)
{
writeBasesOfSelection(StreamSequenceFactory.GENBANK_FORMAT);
// final JMenu exons_menu = new JMenu("Exons Of Selection");
// final JMenuItem fasta_exons_item = new JMenuItem("Multiple FASTA Format");
// fasta_exons_item.addActionListener(new ActionListener()
// {
// public void actionPerformed(ActionEvent event)
// {
// writeExonsOfSelection(StreamSequenceFactory.FASTA_FORMAT);
// }
// });
// exons_menu.add(fasta_exons_item);
// add(exons_menu);
new JMenu("Upstream Bases Of Selected Features");
final JMenuItem raw_upstream_bases_item = new JMenuItem("Raw Format");
raw_upstream_bases_item.addActionListener(new ActionListener()
{
public void actionPerformed(ActionEvent event)
{
writeUpstreamBases(StreamSequenceFactory.RAW_FORMAT);
final JMenuItem fasta_upstream_bases_item = new JMenuItem("FASTA Format");
fasta_upstream_bases_item.addActionListener(new ActionListener()
{
public void actionPerformed(ActionEvent event)
{
writeUpstreamBases(StreamSequenceFactory.FASTA_FORMAT);
upstream_bases_menu.add(fasta_upstream_bases_item);
final JMenuItem embl_upstream_bases_item = new JMenuItem("EMBL Format");
embl_upstream_bases_item.addActionListener(new ActionListener()
{
public void actionPerformed(ActionEvent event)
{
writeUpstreamBases(StreamSequenceFactory.EMBL_FORMAT);
final JMenuItem genbank_upstream_bases_item = new JMenuItem("Genbank Format");
genbank_upstream_bases_item.addActionListener(new ActionListener()
{
public void actionPerformed(ActionEvent event)
{
writeUpstreamBases(StreamSequenceFactory.GENBANK_FORMAT);
new JMenu("Downstream Bases Of Selected Features");
final JMenuItem raw_downstream_bases_item = new JMenuItem("Raw Format");
raw_downstream_bases_item.addActionListener(new ActionListener()
{
public void actionPerformed(ActionEvent event)
{
writeDownstreamBases(StreamSequenceFactory.RAW_FORMAT);
final JMenuItem fasta_downstream_bases_item = new JMenuItem("FASTA Format");
fasta_downstream_bases_item.addActionListener(new ActionListener()
{
public void actionPerformed(ActionEvent event)
{
writeDownstreamBases(StreamSequenceFactory.FASTA_FORMAT);
final JMenuItem embl_downstream_bases_item = new JMenuItem("EMBL Format");
embl_downstream_bases_item.addActionListener(new ActionListener()
{
public void actionPerformed(ActionEvent event)
{
writeDownstreamBases(StreamSequenceFactory.EMBL_FORMAT);
new JMenuItem("Genbank Format");
genbank_downstream_bases_item.addActionListener(new ActionListener()
{
public void actionPerformed(ActionEvent event)
{
writeDownstreamBases(StreamSequenceFactory.GENBANK_FORMAT);
addSeparator();
final JMenuItem write_combo_bases = new JMenuItem("Upstream+Feature+Downstream Bases ...");
write_combo_bases.addActionListener(new ActionListener()
{
public void actionPerformed(ActionEvent event)
{
writeComboBases();
}
});
add(write_combo_bases);
final JMenuItem write_raw_item = new JMenuItem("Raw Format");
write_raw_item.addActionListener(new ActionListener()
{
public void actionPerformed(ActionEvent event)
{
writeAllSequence(StreamSequenceFactory.RAW_FORMAT);
final JMenuItem write_fasta_item = new JMenuItem("FASTA Format");
write_fasta_item.addActionListener(new ActionListener()
{
public void actionPerformed(ActionEvent event)
{
writeAllSequence(StreamSequenceFactory.FASTA_FORMAT);
final JMenuItem write_embl_item = new JMenuItem("EMBL Format");
write_embl_item.addActionListener(new ActionListener()
{
public void actionPerformed(ActionEvent event)
{
writeAllSequence(StreamSequenceFactory.EMBL_FORMAT);
final JMenuItem write_genbank_item = new JMenuItem("Genbank Format");
write_genbank_item.addActionListener(new ActionListener()
{
public void actionPerformed(ActionEvent event)
{
writeAllSequence(StreamSequenceFactory.GENBANK_FORMAT);
codon_usage_item.addActionListener(new ActionListener()
{
public void actionPerformed(ActionEvent event)
{
writeCodonUsage();
}
/**
* Create a new WriteMenu component.
* @param frame The JFrame that owns this JMenu.
* @param selection The Selection that the commands in the menu will
* operate on.
* @param entry_group The EntryGroup object to use when writing a sequence.
**/
final EntryGroup entry_group)
{
this(frame, selection, entry_group, "Write");
}
/**
* Write a PIR database of the selected features to a file choosen by the
* user.
**/
getWriteFile("Select a PIR output file name ...", "cosmid.pir", null);
for(int i = 0; i < features_to_write.size() ; ++i)
{
final Feature selection_feature = features_to_write.elementAt(i);
selection_feature.writePIROfFeature(writer);
writer.close();
}
catch(IOException e)
{
new MessageDialog(getParentFrame(),
"error while writing: " + e.getMessage());
}
}
/**
* Write the amino acid symbols of the selected features to a file choosen
* by the user.
**/
for(int i = 0; i < features_to_write.size(); ++i)
{
final Feature selection_feature = features_to_write.elementAt(i);
selection_feature.writeAminoAcidsOfFeature(writer);
writer.close();
}
catch(IOException e)
{
new MessageDialog(getParentFrame(),
"error while writing: " + e.getMessage());
}
}
/**
* Write the bases of the selection to a file choosen by the user.
* @param output_type One of EMBL_FORMAT, RAW_FORMAT etc.
**/
private void writeBasesOfSelection(final int output_type)
{
final MarkerRange marker_range = getSelection().getMarkerRange();
else
{
final String selection_bases = Strand.markerRangeBases(marker_range);
writeBases(selection_bases, "selected bases",
getSequenceFileName(output_type),
output_type);
/**
* Write the bases of the selected features to a file choosen by the user
* or show a message and return immediately if there are no selected
* features.
* @param sequence The sequence to be written.
* @param header The header line that will be used on those output formats
* that need it.
* @param default_output_filename The filename that is passed to
JTextField headerField = null;
if(output_type == StreamSequenceFactory.FASTA_FORMAT ||
output_type == StreamSequenceFactory.EMBL_FORMAT)
headerField = new JTextField(header);
final File write_file = getWriteFile("Select an output file name ...",
default_output_filename, headerField);
if(headerField != null && !headerField.getText().equals(""))
header = headerField.getText().trim();
stream_sequence = new FastaStreamSequence(sequence, header);
stream_sequence = new EmblStreamSequence(sequence);
if(headerField != null && !headerField.getText().equals(""))
{
header = "ID "+headerField.getText().trim();
header = header.concat("\nFH Key "+
"Location/Qualifiers\nFH\n");
((EmblStreamSequence)stream_sequence).setHeader(header);
}
stream_sequence.writeToStream(writer);
writer.close();
}
catch(IOException e)
{
new MessageDialog(getParentFrame(),
"error while writing: " + e.getMessage());
/**
*
* Write selected exons to a mutiple FASTA file.
*
*/
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
private void writeExonsOfSelection(final int output_type)
{
if(!checkForSelectionFeatures())
return;
final File write_file =
getWriteFile("Select an output file name ...", "exons", null);
if(write_file == null)
return;
try
{
final FileWriter writer = new FileWriter(write_file);
final FeatureVector features_to_write =
getSelection().getAllFeatures();
for(int i = 0; i < features_to_write.size(); ++i)
{
final Feature selection_feature = features_to_write.elementAt(i);
final StringBuffer header_buffer = new StringBuffer();
header_buffer.append(selection_feature.getSystematicName());
header_buffer.append(" ");
header_buffer.append(selection_feature.getIDString());
header_buffer.append(" ");
final String product = selection_feature.getProductString();
if(product == null)
header_buffer.append("undefined product");
else
header_buffer.append(product);
int seg_size = selection_feature.getSegments().size();
for(int j = 0; j < seg_size; ++j)
{
String bases = selection_feature.getSegments().elementAt(j).getBases();
Range range = selection_feature.getSegments().elementAt(j).getRawRange();
String s_range = " "+range.getStart()+":"+range.getEnd();
if(selection_feature.isForwardFeature())
s_range = s_range+" forward";
else
s_range = s_range+" reverse";
final StreamSequence stream_sequence =
getStreamSequence(bases,
header_buffer.toString()+s_range,
output_type);
stream_sequence.writeToStream(writer);
}
}
writer.close();
}
catch(IOException e)
{
new MessageDialog(getParentFrame(),
"error while writing: " + e.getMessage());
}
}
/**
* Write the bases of the selected features to a file choosen by the user
* or show a message and return immediately if there are no selected
* features.
* @param output_type One of EMBL_FORMAT, RAW_FORMAT etc.
**/
private void writeFeatureBases(final int output_type)
{
if(!checkForSelectionFeatures())
for(int i = 0; i < features_to_write.size(); ++i)
{
final Feature selection_feature = features_to_write.elementAt(i);
final StringBuffer header_buffer = new StringBuffer();
header_buffer.append(selection_feature.getSystematicName());
header_buffer.append(" ");
header_buffer.append(selection_feature.getIDString());
header_buffer.append(" ");
if(product == null)
header_buffer.append("undefined product");
else
header_buffer.append(product);
getStreamSequence(selection_feature.getBases(),
header_buffer.toString(),
output_type);
writer.close();
}
catch(IOException e)
{
new MessageDialog(getParentFrame(),
"error while writing: " + e.getMessage());
}
}
/**
* Return a StreamSequence object for the given sequence string and the
* given type.
* @param sequence A String containing the sequence.
* @param header The header line that will be used on those output formats
* that need it.
* @param output_type One of EMBL_FORMAT, RAW_FORMAT etc.
**/
private StreamSequence getStreamSequence(final String sequence,
final String header,
final int output_type)
{
switch(output_type)
{
case StreamSequenceFactory.FASTA_FORMAT:
return new FastaStreamSequence (sequence, header);
case StreamSequenceFactory.EMBL_FORMAT:
return new EmblStreamSequence (sequence);
case StreamSequenceFactory.GENBANK_FORMAT:
return new GenbankStreamSequence (sequence);
case StreamSequenceFactory.RAW_FORMAT:
default:
return new RawStreamSequence (sequence);
}
}
/**
* Write the upstream bases of the selected features to a file choosen by
* the user. The user can also choose the number of upstream base to
* write.
* @param output_type One of EMBL_FORMAT, RAW_FORMAT etc.
**/
private void writeUpstreamBases(final int output_type)
{
if(!checkForSelectionFeatures())
new TextRequester("write how many bases upstream of each feature?",
18, "");
text_requester.addTextRequesterListener(new TextRequesterListener()
{
public void actionPerformed(final TextRequesterEvent event)
{
if(event.getType() == TextRequesterEvent.CANCEL)
if(base_count_string.length() == 0)
{
new MessageDialog(getParentFrame(), "no bases written");
selection_feature.getIDString() + " - " +
sequence_string.length() + " bases upstream";
writer.close();
}
catch(IOException e)
{
new MessageDialog(getParentFrame(),
"error while writing: " + e.getMessage());
}
catch(NumberFormatException e)
{
new MessageDialog(getParentFrame(),
"this is not a number: " + base_count_string);
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
/**
* Write a combination of upstream + feature + downstream bases for
* selected features.
*/
private void writeComboBases()
{
TextFieldInt upstreamBases = new TextFieldInt();
upstreamBases.setValue(0);
Dimension preferredSize = new Dimension(200,
upstreamBases.getPreferredSize().height);
upstreamBases.setPreferredSize(preferredSize);
TextFieldInt downstreamBases = new TextFieldInt();
downstreamBases.setValue(0);
downstreamBases.setPreferredSize(preferredSize);
TextFieldInt featureBases = new TextFieldInt();
featureBases.setValue(0);
featureBases.setPreferredSize(preferredSize);
JCheckBox allFeatureBases = new JCheckBox("All bases of the feature(s)", false);
int row = 0;
JPanel gridPanel = new JPanel(new GridBagLayout());
GridBagConstraints c = new GridBagConstraints();
c.gridx = 0;
c.gridy = row;
c.anchor = GridBagConstraints.WEST;
gridPanel.add(new JLabel("Number of bases upstream of each feature to write:"), c);
c.gridy = ++row;
gridPanel.add(upstreamBases, c);
c.gridy = ++row;
gridPanel.add(Box.createVerticalStrut(15), c);
c.gridy = ++row;
gridPanel.add(new JLabel("Number of feature bases to write:"), c);
c.gridy = ++row;
gridPanel.add(featureBases, c);
c.gridy = ++row;
gridPanel.add(allFeatureBases, c);
c.gridy = ++row;
gridPanel.add(Box.createVerticalStrut(15), c);
c.gridy = ++row;
gridPanel.add(new JLabel("Number of bases downstream of each feature to write:"),c);
c.gridy = ++row;
gridPanel.add(downstreamBases, c);
JOptionPane.showMessageDialog(null, gridPanel,
"Bases to write to FASTA file for selected features",
JOptionPane.QUESTION_MESSAGE);
int output_type = StreamSequenceFactory.FASTA_FORMAT;
final File write_file =
getWriteFile("Select an output file name ...",
"bases_" + getSequenceFileName(output_type), null);
if(write_file == null)
return;
try
{
final FileWriter writer = new FileWriter(write_file);
final FeatureVector features_to_write =
getSelection().getAllFeatures();
int upstream_base_count = upstreamBases.getValue();
int downstream_base_count = downstreamBases.getValue();
int feature_base_count = featureBases.getValue();
for(int i = 0; i < features_to_write.size(); ++i)
{
final Feature selection_feature =
features_to_write.elementAt(i);
String header_line =
selection_feature.getIDString();
StringBuffer sequenceBuff = new StringBuffer();
if(upstream_base_count > 0)
sequenceBuff.append(
selection_feature.getUpstreamBases(upstream_base_count));
header_line = header_line.concat(" : upstream - "+upstream_base_count);
}
if(allFeatureBases.isSelected())
{
String bases = selection_feature.getBases();
sequenceBuff.append(bases);
header_line = header_line.concat(" : complete feature - "+bases.length());
}
else if (feature_base_count > 0)
sequenceBuff.append(
selection_feature.getBases().substring(0, feature_base_count));
header_line = header_line.concat(" : feature - "+feature_base_count);
}
if(downstream_base_count > 0)
sequenceBuff.append(
selection_feature.getDownstreamBases(downstream_base_count));
header_line = header_line.concat(" : downstream - "+downstream_base_count);
}
final StreamSequence stream_sequence =
getStreamSequence(sequenceBuff.toString(),
header_line,
output_type);
stream_sequence.writeToStream(writer);
}
writer.close();
}
catch(IOException e)
{
new MessageDialog(getParentFrame(),
"error while writing: " + e.getMessage());
}
if(write_file == null)
return;
}
/**
* Write the downstream bases of the selected features to a file choosen by
* the user. The user can also choose the number of downstream base to
* write.
* @param output_type One of EMBL_FORMAT, RAW_FORMAT etc.
**/
private void writeDownstreamBases(final int output_type)
{
if(!checkForSelectionFeatures())
text_requester.addTextRequesterListener(new TextRequesterListener()
{
public void actionPerformed(final TextRequesterEvent event)
{
if(event.getType() == TextRequesterEvent.CANCEL)
if(base_count_string.length() == 0)
{
new MessageDialog(getParentFrame(), "no bases written");
selection_feature.getIDString() + " - " +
sequence_string.length() + " bases downstream ";