ensembl-hive  2.8.1
Bio::EnsEMBL::DBSQL::OperonAdaptor Class Reference
+ Inheritance diagram for Bio::EnsEMBL::DBSQL::OperonAdaptor:

Public Member Functions

protected _tables ()
 
protected _columns ()
 
public Listref list_dbIDs ()
 
public Reference list_stable_ids ()
 
public list_seq_region_ids ()
 
public Bio::EnsEMBL::Operon fetch_by_name ()
 
public Bio::EnsEMBL::Operon fetch_by_stable_id ()
 
public Bio::EnsEMBL::Operon fetch_by_stable_id_version ()
 
public fetch_all ()
 
public Listref fetch_all_versions_by_stable_id ()
 
public Reference fetch_all_by_Slice ()
 
public fetch_by_operon_transcript_id ()
 
public Bio::EnsEMBL::Operon fetch_by_operon_transcript_stable_id ()
 
public fetch_by_operon_transcript ()
 
public The store ()
 
public void remove ()
 
protected _objs_from_sth ()
 
- Public Member Functions inherited from Bio::EnsEMBL::DBSQL::BaseFeatureAdaptor
public Bio::EnsEMBL::BaseFeatureAdaptor new ()
 
public Boolean start_equals_end ()
 
public void clear_cache ()
 
protected _clear_slice_feature_cache ()
 
protected Bio::EnsEMBL::Utils::Cache _slice_feature_cache ()
 
public Listref fetch_all_by_Slice ()
 
public Bio::EnsEMBL::Utils::Iterator fetch_Iterator_by_Slice_method ()
 
public Bio::EnsEMBL::Utils::Iterator fetch_Iterator_by_Slice ()
 
public Listref fetch_all_by_Slice_and_score ()
 
public Listref fetch_all_by_Slice_constraint ()
 
public Listref fetch_all_by_logic_name ()
 
public Listref fetch_all_by_stable_id_list ()
 
protected _create_feature ()
 
protected _create_feature_fast ()
 
public Int count_by_Slice_constraint ()
 
protected ArrayRef _get_and_filter_Slice_projections ()
 
protected ArrayRef _generate_feature_bounds ()
 
protected Listref _get_by_Slice ()
 
protected _slice_fetch ()
 
public get_seq_region_id_external ()
 
public get_seq_region_id_internal ()
 
protected _pre_store ()
 
protected _pre_store_userdata ()
 
protected _check_start_end_strand ()
 
protected _remap ()
 
protected _seq_region_boundary_from_db ()
 
public void store ()
 
public void remove ()
 
public void remove_by_Slice ()
 
protected _max_feature_length ()
 
protected _list_seq_region_ids ()
 
public remove_by_analysis_id ()
 
public remove_by_feature_id ()
 
public Bio::EnsEMBL::Feature fetch_nearest_by_Feature ()
 
public Listref fetch_all_by_outward_search ()
 
public Listref fetch_all_nearest_by_Feature ()
 
public Listref select_nearest ()
 
protected Int _compute_nearest_end ()
 
protected Int _compute_prime_distance ()
 
protected Int _compute_midpoint ()
 
protected _discard_excess_features_from_matrix ()
 
- Public Member Functions inherited from Bio::EnsEMBL::DBSQL::BaseAdaptor
public Bio::EnsEMBL::DBSQL::BaseAdaptor new ()
 
public DBI::StatementHandle prepare ()
 
public Bio::EnsEMBL::DBSQL::DBAdaptor db ()
 
public Bio::EnsEMBL::DBSQL::DBConnection dbc ()
 
public Boolean is_multispecies ()
 
public Int species_id ()
 
protected _list_dbIDs ()
 
protected _straight_join ()
 
protected _can_straight_join ()
 
public Listref bind_param_generic_fetch ()
 
protected _bind_param_generic_fetch ()
 
public String generate_in_constraint ()
 
public Listref generic_fetch ()
 
public Int generic_count ()
 
protected _generate_sql ()
 
public Bio::EnsEMBL::Feature fetch_by_dbID ()
 
