ensembl-hive
2.6
|
Formerly this class provided database connectivity and a means to retrieve object adaptors. This class is now provided for convenience and backwards compatibility, and delegates its connection responsibilities to the DBConnection class (no longer inherited from) and its object adaptor retrieval to the static Bio::EnsEMBL::Registry. Please use Bio::EnsEMBL::Registry to retrieve object adaptors.
Definition at line 40 of file DBAdaptor.pm.
protected Bio::EnsEMBL::ExternalFeatureFactory Bio::EnsEMBL::DBSQL::DBAdaptor::_each_DASFeatureFactory | ( | ) |
Args : none Example :
Description: Not sure if this is used, or if it should be removed. It does not seem to be used at the moment Returntype : Bio::EnsEMBL::ExternalFeatureFactory Exceptions : none Caller : ?? Status : At Risk : with the new web code this may not be needed/supported
protected Bio::EnsEMBL::DBSQL::DBAdaptor::_get_schema_build | ( | ) |
Undocumented method
public void Bio::EnsEMBL::DBSQL::DBAdaptor::add_DASFeatureFactory | ( | ) |
Arg [1] : Bio::EnsEMBL::ExternalFeatureFactory $value Example :
Description: Attaches a DAS Feature Factory to this method. ExternalFeatureFactory objects are not really used right now. They may be reintroduced or taken out completely. The fate of this function is unknown (although it is presently needed). Returntype : none Exceptions : none Caller : EnsWeb Status : At Risk : with the new web code this may not be needed/supported
public void Bio::EnsEMBL::DBSQL::DBAdaptor::add_db_adaptor | ( | ) |
Arg [1] : string $name the name of the database to attach to this database Arg [2] : Bio::EnsEMBL::DBSQL::DBConnection the db adaptor to attach to this database Example :
Description: Attaches another database instance to this database so that it can be used in instances where it is required. Returntype : none Exceptions : none Caller : EnsWeb Status : At Risk
public void Bio::EnsEMBL::DBSQL::DBAdaptor::add_ExternalFeatureAdaptor | ( | ) |
Arg [1] : Bio::EnsEMBL::External::ExternalFeatureAdaptor Example :
Description: Adds an external feature adaptor to this database adaptor. Adding the external adaptor in this way allows external features to be obtained from Slices and from RawContigs.
The external feature adaptor which is passed to this method will have its db attribute set to this DBAdaptor object via the db accessor method.
ExternalFeatureAdaptors passed to this method are stored internally in a hash keyed on the string returned by the ExternalFeatureAdaptors track_name method.
If the track name method is not implemented then the a default key named 'External features' is assigned. In the event of duplicate key names, a number is appended to the key name, and incremented for each subsequent adaptor with the same track name. For example, if no track_names are specified then the the external feature adaptors will be stored under the keys 'External features', 'External features2' 'External features3' etc. Returntype : none Exceptions : none Caller : general
public void Bio::EnsEMBL::DBSQL::DBAdaptor::add_ExternalFeatureFactory | ( | ) |
Arg [1] : Bio::EnsEMBL::DB::ExternalFeatureFactoryI $value Example :
Description: It is recommended that add_ExternalFeatureAdaptor be used instead. See documentation for Bio::EnsEMBL::External::ExternalFeatureAdaptor
Adds an external feature factory to the core database so that features from external sources can be displayed in ensembl. This method is still available mainly for legacy support for external EnsEMBL installations. Returntype : none Exceptions : none Caller : external
public void Bio::EnsEMBL::DBSQL::DBAdaptor::add_GenericFeatureAdaptor | ( | ) |
Arg [1] : The name of the feature. Arg [2] : Adaptor object for a generic feature. Example :
Description: Stores the object which represents the adaptor for the named feature type. Returntype : none Exceptions : Caller : external
public Array Bio::EnsEMBL::DBSQL::DBAdaptor::all_species | ( | ) |
Args : NONE Example :
Description: Returns the names of all species contained in the database to which this DBAdaptor is connected. Returntype : array reference Exceptions : none Caller : general Status : Stable
public Bio::EnsEMBL::DBSQL::DBAdaptor::AUTOLOAD | ( | ) |
Undocumented method
public void Bio::EnsEMBL::DBSQL::DBAdaptor::clear_caches | ( | ) |
Example :
Description : Loops through all linked adaptors and clears their caches if clear_cache() is implemented. Not all caches are cleared & the DBAdaptor instance should be removed from the registry to clear these remaining essential caches. Returntype : None Exceptions : None
public Bio::EnsEMBL::DBSQL::DBConnection Bio::EnsEMBL::DBSQL::DBAdaptor::dbc | ( | ) |
Arg[1] : (optional) Bio::EnsEMBL::DBSQL::DBConnection
Example :
Description: Getter/Setter for DBConnection. Returntype : Bio::EnsEMBL::DBSQL::DBConnection Exceptions : throws if argument not a Bio::EnsEMBL::DBSQL::DBConnection Caller : general Status : Stable
public Bio::EnsEMBL::DBSQL::DBAdaptor::DESTROY | ( | ) |
Undocumented method
public Dna Bio::EnsEMBL::DBSQL::DBAdaptor::dnadb | ( | ) |
Title : dnadb Usage : my $dnadb = $db->dnadb(); Function: returns the database adaptor where the dna lives Useful if you only want to keep one copy of the dna on disk but have other databases with genes and features in Returns : dna database adaptor Args : Bio::EnsEMBL::DBSQL::BaseAdaptor Status : Medium Risk. : Use the Registry method add_DNAAdaptor/get_DNAAdaptor instead
public void Bio::EnsEMBL::DBSQL::DBAdaptor::find_and_add_aliases | ( | ) |
Example :
Description : When executed we delegate to the find_and_add_aliases method in Bio::EnsEMBL::Registry which scans the database's MetaContainer for species.alias entries indicating alternative names for this species. This is best executed on a core DBAdaptor instance. Returntype : None Exceptions : None
public void Bio::EnsEMBL::DBSQL::DBAdaptor::find_and_add_species_id | ( | ) |
Description : Returntype : None Exceptions : None
public Adaptor Bio::EnsEMBL::DBSQL::DBAdaptor::get_adaptor | ( | ) |
Arg [1] : Canonical data type for which an adaptor is required. Example :
Description: Gets an adaptor object for a standard data type. Returntype : Adaptor Object of arbitrary type or undef Exceptions : none Caller : external Status : Medium Risk : please use the Registry method, as at some time this : may no longer be supported.
public Hash Bio::EnsEMBL::DBSQL::DBAdaptor::get_all_db_adaptors | ( | ) |
Arg [1] : none Example :
Description: returns all of the attached databases as a hash reference of key/value pairs where the keys are database names and the values are the attached databases Returntype : hash reference with Bio::EnsEMBL::DBSQL::DBConnection values Exceptions : none Caller : Bio::EnsEMBL::DBSQL::ProxyAdaptor Status : At Risk : please use Bio::EnsEMBL::Registry->get_all_db_adaptors
public Reference Bio::EnsEMBL::DBSQL::DBAdaptor::get_available_adaptors | ( | ) |
Example :
Description: gets a hash of the available adaptors ReturnType : reference to a hash Exceptions : none Caller : Bio::EnsEMBL::Utils::ConfigRegistry Status : Stable
public Bio::EnsEMBL::DBSQL::DBConnection Bio::EnsEMBL::DBSQL::DBAdaptor::get_db_adaptor | ( | ) |
Arg [1] : string $name the name of the attached database to retrieve Example :
Description: returns an attached db adaptor of name $name or undef if no such attached database exists Returntype : Bio::EnsEMBL::DBSQL::DBConnection Exceptions : none Caller : ? Status : At Risk : please use Bio::EnsEMBL::Registry->get_db_adaptors
public Reference Bio::EnsEMBL::DBSQL::DBAdaptor::get_ExternalFeatureAdaptors | ( | ) |
Arg [1] : none Example :
Description: Retrieves all of the ExternalFeatureAdaptors which have been added to this DBAdaptor. The ExternalFeatureAdaptors are returned in a reference to a hash keyed on the track names of the external adaptors Returntype : Reference to a hash of ExternalFeatureAdaptors keyed on their track names. Exceptions : none Caller : general
public Reference Bio::EnsEMBL::DBSQL::DBAdaptor::get_GenericFeatureAdaptors | ( | ) |
Arg [1] : List of names of feature adaptors to get. If no adaptor names are given, all the defined adaptors are returned. Example :
Description: Returns a hash containing the named feature adaptors (or all feature adaptors). Returntype : reference to a Hash containing the named feature adaptors (or all feature adaptors). Exceptions : If any of the the named generic feature adaptors do not exist. Caller : external
public Bio::EnsEMBL::Utils::SeqRegionCache Bio::EnsEMBL::DBSQL::DBAdaptor::get_SeqRegionCache | ( | ) |
Arg [1] : none Example :
Description: Retrieves a seq_region cache for this database Returntype : Bio::EnsEMBL::Utils::SeqRegionCache Exceptions : none Caller : SliceAdaptor, AssemblyMapperAdaptor Status : Stable
public String Bio::EnsEMBL::DBSQL::DBAdaptor::group | ( | ) |
Arg [1] : (optional) string $arg The new value of the group used by this DBAdaptor. Example :
Description: Getter/Setter for the group of to use for this connection. There is currently no point in setting this value after the connection has already been established by the constructor. Returntype : string Exceptions : none Caller : new Status : Stable
public Boolean Bio::EnsEMBL::DBSQL::DBAdaptor::has_switched_adaptor | ( | ) |
Arg [1] : String name of the adaptor type to switch back in Example :
Returntype : Boolean indicating if the given adaptor is being actively switched Description : Provides a wrapper around the Registry has_switchable_adaptor() method defaulting both species and group to the current DBAdaptor. This will inform if the specified adaptor is being switched out Exceptions : None
public Boolean Bio::EnsEMBL::DBSQL::DBAdaptor::is_multispecies | ( | ) |
Arg [1] : (optional) boolean $arg Example :
Description: Getter/Setter for the is_multispecies boolean of to use for this connection. There is currently no point in setting this value after the connection has already been established by the constructor. Returntype : boolean Exceptions : none Caller : new Status : Stable
public Bio::EnsEMBL::DBSQL::DBAdaptor Bio::EnsEMBL::DBSQL::DBAdaptor::new | ( | ) |
Arg [-DNADB]: (optional) Bio::EnsEMBL::DBSQL::DBAdaptor DNADB All sequence, assembly, contig information etc, will be retrieved from this database instead.
Arg [-NO_CACHE]: (optional) int 1 This option will turn off caching for slice features, so, every time a set of features is retrieved, they will come from the database instead of the cache. This option is only recommended for advanced users, specially if you need to store and retrieve features. It might reduce performance when querying the database if not used properly. If in doubt, do not use it or ask in the developer mailing list.
Arg [-ADD_ALIASES]: (optional) boolean Used to automatically load aliases for this species into the Registry upon loading.
Arg [-ADD_SPECIES_ID]: (optional) boolean Used to automatically load the species id based on the species if none is defined.
Arg [..] : Other args are passed to superclass Bio::EnsEMBL::DBSQL::DBConnection
Example :
Description: Constructor for DBAdaptor. Returntype : Bio::EnsEMBL::DBSQL::DBAdaptor Exceptions : none Caller : general Status : Stable
public Int Bio::EnsEMBL::DBSQL::DBAdaptor::no_cache | ( | ) |
Arg [1] : (optional) int $arg The new value of the no cache attribute used by this DBAdaptor. Example :
Description: Getter/Setter for the no_cache to use for this connection. There is currently no point in setting this value after the connection has already been established by the constructor. Returntype : int Exceptions : none Caller : new Status : Stable
public Bio::EnsEMBL::DBSQL::DBAdaptor::remove_all_DASFeatureFactories | ( | ) |
Undocumented method
public void Bio::EnsEMBL::DBSQL::DBAdaptor::remove_db_adaptor | ( | ) |
Arg [1] : string $name the name of the database to detach from this database. Example :
Description: Detaches a database instance from this database and returns it. Returntype : none Exceptions : none Caller : ? Status : At Risk
public The Bio::EnsEMBL::DBSQL::DBAdaptor::revert_adaptor | ( | ) |
Arg [1] : (optional) String name of the adaptor type to switch back in Example :
Returntype : The removed adaptor Description : Provides a wrapper around the Registry remove_switchable_adaptor() method defaulting both species and group to the current DBAdaptor. This will remove a switchable adaptor. You can also remove the last adaptor you switched in without having to specify any parameter. Exceptions : Thrown if no switchable adaptor name was given or could be found in the internal last adaptor variable
public void Bio::EnsEMBL::DBSQL::DBAdaptor::set_adaptor | ( | ) |
Arg [1] : Canonical data type for new adaptor. Arg [2] : Object defining the adaptor for arg1. Example :
Description: Stores the object which represents the adaptor for the arg1 data type. Returntype : none Exceptions : none Caller : external Status : Medium Risk : please use the Registry method, as at some time this : may no longer be supported.
public String Bio::EnsEMBL::DBSQL::DBAdaptor::species | ( | ) |
Arg [1] : (optional) string $arg The new value of the species used by this DBAdaptor. Example :
Description: Getter/Setter for the species of to use for this connection. There is currently no point in setting this value after the connection has already been established by the constructor. Returntype : string Exceptions : none Caller : new Status : Stable
public String Bio::EnsEMBL::DBSQL::DBAdaptor::species_id | ( | ) |
Arg [1] : (optional) string $arg The new value of the species_id used by this DBAdaptor when dealing with multi-species databases. Example :
Description: Getter/Setter for the species_id of to use for this connection. There is currently no point in setting this value after the connection has already been established by the constructor. Returntype : string Exceptions : none Caller : new Status : Stable
public void Bio::EnsEMBL::DBSQL::DBAdaptor::switch_adaptor | ( | ) |
Arg [1] : String name of the adaptor type to switch out Arg [2] : Reference The switchable adaptor implementation Arg [3] : (optional) CodeRef Provide a subroutine reference as a callback. The adaptor will be switched before your codeblock is executed and the adaptor switched back to the original once your code has finished running Arg [4] : (optional) Boolean override any existing switchable adaptor Example :
Returntype : None Description : Provides a wrapper around the Registry add_switchable_adaptor() method defaulting both species and group to the current DBAdaptor. Callbacks are also available providing automatic resource cleanup.
The method also remembers the last switch you did. It will not remember multiple switches though. Exceptions : Thrown if no switchable adaptor instance was given
public Hash Bio::EnsEMBL::DBSQL::DBAdaptor::to_hash | ( | ) |
Example :
Description: Provides a hash which is compatible with the parameters for DBAdaptor's new() method. This can be useful during serialisation but be aware that Registry Returntype : Hash Exceptions : none Caller : general Status : New