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

List of all members.


Class Summary

Synopsis

Description

This object holds information about external references (xrefs) to
Ensembl objects.
 

Definition at line 18 of file DBEntry.pm.

Available Methods

public
Bio::EnsEMBL::DBSQL::BaseAdaptor 
adaptor ()
public void add_synonym ()
public Bio::EnsEMBL::Analysis analysis ()
public String comment ()
public String database ()
public String db_display_name ()
public Int dbID ()
public String dbname ()
public String description ()
public String display_id ()
public String ensembl_id ()
public String ensembl_object_type ()
public void flush_synonyms ()
public get_all_DAS_Features ()
public Listref get_all_dependents ()
public Listref get_all_masters ()
public Listref get_all_synonyms ()
public get_synonyms ()
public String info_text ()
public String info_type ()
public Boolean is_stored ()
public String linkage_annotation ()
public Bio::EnsEMBL::DBEntry new ()
public Bio::EnsEMBL::DBEntry new_fast ()
public String optional_id ()
public String primary_id ()
public String priority ()
public String release ()
public secondary_db_name ()
public secondary_db_table ()
public String status ()
public String type ()
public String version ()

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 void Bio::EnsEMBL::DBEntry::add_synonym ( )
  Arg [1]    : String $arg - synonym to add
  Example    : none
  Description: Add a synonym for the external object.
  Returntype : none
  Exceptions : none
  Caller     : general
  Status     : Stable
 
Code:
click to view
public Bio::EnsEMBL::Analysis Bio::EnsEMBL::DBEntry::analysis ( )
  Arg [1]    : Bio::EnsEMBL::Analysis $analysis
  Example    : none
  Description: get/set for attribute analysis
  Returntype : Bio::EnsEMBL::Analysis
  Exceptions : none
  Caller     : general
  Status     : Stable
 
Code:
click to view
public String Bio::EnsEMBL::DBEntry::comment ( )
  Args       : none
  Example    : none
  Description: Additional getter for attribute 'description'.
               The object's description.
               Only include for BioPerl interface compliance, please use
               $self->description().
  Returntype : String
  Exceptions : none
  Caller     : general
  Status     : Stable
 
Code:
click to view
public String Bio::EnsEMBL::DBEntry::database ( )
  Args       : none
  Example    : none
  Description: Additional getter for attribute 'dbname'.
               The name of the external database.
               Only include for BioPerl interface compliance, please use
               $self->dbname().
  Returntype : String
  Exceptions : none
  Caller     : general
  Status     : Stable
 
Code:
click to view
public String Bio::EnsEMBL::DBEntry::db_display_name ( )
  Arg [1]    : String $db_display_name
  Example    : none
  Description: Getter/setter for attribute 'db_display_name'.
               The preferred display name for the external database. Has
               "Projected " prepended if info_type='PROJECTION'.
  Returntype : String
  Exceptions : none
  Caller     : general
 
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 String Bio::EnsEMBL::DBEntry::dbname ( )
  Arg [1]    : (optional) String $arg - value to set
  Example    : none
  Description: Getter/setter for attribute 'dbname'.
               The name of the external database.
  Returntype : String
  Exceptions : none
  Caller     : general
  Status     : Stable
 
Code:
click to view
public String Bio::EnsEMBL::DBEntry::description ( )
  Arg [1]    : (optional) String $arg - value to set
  Example    : none
  Description: Getter/setter for attribute 'description'.
               The object's description, from the xref table
  Returntype : String
  Exceptions : none
  Caller     : general
  Status     : Stable
 
Code:
click to view
public String Bio::EnsEMBL::DBEntry::display_id ( )
  Arg [1]    : (optional) String $arg - value to set
  Example    : none
  Description: Getter/setter for attribute 'display_id'.
               The object's preferred display name. This can be the same
               as primary_id or ensembl-specific.
  Returntype : String
  Exceptions : none
  Caller     : general
  Status     : Stable
 
