- AUTHOR - Hilmar Lapp
Bio::DB::Persistent::ObjectRelMapperI - DESCRIPTION of Interface
Give standard usage here
Describe the interface here
User feedback is an integral part of the evolution of this and other Bioperl modules. Send your comments and suggestions preferably to the Bioperl mailing list. Your participation is much appreciated.
email@example.com - General discussion http://bioperl.org/wiki/Mailing_lists - About the mailing lists
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 of the bugs and their resolution. Bug reports can be submitted via the web:
Email hlapp at gmx.net
Describe contact details here
Additional contributors names and emails here
The rest of the documentation details each of the object methods. Internal methods are usually preceded with a _
Title : table_name Usage : Function: Obtain the name of the table in the relational schema corresponding to the given class name, object, or persistence adaptor. Example : Returns : the name of the table (a string), or undef if the table cannot be determined Args : The referenced object, class name, or the persistence adaptor for it.
Title : association_table_name Usage : Function: Obtain the name of the table in the relational schema corresponding to the association of entities as represented by their corresponding class names, objects, or persistence adaptors. Example : Returns : the name of the table (a string) Args : A reference to an array of objects, class names, or persistence adaptors. The array may freely mix types.
Title : primary_key_name Usage : Function: Obtain the name of the primary key attribute for the given table in the relational schema. Example : Returns : The name of the primary key (a string) Args : The name of the table (a string)
Title : foreign_key_name Usage : Function: Obtain the foreign key name for referencing an object, as represented by object, class name, or the persistence adaptor. Example : Returns : the name of the foreign key (a string) Args : The referenced object, class name, or the persistence adaptor for it.
Title : slot_attribute_map Usage : Function: Get/set the mapping for each entity from object slot names to column names. Example : Returns : A reference to a hash map with entity names being the keys, if no key (entity name, object, or adaptor) was provided. Otherwise, a hash reference with the slot names being keys to their corresponding column names. Args : Optionally, the object, adaptor, or entity for which to obtain the map. Optionally, on set a reference to a hash map satisfying the features of the returned value.