protected _uncached_fetch_by_dbID ()
 
public Listref fetch_all_by_dbID_list ()
 
protected _uncached_fetch_all_by_dbID_list ()
 
protected ArrayRef _uncached_fetch_all_by_id_list ()
 
public fetch_all ()
 
public Scalar last_insert_id ()
 
public insert_ignore_clause ()
 
protected Bio::EnsEMBL::DBSQL::Support::BaseCache _id_cache ()
 
protected Boolean _no_id_cache ()
 
public Boolean ignore_cache_override ()
 
public Int schema_version ()
 
protected _tables ()
 
protected _columns ()
 
protected _default_where_clause ()
 
protected _left_join ()
 
protected _final_clause ()
 
protected _objs_from_sth ()
 
protected _build_id_cache ()
 
protected _logic_name_to_constraint ()
 

Detailed Description

Synopsis

my $operon_adaptor = Bio::EnsEMBL::DBSQL::OperonAdaptor->new($dba);
$operon_adaptor->store($operon);
my $operon2 = $operon_adaptor->fetch_by_dbID( $operon->dbID() );

Description

This is a database aware adaptor for the retrieval and storage of operon
objects.

Definition at line 24 of file OperonAdaptor.pm.

Member Function Documentation

◆ _columns()

protected Bio::EnsEMBL::DBSQL::OperonAdaptor::_columns ( )

Undocumented method

Code:
click to view

◆ _objs_from_sth()

protected Bio::EnsEMBL::DBSQL::OperonAdaptor::_objs_from_sth ( )

Undocumented method

Code:
click to view

◆ _tables()

protected Bio::EnsEMBL::DBSQL::OperonAdaptor::_tables ( )

Undocumented method

Code:
click to view

◆ fetch_all()

public Bio::EnsEMBL::DBSQL::OperonAdaptor::fetch_all ( )
  Example     :
$operons = $operon_adaptor->fetch_all();
  Description : Similar to fetch_by_stable_id, but retrieves all
                operons stored in the database.
  Returntype  : listref of Bio::EnsEMBL::Operon
  Caller      : general
  Status      : At Risk
 

