- AUTHOR - Hilmar Lapp
- Methods overriden from BasePersistenceAdaptor
- Private methods
Bio::DB::BioSQL::RelationshipAdaptor - DESCRIPTION of Object
Give standard usage here
Bio::Ontology::RelationshipI DB adaptor
User feedback is an integral part of the evolution of this and other Bioperl modules. Send your comments and suggestions preferably to one of the Bioperl mailing lists. Your participation is much appreciated.
Please direct usage questions or support issues to the mailing list:
rather than to the module maintainer directly. Many experienced and reponsive experts will be able look at the problem and quickly address it. Please include a thorough description of the problem with code and data examples if at all possible.
Report bugs to the Bioperl bug tracking system to help us keep track the bugs and their resolution. Bug reports can be submitted via email or the web:
AUTHOR - Hilmar Lapp
Email hlapp at gmx.net
The rest of the documentation details each of the object methods. Internal methods are usually preceded with a _
Title : new Usage : Function: Instantiates the persistence adaptor. Example : Returns : Args :
Title : get_persistent_slots Usage : Function: Get the slots of the object that map to attributes in its respective entity in the datastore. Slots should be methods callable without an argument. Example : Returns : an array of method names constituting the serializable slots Args : the object about to be inserted or updated
Title : get_persistent_slot_values Usage : Function: Obtain the values for the slots returned by get_persistent_slots(), in exactly that order. Example : Returns : A reference to an array of values for the persistent slots of this object. Individual values may be undef. Args : The object about to be serialized. A reference to an array of foreign key objects if not retrievable from the object itself.
Title : get_foreign_key_objects Usage : Function: Gets the objects referenced by this object, and which therefore need to be referenced as foreign keys in the datastore. Note that the objects are expected to implement Bio::DB::PersistentObjectI. An implementation needs to make sure that the order of foreign key objects returned is always the same. Example : Returns : an array of Bio::DB::PersistentObjectI implementing objects Args : The object about to be inserted or updated, or undef if the call is for a SELECT query. In the latter case return class or interface names that are mapped to the foreign key tables. 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.
Title : attach_foreign_key_objects Usage : Function: Attaches foreign key objects to the given object as far as necessary. This method is called after find_by_XXX() queries, not for INSERTs or UPDATEs. Example : Returns : TRUE on success, and FALSE otherwise. Args : The object to which to attach foreign key objects. A reference to an array of foreign key values, in the order of foreign keys returned by get_foreign_key_objects().
Title : remove_children Usage : Function: This method is to cascade deletes in maintained objects. We just return TRUE here. Example : Returns : TRUE on success and FALSE otherwise Args : The persistent object that was just removed from the database. Additional (named) parameter, as passed to remove().
Title : instantiate_from_row Usage : Function: Instantiates the class this object is an adaptor for, and populates it with values from columns of the row. This implementation call populate_from_row() to do the real job. Example : Returns : An object, or undef, if the row contains no values Args : A reference to an array of column values. The first column is the primary key, the other columns are expected to be in the order returned by get_persistent_slots(). Optionally, the object factory to be used for instantiating the proper class. The adaptor must be able to instantiate a default class if this value is undef.
Title : populate_from_row Usage : Function: Instantiates the class this object is an adaptor for, and populates it with values from columns of the row. Example : Returns : An object, or undef, if the row contains no values Args : The object to be populated. A reference to an array of column values. The first column is the primary key, the other columns are expected to be in the order returned by get_persistent_slots().
Title : get_unique_key_query Usage : Function: Obtain the suitable unique key slots and values as determined by the attribute values of the given object and the additional foreign key objects, in case foreign keys participate in a UK. Example : Returns : One or more references to hash(es) where each hash represents one unique key, and the keys of each hash represent the names of the object's slots that are part of the particular unique key and their values are the values of those slots as suitable for the key. Args : The object with those attributes set that constitute the chosen unique key (note that the class of the object will be suitable for the adaptor). A reference to an array of foreign key objects if not retrievable from the object itself.
Title : remove_all_relationships Usage : Function: Removes all relationships within a given ontology. This is mostly a convenience method for calling remove_association() with the appropriate arguments. Example : Returns : TRUE on success and FALSE otherwise Args : the ontology as an Bio::Ontology::OntologyI compliant object
Methods overriden from BasePersistenceAdaptor
These are mostly convenience and/or short-hand methods.
Title : _ont_adaptor Usage : $obj->_ont_adaptor($newval) Function: Get/set the ontology persistence adaptor. Example : Returns : value of _ont_adaptor (a Bio::DB::PersistenceAdaptorI object) Args : on set, new value (a Bio::DB::PersistenceAdaptorI object or undef, optional)
Title : _term_adaptor Usage : $obj->_term_adaptor($newval) Function: Get/set the ontology term persistence adaptor. Example : Returns : value of _term_adaptor (a Bio::DB::PersistenceAdaptorI object) Args : on set, new value (a Bio::DB::PersistenceAdaptorI object or undef, optional)