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

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

Public Member Functions
public	unikey ()
public	branch_code ()
public	get_my_targets ()
public	get_my_targets_grouped_by_condition ()
protected	_compute_unitargets ()
public	unitargets ()
public String	toString ()
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 ()
Public Member Functions inherited from Bio::EnsEMBL::Hive::Cacheable
public	hive_pipeline ()
public	is_local_to ()
public	count_local_and_remote_objects ()
public	relative_display_name ()
public	relative_url ()
public	display_name ()
public	unikey ()

Detailed Description

Description

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

    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'

Definition at line 20 of file DataflowRule.pm.

Member Function Documentation

_compute_unitargets()

protected Bio::EnsEMBL::Hive::DataflowRule::_compute_unitargets

(

)

Undocumented method

Code:

branch_code()

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

(

)

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

Code:

get_my_targets()

public Bio::EnsEMBL::Hive::DataflowRule::get_my_targets

(

)

Undocumented method

Code:

get_my_targets_grouped_by_condition()

public Bio::EnsEMBL::Hive::DataflowRule::get_my_targets_grouped_by_condition

(

)

Undocumented method

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:

unitargets()

public Bio::EnsEMBL::Hive::DataflowRule::unitargets

(

)

Undocumented method

Code:

---

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

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