Code:
click to view
public String Bio::EnsEMBL::DBEntry::ensembl_id ( )
  Arg [1]    : (optional) String $arg - value to set
  Example    : none
  Description: Getter/setter for attribute ensembl_id.
  Returntype : String
  Exceptions : none
  Caller     : general
  Status     : Stable
 
Code:
click to view
public String Bio::EnsEMBL::DBEntry::ensembl_object_type ( )
  Arg [1]    : (optional) String $arg - value to set
  Example    : none
  Description: Getter/setter for attribute ensembl_object_type.
  Returntype : String
  Exceptions : none
  Caller     : general
  Status     : Stable
 
Code:
click to view
public void Bio::EnsEMBL::DBEntry::flush_synonyms ( )
  Args       : none
  Example    : none
  Description: Remove all synonyms from this object.
  Returntype : none
  Exceptions : none
  Caller     : general
  Status     : Stable
 
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 Listref Bio::EnsEMBL::DBEntry::get_all_dependents ( )
  Args[1]    : (optional) Bio::EnsEMBL::Gene, Transcript or Translation object
  Example    : my @dependents = @{ $db_entry->get_all_dependents };
  Description: Get a list of DBEntrys that are depenednet on the DBEntry.
               if an ensembl gene transcript or translation is given then only
               the ones on that object will be given
  Returntype : listref of DBEntrys. May be empty.
  Exceptions : none
  Caller     : general
  Status     : UnStable
 
Code:
click to view
public Listref Bio::EnsEMBL::DBEntry::get_all_masters ( )
  Args[1]    : (optional) Bio::EnsEMBL::Gene, Transcript or Translation object
  Example    : my @masters = @{ $db_entry->get_all_masters };
  Description: Get a list of DBEntrys that are the masters of the DBEntry.
               if an ensembl gene transcript or translation is given then only
               the ones on that object will be given.
  Returntype : listref of DBEntrys. May be empty.
  Exceptions : none
  Caller     : general
  Status     : UnStable
 
Code:
click to view
public Listref Bio::EnsEMBL::DBEntry::get_all_synonyms ( )
  Args      : none
  Example    : my @synonyms = @{ $db_entry->get_all_synonyms };
  Description: Get a list of synonyms known for this object.
               Synonyms are lazy-loaded if required.
  Returntype : listref of strings. May be empty.
  Exceptions : none
  Caller     : general
  Status     : Stable
 
Code:
click to view
public Bio::EnsEMBL::DBEntry::get_synonyms ( )
  Description:

Deprecated:
use get_all_synonyms instead
 
Code:
click to view
public String Bio::EnsEMBL::DBEntry::info_text ( )
  Arg [1]    : String $info_text
  Example    : none
  Description: Getter/setter for attribute 'info_text'.
  Returntype : String
  Exceptions : none
  Caller     : general
 
Code:
click to view
public String Bio::EnsEMBL::DBEntry::info_type ( )
  Arg [1]    : String $info_type
  Example    : none
  Description: Getter/setter for attribute 'info_type'.
  Returntype : String
  Exceptions : none
  Caller     : general
 
Code:
click to view
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 String Bio::EnsEMBL::DBEntry::linkage_annotation ( )
  Arg [1]    : String $object_xref_text
  Example    : none
  Description: Getter/setter for attribute 'linkage_annotation'.
  Returntype : String
  Exceptions : none
  Caller     : general
 
Code:
click to view
public Bio::EnsEMBL::DBEntry Bio::EnsEMBL::DBEntry::new ( )
  Args [...] : list of named parameters 
  Example    : my $dbentry = new Bio::EnsEMBL::DBEntry(
                    -adaptor => $adaptor,
                    -primary_id => $pid,
                    -version => $version,
                    -dbname  => $dbname,
                    -release => $release,
                    -display_id => $did,
                    -description => $description,
                    -priority => $priority,
                    -db_display_name => $db_display_name,
                    -info_type => $info_type,
                    -info_text => $info_text,
                    -type => $type,
                    -secondary_db_name => $secondary_db_name,
                    -secondary_db_table => $secondary_db_table
		    -linkage_annotation => $object_xref_text);
  Description: Creates a new DBEntry object
  Returntype : Bio::EnsEMBL::DBEntry
  Exceptions : none
  Caller     : Bio::EnsEMBL::DBEntryAdaptor
  Status     : At Risk
               Due to 'PRIORITY',
              'INFO_TYPE', 'INFO_TEXT', ''DB_DISPLAY_NAME', 'TYPE',
              'SECONDARY_DB_NAME', 'SECONDARY_DB_TABLE'
               being under development - if you don't use any of these the
               method can be considered Stable
 