/**

Undocumented method

Code:
click to view

◆ fetch_all_by_Slice()

public Reference Bio::EnsEMBL::DBSQL::OperonAdaptor::fetch_all_by_Slice ( )
  Arg [1]    : Bio::EnsEMBL::Slice $slice
               The slice to fetch operons on.
  Arg [2]    : (optional) string $logic_name
               the logic name of the type of features to obtain
  Arg [3]    : (optional) boolean $load_transcripts
               if true, transcripts will be loaded immediately rather than
               lazy loaded later.
  Arg [4]    : (optional) string $source
               the source name of the features to obtain.
  Arg [5]    : (optional) string biotype
                the biotype of the features to obtain.
  Example    :
@operons = @{$operon_adaptor->fetch_all_by_Slice()};
  Description: Overrides superclass method to optionally load transcripts
               immediately rather than lazy-loading them later.  This
               is more efficient when there are a lot of operons whose
               transcripts are going to be used.
  Returntype : reference to list of operons 
  Exceptions : thrown if exon cannot be placed on transcript slice
  Caller     : Slice::get_all_operons
  Status     : Stable
 
Code:
click to view

◆ fetch_all_versions_by_stable_id()

public Listref Bio::EnsEMBL::DBSQL::OperonAdaptor::fetch_all_versions_by_stable_id ( )
  Arg [1]     : String $stable_id 
                The stable ID of the operon to retrieve
  Example     :
$operon = $operon_adaptor->fetch_all_versions_by_stable_id
('ENSG00000148944');
  Description : Similar to fetch_by_stable_id, but retrieves all versions of a
                operon stored in the database.
  Returntype  : listref of Bio::EnsEMBL::Operon
  Exceptions  : if we cant get the operon in given coord system
  Caller      : general
  Status      : At Risk
 
Code:
click to view

◆ fetch_by_name()

public Bio::EnsEMBL::Operon Bio::EnsEMBL::DBSQL::OperonAdaptor::fetch_by_name ( )
  Arg [1]    : String $label - name of operon to fetch
  Example    :
my $operon = $operonAdaptor->fetch_by_name("accBC");
  Description: Returns the operon which has the given display label or undef if
               there is none. If there are more than 1, only the first is
               reported.
  Returntype : Bio::EnsEMBL::Operon
  Exceptions : none
  Caller     : general
  Status     : Stable
 
Code:
click to view

◆ fetch_by_operon_transcript()

public Bio::EnsEMBL::DBSQL::OperonAdaptor::fetch_by_operon_transcript ( )

Undocumented method

Code:
click to view

◆ fetch_by_operon_transcript_id()

public Bio::EnsEMBL::DBSQL::OperonAdaptor::fetch_by_operon_transcript_id ( )

Undocumented method

Code:
click to view

◆ fetch_by_operon_transcript_stable_id()

public Bio::EnsEMBL::Operon Bio::EnsEMBL::DBSQL::OperonAdaptor::fetch_by_operon_transcript_stable_id ( )
  Arg [1]    : string $trans_stable_id
               transcript stable ID whose operon should be retrieved
  Example    :
my $operon = $operon_adaptor->fetch_by_operon_transcript_stable_id
('ENST0000234');
  Description: Retrieves a operon from the database via the stable ID of one of
               its transcripts
  Returntype : Bio::EnsEMBL::Operon
  Exceptions : none
  Caller     : operonral
  Status     : Stable
 
Code:
click to view

◆ fetch_by_stable_id()

public Bio::EnsEMBL::Operon Bio::EnsEMBL::DBSQL::OperonAdaptor::fetch_by_stable_id ( )
  Arg [1]    : String $id 
               The stable ID of the operon to retrieve
  Example    :
$operon = $operon_adaptor->fetch_by_stable_id('ENSG00000148944');
  Description: Retrieves a operon object from the database via its stable id.
               The operon will be retrieved in its native coordinate system (i.e.
               in the coordinate system it is stored in the database). It may
               be converted to a different coordinate system through a call to
               transform() or transfer(). If the operon or exon is not found
               undef is returned instead.
  Returntype : Bio::EnsEMBL::Operon or undef
  Exceptions : if we cant get the operon in given coord system
  Caller     : general
  Status     : Stable
 
Code:
click to view

◆ fetch_by_stable_id_version()

public Bio::EnsEMBL::Operon Bio::EnsEMBL::DBSQL::OperonAdaptor::fetch_by_stable_id_version ( )
  Arg [1]    : String $id 
               The stable ID of the operon to retrieve
  Arg [2]    : Integer $version
               The version of the stable_id to retrieve
  Example    :
$operon = $operon_adaptor->fetch_by_stable_id('16152-16153-4840', 2);
  Description: Retrieves an operon object from the database via its stable id and version.
               The operon will be retrieved in its native coordinate system (i.e.
               in the coordinate system it is stored in the database). It may
               be converted to a different coordinate system through a call to
               transform() or transfer(). If the operon is not found
               undef is returned instead.
  Returntype : Bio::EnsEMBL::Operon or undef
  Exceptions : if we cant get the operon in given coord system
  Caller     : general
  Status     : Stable
 
Code:
click to view

◆ list_dbIDs()

public Listref Bio::EnsEMBL::DBSQL::OperonAdaptor::list_dbIDs ( )
  Example    :
@operon_ids = @{$operon_adaptor->list_dbIDs()};
  Description: Gets an array of internal ids for all operons in the current db
  Arg[1]     : <optional> int. not 0 for the ids to be sorted by the seq_region.
  Returntype : Listref of Ints
  Exceptions : none
  Caller     : general
  Status     : Stable
 
Code:
click to view

◆ list_seq_region_ids()

public Bio::EnsEMBL::DBSQL::OperonAdaptor::list_seq_region_ids ( )

Undocumented method

Code:
click to view

◆ list_stable_ids()

public Reference Bio::EnsEMBL::DBSQL::OperonAdaptor::list_stable_ids ( )
  Example    :
@stable_operon_ids = @{$operon_adaptor->list_stable_ids()};
  Description: Gets an listref of stable ids for all operons in the current db
  Returntype : reference to a list of strings
  Exceptions : none
  Caller     : general
  Status     : Stable
 
Code:
click to view

◆ remove()

public void Bio::EnsEMBL::DBSQL::OperonAdaptor::remove ( )
  Arg [1]    : Bio::EnsEMBL::Operon $operon
               the operon to remove from the database
  Example    :
$operon_adaptor->remove($operon);
  Description: Removes a operon completely from the database. All associated
               transcripts, exons, stable_identifiers, descriptions, etc.
               are removed as well. Use with caution!
  Returntype : none
  Exceptions : throw on incorrect arguments 
               warning if operon is not stored in this database
  Caller     : general
  Status     : Stable
 
Code:
click to view

◆ store()

public The Bio::EnsEMBL::DBSQL::OperonAdaptor::store ( )
  Arg [1]    : Bio::EnsEMBL::Operon $operon
               The operon to store in the database
  Arg [2]    : ignore_release in xrefs [default 1] set to 0 to use release info 
               in external database references
  Example    :
$operon_adaptor->store($operon);
  Description: Stores a operon in the database.
  Returntype : the database identifier (dbID) of the newly stored operon
  Exceptions : thrown if the $operon is not a Bio::EnsEMBL::Operon or if 
               $operon does not have an analysis object
  Caller     : general
  Status     : Stable
 
Code:
click to view

The documentation for this class was generated from the following file:
Bio::EnsEMBL::DBSQL::OperonAdaptor::fetch_all_by_Slice
public Reference fetch_all_by_Slice()
Bio::EnsEMBL::DBSQL::OperonAdaptor::list_seq_region_ids
public list_seq_region_ids()
Bio::EnsEMBL::DBSQL::OperonAdaptor::store
public The store()
Bio::EnsEMBL::Operon
Definition: Operon.pm:30
map
public map()
Bio::EnsEMBL::DBSQL::OperonAdaptor::list_dbIDs
public Listref list_dbIDs()
Bio::EnsEMBL::DBSQL::OperonAdaptor
Definition: OperonAdaptor.pm:24
Bio::EnsEMBL::DBSQL::OperonAdaptor::fetch_all_versions_by_stable_id
public Listref fetch_all_versions_by_stable_id()
Bio::EnsEMBL::DBSQL::OperonAdaptor::_objs_from_sth
protected _objs_from_sth()
Bio::EnsEMBL::DBSQL::OperonAdaptor::remove
public void remove()
Bio::EnsEMBL::DBSQL::OperonAdaptor::fetch_by_stable_id
public Bio::EnsEMBL::Operon fetch_by_stable_id()
Bio::EnsEMBL::DBSQL::OperonAdaptor::fetch_all
public fetch_all()
Bio::EnsEMBL::DBSQL::OperonAdaptor::fetch_by_stable_id_version
public Bio::EnsEMBL::Operon fetch_by_stable_id_version()
Bio::EnsEMBL::DBSQL::OperonAdaptor::_columns
protected _columns()
Bio::EnsEMBL::DBSQL::OperonAdaptor::fetch_by_name
public Bio::EnsEMBL::Operon fetch_by_name()
Bio::EnsEMBL::DBSQL::OperonAdaptor::fetch_by_operon_transcript_stable_id
public Bio::EnsEMBL::Operon fetch_by_operon_transcript_stable_id()
Bio::EnsEMBL::DBSQL::OperonAdaptor::fetch_by_operon_transcript_id
public fetch_by_operon_transcript_id()
Bio::EnsEMBL::DBSQL::OperonAdaptor::_tables
protected _tables()
Bio::EnsEMBL::DBSQL::OperonAdaptor::fetch_by_operon_transcript
public fetch_by_operon_transcript()
Bio::EnsEMBL::DBSQL::BaseFeatureAdaptor::new
public Bio::EnsEMBL::BaseFeatureAdaptor new()
Bio::EnsEMBL::DBSQL::OperonAdaptor::list_stable_ids
public Reference list_stable_ids()