Bio::EnsEMBL::Hive::DataflowRule Class Reference

Inheritance diagram for Bio::EnsEMBL::Hive::DataflowRule:

Collaboration diagram for Bio::EnsEMBL::Hive::DataflowRule:

Public Member Functions
public	unikey ()
public	branch_code ()
public	input_id_template ()
public String	to_analysis_url ()
public Bio::EnsEMBL::Hive::Analysis	to_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

    A data container object (methods are intelligent getters/setters) that corresponds to a row stored in 'dataflow_rule' table:

    CREATE TABLE dataflow_rule (
        dataflow_rule_id    int(10) unsigned NOT NULL AUTO_INCREMENT,
        from_analysis_id    int(10) unsigned NOT NULL,
        branch_code         int(10) default 1 NOT NULL,
        funnel_dataflow_rule_id  int(10) unsigned default NULL,
        to_analysis_url     varchar(255) default '' NOT NULL,
        input_id_template   TEXT DEFAULT NULL,

        PRIMARY KEY (dataflow_rule_id),
        UNIQUE (from_analysis_id, to_analysis_url)
    );

    A dataflow rule is activated when a Bio::EnsEMBL::Hive::AnalysisJob::dataflow_output_id is called at any moment during a RunnableDB's execution.
    The current RunnableDB's analysis ($from_analysis) and the requested $branch_code (1 by default) define the entry conditions,
    and whatever rules match these conditions will generate new jobs with input_ids specified in the dataflow_output_id() call.
    If input_id_template happens to contain a non-NULL value, it will be used to generate the corresponding intput_id instead.

    Jessica's remark on the structure of to_analysis_url:
        Extended from design of SimpleRule concept to allow the 'to' 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

branch_code()

public Bio::EnsEMBL::Hive::DataflowRule::branch_code

(

)

    Function: getter/setter method for the branch_code of the dataflow rule

Code:

input_id_template()

public Bio::EnsEMBL::Hive::DataflowRule::input_id_template

(

)

    Function: getter/setter method for the input_id_template of the dataflow rule

Code:

to_analysis()

public Bio::EnsEMBL::Hive::Analysis Bio::EnsEMBL::Hive::DataflowRule::to_analysis

(

)

    Usage   : $self->to_analysis($analysis);
    Function: Get/set method for the goal analysis object of this rule.
    Returns : Bio::EnsEMBL::Hive::Analysis
    Args    : Bio::EnsEMBL::Hive::Analysis

Code:

to_analysis_url()

public String Bio::EnsEMBL::Hive::DataflowRule::to_analysis_url

(

)

    Arg[1]  : (optional) string $url
    Usage   : $self->to_analysis_url($url);
    Function: Get/set method for the 'to' analysis objects URL for this rule
    Returns : string

Code:

toString()

public String Bio::EnsEMBL::Hive::DataflowRule::toString

(

)

    Args       : (none)
    Example    :

print $df_rule->toString()."\n";

    Description: returns a stringified representation of the rule
    Returntype : string

Code:

unikey()

public Bio::EnsEMBL::Hive::DataflowRule::unikey

(

)

Undocumented method

Code:

---

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

• modules/Bio/EnsEMBL/Hive/DataflowRule.pm