Code:
click to view

Reimplemented from Bio::EnsEMBL::Storable.

Reimplemented in Bio::EnsEMBL::IdentityXref.

public Bio::EnsEMBL::DBEntry Bio::EnsEMBL::DBEntry::new_fast ( )
  Arg [1]    : Hashref $hashref - hash reference to bless as new DBEntry object
  Description: A very quick constructor that requires internal knowledge of
               the class. This is used in speed critical sections of the code
               where many objects need to be created quickly.
  Returntype : Bio::EnsEMBL::DBEntry
  Exceptions : none
  Caller     : general
  Status     : Stable
 
Code:
click to view
public String Bio::EnsEMBL::DBEntry::optional_id ( )
  Args       : none
  Example    : none
  Description: Additional getter for attribute 'display_id'.
               The object's preferred display name.
               Only include for BioPerl interface compliance, please use
               $self->display_id().
  Returntype : String
  Exceptions : none
  Caller     : general
  Status     : Stable
 
Code:
click to view
public String Bio::EnsEMBL::DBEntry::primary_id ( )
  Arg [1]    : (optional) String $arg - value to set
  Example    : none
  Description: Getter/setter for attribute 'primary_id'.
               This is the object's primary id in the external database.
  Returntype : String
  Exceptions : none
  Caller     : general
  Status     : Stable
 
Code:
click to view
public String Bio::EnsEMBL::DBEntry::priority ( )
  Arg [1]    : int $priority
  Example    : none
  Priority   : Getter/setter for attribute 'priority'. Note this
               is the priority from the external_db table.
  Returntype : String
  Exceptions : none
  Caller     : general
  Status     : At Risk
             : due to it being under development
 
Code:
click to view
public String Bio::EnsEMBL::DBEntry::release ( )
  Arg [1]    : (optional) String $arg - value to set
  Example    : none
  Description: Getter/setter for attribute 'release'.
               The external database release name.
  Returntype : String
  Exceptions : none
  Caller     : general
  Status     : Stable
 
Code:
click to view
public Bio::EnsEMBL::DBEntry::secondary_db_name ( )
  Arg [1]    : String $secondary_db_name
  Example    : none
  Description: Getter/setter for attribute 'secondary_db_name'.
  Returnsecondary_db_name : String
  Exceptions : none
  Caller     : general
 
Code:
click to view
public Bio::EnsEMBL::DBEntry::secondary_db_table ( )
  Arg [1]    : String $secondary_db_table
  Example    : none
  Description: Getter/setter for attribute 'secondary_db_table'.
  Returnsecondary_db_table : String
  Exceptions : none
  Caller     : general
 
Code:
click to view
public String Bio::EnsEMBL::DBEntry::status ( )
  Arg [1]    : (optional) String $arg - value to set
  Example    : none
  Description: Getter/setter for attribute 'status'.
  Returntype : String
  Exceptions : none
  Caller     : general
  Status     : Stable
 
Code:
click to view
public String Bio::EnsEMBL::DBEntry::type ( )
  Arg [1]    : String $type
  Example    : none
  Description: Getter/setter for attribute 'type'.
  Returntype : String
  Exceptions : none
  Caller     : general
 
Code:
click to view
public String Bio::EnsEMBL::DBEntry::version ( )
  Arg [1]    : (optional) String $arg - value to set
  Example    : none
  Description: Getter/setter for attribute 'version'.
               The object's version in the external database.
  Returntype : String
  Exceptions : none
  Caller     : general
  Status     : Stable
 
Code:
click to view

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