EnsEMBL::Web::Proxy::Object

Location: /modules/EnsEMBL/Web/Proxy/Object.pm
Source code · Permalink

Inherits from:

No subclasses

Overview

Accessor

Constructor

Method

  • AUTOLOAD (EnsEMBL::Web::Proxy)
  • can (EnsEMBL::Web::Proxy)
  • new (EnsEMBL::Web::Proxy)
  • ref (EnsEMBL::Web::Proxy)

Unknown

  • DESTROY (EnsEMBL::Web::Proxy)
  • clear_problems (EnsEMBL::Web::Proxy)
  • get_problem_type (EnsEMBL::Web::Proxy)
  • has_a_problem (EnsEMBL::Web::Proxy)
  • has_fatal_problem (EnsEMBL::Web::Proxy)
  • has_problem_type (EnsEMBL::Web::Proxy)
  • problem (EnsEMBL::Web::Proxy)
  • species_defs (EnsEMBL::Web::Proxy)
  • timer (EnsEMBL::Web::Proxy)
  • timer_push (EnsEMBL::Web::Proxy)
  • user_details (EnsEMBL::Web::Proxy)
Documentation coverage: 56 %

Methods

    AUTOLOAD
    Nasty Voodoo magic

    Loop through all the plugins and if they can perform the requested function action it on the child objects....

    If the function sets __data->{'_drop_through_'} to 1 then no further action is taken...

    If it sets it to a value other than one then this function is called after the function has been called on all the other children
    Inherited from EnsEMBL::Web::Proxy
    View source

    __children
    Accessor. returns a reference to the array of child (EnsEMBL::*::$supertype::$objecttype) objects
    Inherited from EnsEMBL::Web::Proxy
    View source

    __data
    Accessor. return data hash
    Inherited from EnsEMBL::Web::Proxy
    View source

    __objecttype
    Accessor. gets type of Object being proxied (e.g. Gene/Transcript/Location/...)
    Inherited from EnsEMBL::Web::Proxy
    View source

    __supertype
    Accessor. gets supertype of Proxy (i.e. Factory/Object;)
    Inherited from EnsEMBL::Web::Proxy
    View source

    action
    Accessor.
    Inherited from EnsEMBL::Web::Proxy
    View source

    can
    Nasty Voodoo magic (part II)

    Because we have an AUTOLOAD function all functions are possible and can will always return 1 - so we over-ride can to return 1 if any child can perform this function.
    Inherited from EnsEMBL::Web::Proxy
    View source

    function
    Accessor.
    Inherited from EnsEMBL::Web::Proxy
    View source

    new
    Constructor. Constructs a proxy object - which wraps EnsEMBL::*::Object::$object s Takes three parameters - the type of object (Gene,Transcript,SNP etc), the underlying EnsEMBL object and the "common" data hash passed from
    View source

    new
    Creates a new Proxy object. Usually called from EnsEMBL::Web::Proxy::Object.

    The EnsEMBL::Web::Factory of a particular Ensembl type (such as EnsEMBL::Web::Factory::User sets up necessary parameters in the EnsEMBL::Web::Factory::User::createObjects style method. This method usually calls EnsEMBL::Web::Factory::dataObjects, setting a newly created EnsEMBL::Web::Proxy::Object as the Factory's data object.

    On creating a new EnsEMBL::Web::Proxy::Object, a data type (such as 'User'), an "object" and a set of data parameters are used to configure the new data object are specified. These values are passed back to this method:
  • The data type is accessible as $type
  • The data parameters are accessible as the $data hashref
  • The "object" is accessible via the _object key of the %extra_elements hash


    • The "object" can be a reference to any Perl type, blessed or unblessed, and is passed on to the Ensembl data type (such as Location, User etc) as part of a hashref with many other configuration settings (the SpeciesDefs object, the user id, the script config settings), which may or may not have been set by default, or been configured in the data parameters passed in from the EnsEMBL::Web::Proxy::Object instantiation.

    In essence, should you want a set of parameters to be sent to a particular Ensembl data type for use in initialising an object of that type, these parameters should be sent as the "object" when a new EnsEMBL::Web::Proxy::Object is defined in the type's Factory.

    It is interesting to note that this instantiation process contains all the hall
    marks of a good Poirot novel obfuscation, misdirection, intrege and murder.

    Inherited from EnsEMBL::Web::Proxy
    View source

    parent
    Accessor.
    Inherited from EnsEMBL::Web::Proxy
    View source

    ref
    Nasty Voodoo magic (part III)

    Ref will just return that you have a Proxy object - but we don't want to to do so this function the underlying object type (and also what children are also
    Inherited from EnsEMBL::Web::Proxy
    View source

    script
    Accessor.
    Inherited from EnsEMBL::Web::Proxy
    View source

    species
    Accessor. sets/gets species
    Inherited from EnsEMBL::Web::Proxy
    View source


← Home · Source code