Bio::DB::Persistent ObjectRellMapperI
SummaryIncluded librariesPackage variablesSynopsisDescriptionGeneral documentationMethods
Toolbar
WebCvs
Summary
Bio::DB::Persistent::ObjectRelMapperI - DESCRIPTION of Interface
Package variables
No package variables defined.
Included modules
Bio::Root::RootI
Carp
Inherit
Bio::Root::RootI
Synopsis
Give standard usage here
Description
Describe the interface here
Methods
table_nameDescriptionCode
association_table_nameDescriptionCode
primary_key_nameDescriptionCode
foreign_key_nameDescriptionCode
slot_attribute_mapDescriptionCode
Methods description
table_namecode    nextTop
 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.
association_table_namecodeprevnextTop
 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.
primary_key_namecodeprevnextTop
 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)
foreign_key_namecodeprevnextTop
 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.
slot_attribute_mapcodeprevnextTop
 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.
Methods code
table_namedescriptionprevnextTop
sub table_name {
    shift->throw_not_implemented();
}
association_table_namedescriptionprevnextTop
sub association_table_name {
    shift->throw_not_implemented();
}
primary_key_namedescriptionprevnextTop
sub primary_key_name {
    shift->throw_not_implemented();
}
foreign_key_namedescriptionprevnextTop
sub foreign_key_name {
    shift->throw_not_implemented();
}
slot_attribute_mapdescriptionprevnextTop
sub slot_attribute_map {
    shift->throw_not_implemented();
}

1;
}
General documentation
FEEDBACKTop
Mailing ListsTop
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.
  bioperl-l@bioperl.org                  - General discussion
http://bioperl.org/wiki/Mailing_lists - About the mailing lists
Support Top
 
Please direct usage questions or support issues to the mailing list:

bioperl-l@bioperl.org

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.
Reporting BugsTop
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:
  http://bugzilla.open-bio.org/
AUTHOR - Hilmar LappTop
Email hlapp at gmx.net
Describe contact details here
CONTRIBUTORSTop
Additional contributors names and emails here
APPENDIXTop
The rest of the documentation details each of the object methods.
Internal methods are usually preceded with a _