Bio::DB::BioSQL::BasePersistenceAdaptor Bio::DB::BioSQL::BasePersistenceAdaptor contains DESCRIPTION of Object.
Download

Bio::DB::BioSQL::BasePersistenceAdaptor Ranking & Summary

Bio::DB::BioSQL::BasePersistenceAdaptor Tags

Perl module object description BioSQL object description Bio SQL

Bio::DB::BioSQL::BasePersistenceAdaptor Description

Bio::DB::BioSQL::BasePersistenceAdaptor contains DESCRIPTION of Object. Bio::DB::BioSQL::BasePersistenceAdaptor contains DESCRIPTION of Object.APPENDIXThe rest of the documentation details each of the object methods. Internal methods are usually preceded with a _new Title : new Usage : my $obj = new Bio::DB::BioSQL::BasePersistenceAdaptor(); Function: Builds a new Bio::DB::BioSQL::BasePersistenceAdaptor object Returns : an instance of Bio::DB::BioSQL::BasePersistenceAdaptor Args :Methods for managing persistenceThis comprises of creating an object in the database (equivalent to an insert), storing an object in the database (equivalent to an update), removing an object from the database (equivalent to a delete), and adding and removing associations between objects when the underlying schema supports such associations.create Title : create Usage : $objectstoreadp->create($obj, @params) Function: Creates the object as a persistent object in the datastore. This is equivalent to an insert. Example : Returns : A Bio::DB::PersistentObjectI implementing object wrapping the inserted object. Args : The object to be inserted, and optionally additional (named) parameters. A common parameter will be -fkobjs, with a reference to an array of foreign key objects that are not retrievable from the persistent object itself.store Title : store Usage : $objectstoreadp->store($persistent_obj,@params) Function: Updates the given persistent object in the datastore. Example : Returns : TRUE on success and FALSE otherwise Args : The object to be updated, and optionally additional (named) parameters. A common parameter will be -fkobjs, with a reference to an array of foreign key objects that are not retrievable from the persistent object itself.remove Title : remove Usage : $objectstoreadp->remove($persistent_obj, @params) Function: Removes the persistent object from the datastore. Example : Returns : TRUE on success and FALSE otherwise Args : The object to be removed, and optionally additional (named) parameters.add_association Title : add_assocation Usage : Function: Stores the association between given objects in the datastore. Example : Returns : TRUE on success and FALSE otherwise Args : Named parameters. At least the following must be recognized: -objs a reference to an array of objects to be associated with each other -values a reference to a hash the keys of which are abstract column names and the values are values of those columns. These columns are generally those other than the ones for foreign keys to the entities to be associated -contexts optional; if given it denotes a reference to an array of context keys (strings), which allow the foreign key name to be determined through the slot-to-column map rather than through foreign_key_name(). This may be necessary if more than one object of the same type takes part in the association. The array must be in the same order as -objs, and have the same number of elements. Put undef for objects for which there are no multiple contexts. Caveats: Make sure you *always* give the objects to be associated in the same order.remove_association Title : remove_assocation Usage : Function: Removes the association between the given objects in the datastore. Example : Returns : TRUE on success and FALSE otherwise Args : Named parameters. At least the following must be recognized: -objs a reference to an array of objects the association between which is to be removed -values a reference to a hash the keys of which are abstract column names and the values are values of those columns. These columns are generally those other than the ones for foreign keys to the entities to be associated. Supplying this is only necessary if those columns participate in a unique key by which to find those associations to be removed. -contexts optional; if given it denotes a reference to an array of context keys (strings), which allow the foreign key name to be determined through the slot-to-column map rather than through foreign_key_name(). This may be necessary if more than one object of the same type takes part in the association. The array must be in the same order as -objs, and have the same number of elements. Put undef for objects for which there are no multiple contexts. Caveats: Make sure you *always* give the objects to be associated in the same order. Requirements: · Perl

Bio::DB::BioSQL::BasePersistenceAdaptor Related Software