Bio::EnsEMBL::DBSQL::MergedAdaptor Class Reference

Public Member Functions
public Bio::EnsEMBL::DBSQL::MergedAdaptor	new ()
protected	_populate_adaptors ()
public	add_list ()
public	add_adaptor ()
public Boolean	can ()
public Boolean	isa ()
public Boolean	AUTOLOAD ()
public	DESTROY ()

Detailed Description

Synopsis

# load all available adaptors of the given type for the species
my $merged_adaptor = Bio::EnsEMBL::DBSQL::MergedAdaptor->new(
  -species => "human",
  -type    => "gene"
);
 
# only load adaptors from the given groups of the given type for the species
my $merged_adaptor = Bio::EnsEMBL::DBSQL::MergedAdaptor->new(
  -species => "human",
  -type    => "gene",
  -groups  => ['core','otherfeatures']
);

Description

The MergedAdaptor object is merely a list of adaptors. AUTOLOAD is used
to call a subroutine on each adaptor and merge the results. This object structure
allows you to treat a set of adaptors as a logical single entity. The end result
is that disparate database source data sets are accessible through a single
adaptor call.

This code will convert single object return calls into ArrayRef returning calls
and so is only safe to use with the fetch_all_XXX or get_all_XXX methods.

Definition at line 36 of file MergedAdaptor.pm.

Member Function Documentation

_populate_adaptors()

protected Bio::EnsEMBL::DBSQL::MergedAdaptor::_populate_adaptors

(

)

  Arg [1]      : String species name to get adaptors for
  Arg [2]      : String type to get adaptors for
  Arg [3]      : (optional) ArrayRef of groups to load
  Description  : Auto-populates the current MergedAdaptor with the
                 adaptors linked to this species, type and optional set of groups
  Caller       : general
  Status       : At Risk

Code:

add_adaptor()

public Bio::EnsEMBL::DBSQL::MergedAdaptor::add_adaptor

(

)

Undocumented method

Code:

add_list()

public Bio::EnsEMBL::DBSQL::MergedAdaptor::add_list

(

)

  Arg [n]     : Adaptors to add into this instance
  Description : Adds the given adaptors to the internal adaptor list

Code:

  Arg [1]     : Adaptor to add into this instance
  Description : Adds the given adaptor to the internal adaptor list. For
                multiple adaptor addition use add_list().

/**

AUTOLOAD()

public Boolean Bio::EnsEMBL::DBSQL::MergedAdaptor::AUTOLOAD

(

)

  Description : Internal override of AUTLOAD. The code will detect the requested
                method, loop through all available adaptors and will 
  Returntype  : Boolean indicating if any delegating object inherits from the given class

Code:

can()

public Boolean Bio::EnsEMBL::DBSQL::MergedAdaptor::can

(

)

  Arg [1]     : String method name to be called
  Description : Implementation of UNIVERSAL::can(). We loop through the
                available adaptors and return true if any will respond
                to the given method name
  Returntype  : Boolean indicating if any delegating object will respond to this method

Code:

DESTROY()

public Bio::EnsEMBL::DBSQL::MergedAdaptor::DESTROY

(

)

Undocumented method

Code:

isa()

public Boolean Bio::EnsEMBL::DBSQL::MergedAdaptor::isa

(

)

  Arg [1]     : String method name to be called
  Description : Implementation of UNIVERSAL::isa(). We loop through the
                available adaptors and return true if any inherited from
                the given class
  Returntype  : Boolean indicating if any delegating object inherits from the given class

Code:

new()

public Bio::EnsEMBL::DBSQL::MergedAdaptor Bio::EnsEMBL::DBSQL::MergedAdaptor::new

(

)

  Arg [SPECIES]: String species name to get adaptors for
  Arg [TYPE]   : String type to get adaptors for
  Arg [GROUPS] : (optional) ArrayRef of groups to load
  Example      :

my $adaptor = Bio::EnsEMBL::DBSQL::MergedAdaptor->new(
                   -species=> 'human', -type =>'Population', -groups => ['Sanger','Ensembl']);
                my $alL_adaptor = Bio::EnsEMBL::DBSQL::MergedAdaptor->new(
                   -species=> 'human', -type =>'Population');

  Description: Creates a new MergedAdaptor.
  Returntype : Bio::EnsEMBL::DBSQL::MergedAdaptor
  Exceptions : throws if species or type not specified
  Caller     : general
  Status     : At Risk
             : Under development

Code:

---

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

• ensembl/modules/Bio/EnsEMBL/DBSQL/MergedAdaptor.pm