ensembl-hive  2.1
 All Classes Namespaces Files Functions Pages
Bio::EnsEMBL::Hive::Analysis Class Reference
+ Inheritance diagram for Bio::EnsEMBL::Hive::Analysis:
+ Collaboration diagram for Bio::EnsEMBL::Hive::Analysis:

Public Member Functions

public unikey ()
 
public logic_name ()
 
public module ()
 
public parameters ()
 
public failed_job_tolerance ()
 
public max_retry_count ()
 
public can_be_empty ()
 
public priority ()
 
public meadow_type ()
 
public analysis_capacity ()
 
public get_compiled_module_name ()
 
public String url ()
 
public display_name ()
 
public
Bio::EnsEMBL::Hive::AnalysisStats 
stats ()
 
public jobs_collection ()
 
public control_rules_collection ()
 
public dataflow_rules_collection ()
 
public toString ()
 
- Public Member Functions inherited from Bio::EnsEMBL::Hive::Cacheable
public collection ()
 
public unikey ()
 
public add_new_or_update ()
 
- Public Member Functions inherited from Bio::EnsEMBL::Hive::Storable
public Bio::EnsEMBL::Hive::Storable new ()
 
public Int dbID ()
 
public
Bio::EnsEMBL::Hive::DBSQL::BaseAdaptor 
adaptor ()
 
public DESTROY ()
 
public AUTOLOAD ()
 

Detailed Description

Description

    An Analysis object represents a "stage" of the Hive pipeline that groups together
    all jobs that share the same module and the same common parameters.

    Individual Jobs are said to "belong" to an Analysis.

    Control rules unblock when their condition Analyses are done.

Member Function Documentation

public Bio::EnsEMBL::Hive::Analysis::analysis_capacity ( )

Undocumented method

Code:
click to view
public Bio::EnsEMBL::Hive::Analysis::can_be_empty ( )

Undocumented method

Code:
click to view
public Bio::EnsEMBL::Hive::Analysis::control_rules_collection ( )

Undocumented method

Code:
click to view
public Bio::EnsEMBL::Hive::Analysis::dataflow_rules_collection ( )

Undocumented method

Code:
click to view
public Bio::EnsEMBL::Hive::Analysis::display_name ( )

Undocumented method

Code:
click to view
public Bio::EnsEMBL::Hive::Analysis::failed_job_tolerance ( )

Undocumented method

Code:
click to view
public Bio::EnsEMBL::Hive::Analysis::get_compiled_module_name ( )

Undocumented method

Code:
click to view
public Bio::EnsEMBL::Hive::Analysis::jobs_collection ( )

Undocumented method

Code:
click to view
public Bio::EnsEMBL::Hive::Analysis::logic_name ( )

Undocumented method

Code:
click to view
public Bio::EnsEMBL::Hive::Analysis::max_retry_count ( )

Undocumented method

Code:
click to view
public Bio::EnsEMBL::Hive::Analysis::meadow_type ( )

Undocumented method

Code:
click to view
public Bio::EnsEMBL::Hive::Analysis::module ( )

Undocumented method

Code:
click to view
public Bio::EnsEMBL::Hive::Analysis::parameters ( )

Undocumented method

Code:
click to view
public Bio::EnsEMBL::Hive::Analysis::priority ( )

Undocumented method

Code:
click to view
public Bio::EnsEMBL::Hive::AnalysisStats Bio::EnsEMBL::Hive::Analysis::stats ( )
  Arg [1]    : none
  Example    :
$stats = $analysis->stats;
  Description: returns either the previously cached AnalysisStats object, or if it is missing - pulls a fresh one from the DB.
  Returntype : Bio::EnsEMBL::Hive::AnalysisStats object
  Exceptions : none
  Caller     : general
 
Code:
click to view
public Bio::EnsEMBL::Hive::Analysis::toString ( )

Undocumented method

Code:
click to view
public Bio::EnsEMBL::Hive::Analysis::unikey ( )

Undocumented method

Code:
click to view
public String Bio::EnsEMBL::Hive::Analysis::url ( )
  Arg [1]    : none
  Example    :
$url = $analysis->url;
  Description: Constructs a URL string for this database connection
               Follows the general URL rules.
  Returntype : string of format
               mysql://<user>:<pass><host>:<port>/<dbname>/analysis?logic_name=<name>
  Exceptions : none
  Caller     : general
 
Code:
click to view

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