Bio::EnsEMBL::Hive::Utils::Collection Class Reference

Public Member Functions
public	new ()
public	listref ()
public	list ()
public	present ()
public	add ()
public	add_once ()
public	forget ()
public	find_one_by ()
public	find_all_by ()
protected	_find_all_by_subpattern ()
public	find_all_by_pattern ()
public	dark_collection ()
public	forget_and_mark_for_deletion ()
public	DESTROY ()

Detailed Description

Definition at line 5 of file Collection.pm.

Member Function Documentation

_find_all_by_subpattern()

protected Bio::EnsEMBL::Hive::Utils::Collection::_find_all_by_subpattern

(

)

Undocumented method

Code:

add()

public Bio::EnsEMBL::Hive::Utils::Collection::add

(

)

Undocumented method

Code:

add_once()

public Bio::EnsEMBL::Hive::Utils::Collection::add_once

(

)

Undocumented method

Code:

dark_collection()

public Bio::EnsEMBL::Hive::Utils::Collection::dark_collection

(

)

Undocumented method

Code:

DESTROY()

public Bio::EnsEMBL::Hive::Utils::Collection::DESTROY

(

)

Undocumented method

Code:

find_all_by()

public Bio::EnsEMBL::Hive::Utils::Collection::find_all_by

(

)

Undocumented method

Code:

find_all_by_pattern()

public Bio::EnsEMBL::Hive::Utils::Collection::find_all_by_pattern

(

)

  Arg [1]    : (optional) string $pattern
  Example    :

my $first_fifteen_analyses_and_two_more = $collection->find_all_by_pattern( '1..15,analysis_X,21' );

  Example    :

my $two_open_ranges = $collection->>find_all_by_pattern( '..7,10..' );

  Example    :

my $double_exclusion = $collection->find_all_by_pattern( '1..15-3..5+4' );

  Example    :

my $blast_related_with_exceptions = $collection->find_all_by_pattern( 'blast%-12-%funnel' );

  Description: Filters an arrayref of non-repeating objects from the given collection by interpreting a pattern.
                The pattern can contain individual analyses_ids, individual logic_names,
                open and closed ranges of analysis_ids, wildcard patterns of logic_names,
                merges (+ or ,) and exclusions (-) of the above subsets.
  Exceptions : none
  Caller     : both beekeeper.pl (for scheduling) and runWorker.pl (for specialization)

Code:

find_one_by()

public Bio::EnsEMBL::Hive::Utils::Collection::find_one_by

(

)

Undocumented method

Code:

forget()

public Bio::EnsEMBL::Hive::Utils::Collection::forget

(

)

Undocumented method

Code:

forget_and_mark_for_deletion()

public Bio::EnsEMBL::Hive::Utils::Collection::forget_and_mark_for_deletion

(

)

Undocumented method

Code:

list()

public Bio::EnsEMBL::Hive::Utils::Collection::list

(

)

Undocumented method

Code:

listref()

public Bio::EnsEMBL::Hive::Utils::Collection::listref

(

)

Undocumented method

Code:

new()

public Bio::EnsEMBL::Hive::Utils::Collection::new

(

)

Undocumented method

Code:

present()

public Bio::EnsEMBL::Hive::Utils::Collection::present

(

)

Undocumented method

Code:

---

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

• modules/Bio/EnsEMBL/Hive/Utils/Collection.pm