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

Public Member Functions

public unikey ()
 
public String condition_analysis_url ()
 
public Bio::EnsEMBL::Hive::Analysis condition_analysis ()
 
public String 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 control rule' is a high level blocking control structure where there is
    a 'ctrled_analysis' which is 'BLOCKED' from running until all of its 'condition_analysis' are 'DONE'.
    If a ctrled_analysis requires multiple analysis to be DONE before it can run, a separate
    AnalysisCtrlRule must be created/stored for each condtion analysis.

    Allows the 'condition' analysis to be specified with a network savy URL like
    mysql://ensadmin:\@ecs2:3361/compara_hive_test?analysis.logic_name='blast_NCBI34'

Member Function Documentation

public Bio::EnsEMBL::Hive::Analysis Bio::EnsEMBL::Hive::AnalysisCtrlRule::condition_analysis ( )
    Arg[1]  : (optional) Bio::EnsEMBL::Hive::Analysis object
    Usage   : $self->condition_analysis($anal);
    Function: Get/set method for the analysis which must be 'DONE' in order for
                the controlled analysis to be un-BLOCKED
    Returns : Bio::EnsEMBL::Hive::Analysis
 
Code:
click to view
public String Bio::EnsEMBL::Hive::AnalysisCtrlRule::condition_analysis_url ( )
    Arg[1]  : (optional) string $url
    Usage   : $self->condition_analysis_url($url);
    Function: Get/set method for the analysis which must be 'DONE' in order for
                the controlled analysis to be un-BLOCKED. Specified as a URL.
    Returns : string
 
Code:
click to view
public String Bio::EnsEMBL::Hive::AnalysisCtrlRule::toString ( )
    Args       : (none)
    Example    :
print $c_rule->toString()."\n";
    Description: returns a stringified representation of the rule
    Returntype : string
 
Code:
click to view
public Bio::EnsEMBL::Hive::AnalysisCtrlRule::unikey ( )

Undocumented method

Code:
click to view

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