Inheritance diagram for Bio::EnsEMBL::Hive::Storable:

Public Member Functions
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

Synopsis

my $dbID = $storable_object->dbID();

my $adaptor = $storable_object->adaptor();

Description

    Storable is a base class for anything that can be stored.
    It provides two getters/setters: dbID() and adaptor().

Definition at line 20 of file Storable.pm.

Member Function Documentation

◆ adaptor()

public Bio::EnsEMBL::Hive::DBSQL::BaseAdaptor Bio::EnsEMBL::Hive::Storable::adaptor ( )

    Arg [1]         : Bio::EnsEMBL::Hive::DBSQL::BaseAdaptor $adaptor
    Description     : getter/setter for this objects Adaptor
    Returntype      : Bio::EnsEMBL::Hive::DBSQL::BaseAdaptor
    Caller          : general, set from adaptor on store
    Status          : stable

Code:

click to view

◆ AUTOLOAD()

public Bio::EnsEMBL::Hive::Storable::AUTOLOAD ( )

Undocumented method

Code:

click to view

sub AUTOLOAD {
    our $AUTOLOAD;
#print "Storable::AUTOLOAD : attempting to run '$AUTOLOAD' (".join(', ', @_).")\n";
    my $sub;
    if($AUTOLOAD =~ /::(\w+)$/) {
        my $name_to_parse = $1;
        my ($AdaptorType, $is_an_id, $foo_id_method_name, $foo_obj_method_name)
            = Bio::EnsEMBL::Hive::DBSQL::DBAdaptor->parse_underscored_id_name( $name_to_parse );
        unless($AdaptorType) {
            throw("Storable::AUTOLOAD : could not parse '$name_to_parse'");
        } elsif ($is_an_id) {  # $name_to_parse was something like foo_dataflow_rule_id
          $sub = sub {
            my $self = shift @_;
            if(@_) {
                $self->{$foo_id_method_name} = shift @_;
                $self->{$foo_obj_method_name} = undef;  # invalidate the object itself
                # attempt to lazy-load:
            } elsif( !$self->{$foo_id_method_name} and my $foo_object=$self->{$foo_obj_method_name}) {
                $self->{$foo_id_method_name} = $foo_object->dbID;
#                warn "Lazy-loaded dbID (".$self->{$foo_id_method_name}.") from $AdaptorType object\n";
            }
            return $self->{$foo_id_method_name};
          };
        } else {                # $name_to_parse was something like foo_dataflow_rule
          $sub = sub {
            my $self = shift @_;
            if(@_) {    # setter of the object itself
                $self->{$foo_obj_method_name} = shift @_;
                $self->{$foo_id_method_name} = undef;   # invalidate the object_id
                # attempt to lazy-load:
            } elsif( !$self->{$foo_obj_method_name} and my $foo_object_id = $self->{$foo_id_method_name}) {
                my $collection = $self->hive_pipeline && $self->hive_pipeline->collection_of($AdaptorType);
                if( $collection and $self->{$foo_obj_method_name} = $collection->find_one_by('dbID', $foo_object_id) ) { # careful: $AdaptorType may not be unique (aliases)
                    weaken($self->{$foo_obj_method_name});
#                    warn "Lazy-loading object from $AdaptorType collection\n";
                } elsif(my $adaptor = $self->adaptor) {
#                    warn "Lazy-loading object from $AdaptorType adaptor\n";
                    $self->{$foo_obj_method_name} = $adaptor->db->get_adaptor( $AdaptorType )->fetch_by_dbID( $foo_object_id );
                } else {
#                    warn "Cannot lazy-load $foo_obj_method_name because the ".ref($self)." is not attached to an adaptor";
                }
            }
            return $self->{$foo_obj_method_name};
          };
        }   # choice of autoloadable functions
        {
            no strict 'refs'; ## no critic ProhibitNoStrict
             {$AUTOLOAD} = $sub;
            goto &$sub;
        }
    }
}

◆ dbID()

public Int Bio::EnsEMBL::Hive::Storable::dbID ( )

    Arg [1]         : int $dbID
    Description     : getter/setter for the database internal id
    Returntype      : int
    Caller          : general, set from adaptor on store
    Status          : stable

Code:

click to view

◆ DESTROY()

public Bio::EnsEMBL::Hive::Storable::DESTROY ( )

Undocumented method

Code:

click to view

◆ new()

public Bio::EnsEMBL::Hive::Storable Bio::EnsEMBL::Hive::Storable::new ( )

    Args            : pairs of ($method_name, $value)
    Caller          : ObjectAdaptor, AnalysisJob, HivePipeline, seed_pipeline.pl, standaloneJob.pl
    Description     : create a new Storable object 
    Returntype      : Bio::EnsEMBL::Hive::Storable
    Status          : stable

Code:

click to view

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

modules/Bio/EnsEMBL/Hive/Storable.pm

Public Member Functions

Detailed Description

Synopsis

Description

Member Function Documentation

◆ adaptor()

◆ AUTOLOAD()

◆ dbID()

◆ DESTROY()

◆ new()