Newer
Older
/* GFFDocumentEntry.java
*
* created: Tue Sep 14 1999
*
* This file is part of Artemis
*
*
* 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/io/GFFDocumentEntry.java,v 1.26 2006-07-04 11:05:49 tjc Exp $
*/
package uk.ac.sanger.artemis.io;
import uk.ac.sanger.artemis.util.*;
/**
* A DocumentEntry that can read an GFF entry from a Document.
*
* @author Kim Rutherford
* @version $Id: GFFDocumentEntry.java,v 1.26 2006-07-04 11:05:49 tjc Exp $
/**
* Create a new GFFDocumentEntry object associated with the given
* Document.
* @param document This is the file that we will read from. This is also
* used for saving the entry back to the file it came from and to give
* the new object a name.
* @param listener The object that will listen for ReadEvents.
* @exception IOException thrown if there is a problem reading the entry -
* most likely ReadFormatException.
**/
GFFDocumentEntry(final Document document, final ReadListener listener)
throws IOException, EntryInformationException
{
super(new GFFEntryInformation(), document, listener);
finished_constructor = true;
}
/**
* Create a new GFFDocumentEntry that will be a copy of the given Entry and
* has no Document associated with it. The new GFFDocumentEntry cannot be
* saved to a file with save() unless save(Document) has been called
* first. Some qualifier and location information will be lost.
* @param force If true then invalid qualifiers and any features with
* invalid keys in the new Entry will be quietly thrown away. "Invalid"
* means that the key/qualifier is not allowed to occur in an Entry of
* this type (probably determined by the EntryInformation object of this
* Entry). If false an EntryInformationException will be thrown for
* invalid keys or qualifiers.
**/
public GFFDocumentEntry(final Entry new_entry, final boolean force)
throws EntryInformationException
{
super(new GFFEntryInformation(), new_entry, force);
finished_constructor = true;
}
/**
* Create a new empty GFFDocumentEntry object that has no Document
* associated with it. The new GFFDocumentEntry cannot be saved to a
* file with save() unless save(Document) has been called first. The
* save(Document) method will assign a Document.
public GFFDocumentEntry(final EntryInformation entry_information)
{
super(new GFFEntryInformation());
finished_constructor = true;
}
/**
* Returns true if and only if this entry is read only. For now this
* always returns true - GFFDocumentEntry objects can't be changed.
**/
}
/**
* If the given feature can be added directly to this Entry, then return
* it, otherwise create and return a new feature of the appropriate type.
* @param copy if true then always new a new copy of the Feature.
**/
protected SimpleDocumentFeature makeNativeFeature(final Feature feature,
final boolean copy)
{
if(!copy && feature instanceof GFFStreamFeature)
return (GFFStreamFeature)feature;
else
return new GFFStreamFeature(feature);
}
/**
* If the given Sequence can be added directly to this Entry, then return a
* copy of it, otherwise create and return a new feature of the appropriate
* type for this Entry.
**/
protected StreamSequence makeNativeSequence(final Sequence sequence)
{
return new FastaStreamSequence(sequence);
private void combineGeneFeatures()
{
final FeatureVector original_features = getAllFeatures();
Feature this_feature;
Hashtable chado_gene = new Hashtable();
try
{
// find the genes
for(int i = 0 ; i < original_features.size() ; ++i)
{
this_feature = original_features.featureAt(i);
String key = this_feature.getKey().getKeyString();
if(key.equals("gene"))
{
String id = (String)this_feature.getQualifierByName("ID").getValues().get(0);
ChadoCanonicalGene gene = new ChadoCanonicalGene();
gene.setGene(this_feature);
chado_gene.put(id, gene);
((GFFStreamFeature)this_feature).setChadoGene(gene);
}
}
for(int i = 0 ; i < original_features.size() ; ++i)
{
this_feature = original_features.featureAt(i);
// transcript
Qualifier parent_qualifier = this_feature.getQualifierByName("Parent");
if(parent_qualifier == null)
continue;
StringVector parents = parent_qualifier.getValues();
for(int j=0; j<parents.size(); j++)
{
String parent = (String)parents.get(j);
if(chado_gene.containsKey(parent))
{
// store transcript
ChadoCanonicalGene gene = (ChadoCanonicalGene)chado_gene.get(parent);
gene.addTranscript(this_feature);
// store the transcript ID with its ChadoCanonicalGene object
transcripts_lookup.put((String)this_feature.getQualifierByName("ID").getValues().get(0),
gene);
// find exons & protein
for(int i = 0 ; i < original_features.size() ; ++i)
{
this_feature = original_features.featureAt(i);
// exons
String key = this_feature.getKey().getKeyString();
if(!key.equals("exon") && !key.equals("polypeptide"))
continue;
Qualifier parent_qualifier = this_feature.getQualifierByName("Parent");
Qualifier derives_qualifier = this_feature.getQualifierByName("Derives_from");
if(parent_qualifier == null && derives_qualifier == null)
continue;
// compare this features parent_id's to transcript id's in the
// chado gene hash to decide if it is part of it
final StringVector parent_id;
if(parent_qualifier != null)
parent_id = parent_qualifier.getValues();
else
parent_id = derives_qualifier.getValues();
for(int j=0; j<parent_id.size(); j++)
{
String parent = (String)parent_id.get(j);
if(transcripts_lookup.containsKey(parent))
{
ChadoCanonicalGene gene = (ChadoCanonicalGene)transcripts_lookup.get(parent);
if(parent_qualifier == null)
gene.addProtein(parent, this_feature);
else
gene.addExon(parent, this_feature);
}
}
/*
Enumeration enum_genes = chado_gene.elements();
while(enum_genes.hasMoreElements())
{
ChadoCanonicalGene gene = (ChadoCanonicalGene)enum_genes.nextElement();
Feature transcript = (Feature)gene.containsTranscript(parent_id);
if(transcript != null)
{
if(parent_qualifier == null)
gene.addProtein((String)transcript.getQualifierByName("ID").getValues().get(0),
this_feature);
gene.addExon((String)transcript.getQualifierByName("ID").getValues().get(0),
this_feature);
Enumeration enum_genes = chado_gene.elements();
while(enum_genes.hasMoreElements())
{
ChadoCanonicalGene gene = (ChadoCanonicalGene)enum_genes.nextElement();
combineChadoExons(gene);
}
}
catch(InvalidRelationException e)
{
e.printStackTrace();
}
}
/**
* Join the separate exons into one feature (if appropriate).
**/
private void combineFeatures()
{
final FeatureVector original_features = getAllFeatures();
// the key of these hashes will be the group name and the value is a
// FeatureVector containing the feature that are in that group
final Hashtable forward_feature_groups = new Hashtable();
final Hashtable reverse_feature_groups = new Hashtable();
for(int i = 0 ; i < original_features.size() ; ++i)
{
if(key.equals("CDS") || key.equals("polypeptide_domain") ||
key.equals("polypeptide") || key.equals("exon"))
if(this_feature.getQualifierByName("ID") != null &&
!key.equals("exon"))
{
values =
this_feature.getQualifierByName("ID").getValues();
group_name = group_name+values.elementAt(0);
}
final FeatureVector other_features =
(FeatureVector) this_strand_feature_groups.get(group_name);
if(other_features == null)
final FeatureVector new_feature_vector = new FeatureVector();
new_feature_vector.add(this_feature);
this_strand_feature_groups.put(group_name, new_feature_vector);
}
}
catch(InvalidRelationException e)
{
throw new Error("internal error - unexpected exception: " + e);
combineFeaturesFromHash(forward_feature_groups);
combineFeaturesFromHash(reverse_feature_groups);
/**
* Combine the features (which are exons) and delete the orignals from this
* Entry. The key of this hash will be the group name and the value is a
* FeatureVector containing the feature that are in that group. Groups
* that have more than one member will be combined.
**/
public void combineChadoExons(ChadoCanonicalGene gene)
{
Hashtable exons = gene.getExons();
final Enumeration enum_exons = exons.keys();
final RangeVector new_range_vector = new RangeVector();
QualifierVector qualifier_vector = new QualifierVector();
Hashtable id_range_store = new Hashtable();
Timestamp lasttimemodified = null;
while(enum_exons.hasMoreElements())
{
String transcript_id = (String)enum_exons.nextElement();
Vector v_exons = (Vector)exons.get(transcript_id);
for(int i=0; i<v_exons.size(); i++)
{
final GFFStreamFeature this_feature =
(GFFStreamFeature)v_exons.get(i);
// use the most current lastmodified datestamp
if(this_feature.getLastModified() != null &&
(lasttimemodified == null ||
this_feature.getLastModified().compareTo(lasttimemodified) > 0))
lasttimemodified = this_feature.getLastModified();
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
final Location this_feature_location = this_feature.getLocation();
if(this_feature_location.getRanges().size() > 1)
{
throw new Error("internal error - new location should have " +
"exactly one range");
}
final Range new_range =
(Range)this_feature_location.getRanges().elementAt(0);
Qualifier id_qualifier = this_feature.getQualifierByName("ID");
if(id_qualifier != null)
{
String id = (String)(id_qualifier.getValues()).elementAt(0);
id_range_store.put(new_range, id);
}
if(this_feature_location.isComplement())
new_range_vector.insertElementAt(new_range, 0);
else
new_range_vector.add(new_range);
removeInternal(this_feature);
qualifier_vector.addAll(this_feature.getQualifiers());
}
final Feature first_old_feature = (Feature)v_exons.get(0);
final Location new_location = new Location(new_range_vector,
first_old_feature.getLocation().isComplement());
qualifier_vector = mergeQualifiers(qualifier_vector,
first_old_feature.getLocation().isComplement());
final GFFStreamFeature new_feature =
new GFFStreamFeature(first_old_feature.getKey(),
new_location, qualifier_vector);
if(lasttimemodified != null)
new_feature.setLastModified(lasttimemodified);
new_feature.setSegmentRangeStore(id_range_store);
try
{
new_feature.setLocation(new_location);
final Qualifier gene_qualifier =
new_feature.getQualifierByName("gene");
if(gene_qualifier != null &&
gene_qualifier.getValues().size() > 0 &&
((String)(gene_qualifier.getValues()).elementAt(0)).startsWith("Phat"))
{
// special case to handle incorrect output of the Phat gene
// prediction tool
new_feature.removeQualifierByName("codon_start");
}
else
{
final Qualifier old_codon_start_qualifier =
first_old_feature.getQualifierByName("codon_start");
if(old_codon_start_qualifier != null)
new_feature.setQualifier(old_codon_start_qualifier);
}
forcedAdd(new_feature);
}
catch(ReadOnlyException e)
{
throw new Error("internal error - unexpected exception: " + e);
}
catch(OutOfRangeException e)
{
throw new Error("internal error - unexpected exception: " + e);
}
catch(EntryInformationException e)
{
throw new Error("internal error - unexpected exception: " + e);
}
}
}
/**
* Combine the features (which are exons) and delete the orignals from this
* Entry. The key of this hash will be the group name and the value is a
* FeatureVector containing the feature that are in that group. Groups
* that have more than one member will be combined.
**/
private void combineFeaturesFromHash(final Hashtable feature_groups)
{
final Enumeration enumFeat = feature_groups.keys();
final RangeVector new_range_vector = new RangeVector();
QualifierVector qualifier_vector = new QualifierVector();
Hashtable id_range_store = new Hashtable();
Timestamp lasttimemodified = null;
lasttimemodified = this_feature.getLastModified();
final Location this_feature_location = this_feature.getLocation();
throw new Error("internal error - new location should have " +
(Range)this_feature_location.getRanges().elementAt(0);
Qualifier id_qualifier = this_feature.getQualifierByName("ID");
if(id_qualifier != null)
{
if(this_feature_location.isComplement())
new_range_vector.insertElementAt(new_range, 0);
else
new_range_vector.add(new_range);
final Location new_location = new Location(new_range_vector,
first_old_feature.getLocation().isComplement());
qualifier_vector = mergeQualifiers(qualifier_vector,
first_old_feature.getLocation().isComplement());
final GFFStreamFeature new_feature = new GFFStreamFeature(first_old_feature.getKey(),
new_location, qualifier_vector);
if(lasttimemodified != null)
new_feature.setLastModified(lasttimemodified);
if(gene_qualifier != null &&
gene_qualifier.getValues().size() > 0 &&
((String)(gene_qualifier.getValues()).elementAt(0)).startsWith("Phat"))
// special case to handle incorrect output of the Phat gene
// prediction tool
new_feature.removeQualifierByName("codon_start");
}
else
{
if(old_codon_start_qualifier != null)
new_feature.setQualifier(old_codon_start_qualifier);
forcedAdd(new_feature);
}
catch(ReadOnlyException e)
{
throw new Error("internal error - unexpected exception: " + e);
}
catch(OutOfRangeException e)
{
throw new Error("internal error - unexpected exception: " + e);
}
catch(EntryInformationException e)
{
throw new Error("internal error - unexpected exception: " + e);
private QualifierVector mergeQualifiers(QualifierVector qualifier_vector,
boolean complement)
{
QualifierVector merge_qualifier_vector = new QualifierVector();
for(int i = 0 ; i < qualifier_vector.size() ; ++i)
{
Qualifier qual = (Qualifier)qualifier_vector.elementAt(i);
if(qual.getName().equals("codon_start"))
{
if(!complement && !seen)
{
merge_qualifier_vector.addElement(qual);
seen = true;
}
else if(complement)
merge_qualifier_vector.setQualifier(qual);
}
else if(!qual.getName().equals("ID") &&
!qual.getName().equals("Alias"))
final Qualifier id_qualifier;
if(qual.getName().equals("ID"))
id_qualifier = merge_qualifier_vector.getQualifierByName("ID");
else
id_qualifier = merge_qualifier_vector.getQualifierByName("Alias");
if(id_qualifier == null)
merge_qualifier_vector.addElement(qual);
else
{
String id1 = (String)(id_qualifier.getValues()).elementAt(0);
String id2 = (String)(qual.getValues()).elementAt(0);
id_qualifier.removeValue(id1);
id_qualifier.addValue(id1+","+id2);
}
}
}
return merge_qualifier_vector;
}