Archive Ensembl HomeArchive Ensembl Home
Bio::EnsEMBL::SeqRegionSynonym Class Reference
Inheritance diagram for Bio::EnsEMBL::SeqRegionSynonym:

List of all members.


Class Summary

Synopsis

Description

This object holds information about alternative name to
Ensembl seq regions.
 

Definition at line 17 of file SeqRegionSynonym.pm.

Available Methods

public
Bio::EnsEMBL::DBSQL::BaseAdaptor 
adaptor ()
public Int dbID ()
public external_db_id ()
public get_all_DAS_Features ()
public Boolean is_stored ()
public name ()
public
Bio::EnsEMBL::SeqRegionSynonym 
new ()
public seq_region_id ()

Method Documentation

public Bio::EnsEMBL::DBSQL::BaseAdaptor Bio::EnsEMBL::Storable::adaptor ( ) [inherited]
  Arg [1]    : Bio::EnsEMBL::DBSQL::BaseAdaptor $adaptor
  Example    : none
  Description: get/set for this objects Adaptor
  Returntype : Bio::EnsEMBL::DBSQL::BaseAdaptor
  Exceptions : none
  Caller     : general, set from adaptor on store
  Status     : Stable
 
Code:
click to view
public Int Bio::EnsEMBL::Storable::dbID ( ) [inherited]
  Arg [1]    : int $dbID
  Example    : none
  Description: getter/setter for the database internal id
  Returntype : int
  Exceptions : none
  Caller     : general, set from adaptor on store
  Status     : Stable
 
Code:
click to view

Reimplemented in Bio::EnsEMBL::Map::Ditag, and Bio::EnsEMBL::Map::DitagFeature.

public Bio::EnsEMBL::SeqRegionSynonym::external_db_id ( )

Undocumented method

Code:
click to view
public Bio::EnsEMBL::Storable::get_all_DAS_Features ( ) [inherited]

Undocumented method

Code:
click to view

Reimplemented in Bio::EnsEMBL::Gene, Bio::EnsEMBL::Transcript, and Bio::EnsEMBL::Translation.

public Boolean Bio::EnsEMBL::Storable::is_stored ( ) [inherited]
  Arg [1]    : Bio::EnsEMBL::DBSQL::DBConnection 
             : or Bio::EnsEMBL::DBSQL::DBAdaptor
  Example    : do_something if($object->is_stored($db));
  Description: Returns true if this object is stored in the provided database.
               This works under the assumption that if the adaptor and dbID are
               set and the database of the adaptor shares the port, dbname and
               hostname with the provided database, this object is stored in
               that database.
  Returntype : 1 or 0
  Exceptions : throw if dbID is set but adaptor is not
               throw if adaptor is set but dbID is not
               throw if incorrect argument is passed
  Caller     : store methods
  Status     : Stable
 
Code:
click to view
public Bio::EnsEMBL::SeqRegionSynonym::name ( )

Undocumented method

Code:
click to view
public Bio::EnsEMBL::SeqRegionSynonym Bio::EnsEMBL::SeqRegionSynonym::new ( )
  Args [...] : list of named parameters 
  Example    : my $srs = new Bio::EnsEMBL::SeqRegionSynonym(
                    -adaptor => $adaptor,
                    -synonym => $alt_name,
                    -external_db_id => 1234
                    -seq_region_id  => 12);
  Description: Creates a new SeqRegionSynonym object
  Returntype : Bio::EnsEMBL::SeqRegionSynonym
  Exceptions : none
  Caller     : Bio::EnsEMBL::SeqRegionSynonymAdaptor
  Status     : At Risk
 
Code:
click to view

Reimplemented from Bio::EnsEMBL::Storable.

public Bio::EnsEMBL::SeqRegionSynonym::seq_region_id ( )

Undocumented method

Code:
click to view

The documentation for this class was generated from the following file: