NAME
Bio::DB::BioSQL::ReferenceAdaptor - DESCRIPTION of Object
SYNOPSIS
Give standard usage here
DESCRIPTION
Adaptor for Reference objects inside bioperl db
FEEDBACK
Mailing Lists
User feedback is an integral part of the evolution of this and other Bioperl modules. Send your references and suggestions preferably to one of the Bioperl mailing lists. Your participation is much appreciated.
bioperl-l@bio.perl.orgReporting Bugs
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:
bioperl-bugs@bio.perl.org
http://bugzilla.open-bio.org/AUTHOR - Elia Stupka, Hilmar Lapp
Email elia@ebi.ac.uk Email hlapp at gmx.net
APPENDIX
The rest of the documentation details each of the object methods. Internal methods are usually preceded with a _
new
Title : new
Usage :
Function: Instantiates the persistence adaptor.
Example :
Returns :
Args :get_persistent_slots
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 updatedget_persistent_slot_values
Title : get_persistent_slot_values
Usage :
Function: Obtain the values for the slots returned by get_persistent_slots(),
in exactly that order.
The reason this method is here is that sometimes the actual slot
values need to be post-processed to yield the value that gets
actually stored in the database. E.g., slots holding arrays
will need some kind of join function applied. Another example is if
the method call needs additional arguments. Supposedly the
adaptor for a specific interface knows exactly what to do here.
Since there is also populate_from_row() the adaptor has full
control over mapping values to a version that is actually stored.
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.get_foreign_key_objects
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.
Bio::Annotation::Reference has a virtual dbxref (e.g., the
MEDLINE link) as foreign key. Virtual means that in the
object model there is no such reference, but there is in
the BioSQL schema.
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.attach_foreign_key_objects
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.
Bio::Annotation::Reference has a virtual dbxref (e.g., the
MEDLINE link) as foreign key. Virtual means that in the
object model there is no such reference, but there is in
the BioSQL schema.
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().store_children
Title : store_children
Usage :
Function: Inserts or updates the child entities of the given object in
the datastore.
Example :
Returns : TRUE on success, and FALSE otherwise
Args : The Bio::DB::PersistentObjectI implementing object for which the
child objects shall be made persistent.
Optionally, additional named parameters. A common parameter will
be -assoc_objs, with a reference to an array of objects to which
this object should be associated in the database if those objects
are not retrievable from the persistent object itself.remove_children
Title : remove_children
Usage :
Function: This method is to cascade deletes in maintained objects.
We just return TRUE here, because the dbxref child is only
virtual.
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().instantiate_from_row
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.populate_from_row
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.
Usually a derived class will instantiate the proper class and pass
it on to populate_from_row().
This method MUST be overridden by a derived object.
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().get_unique_key_query
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.Overridden Inherited Methods
add_association
Title : add_assocation
Usage :
Function: Stores the association between given objects in the datastore.
We override this here to add start() and end() to the values
hash. Everything else is left untouched and passed on to the
inherited implementation.
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
-obj_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
association map rather than through foreign_key_name().
This is 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 "default" for objects for which there
are no multiple contexts.
Caveats: Make sure you *always* give the objects to be associated in the
same order.Internal methods
These are mostly private or 'protected.' Methods which are in the
latter class have this explicitly stated in their
documentation. 'Protected' means you may call these from derived
classes, but not from outside._dbxref_adaptor
Title : _dbxref_adaptor
Usage : $obj->_dbxref_adaptor($newval)
Function: Get/set cached persistence adaptor for a bioperl DBLink object.
In OO speak, consider the access class of this method protected.
I.e., call from descendants, but not from outside.
Example :
Returns : value of _dbxref_adaptor (a Bio::DB::PersistenceAdaptorI
instance)
Args : new value (a Bio::DB::PersistenceAdaptorI instance, optional)_dblink_fk
Title : _dblink_fk
Usage : $fk_dbl = $obj->_dblink_fk()
Function: Get the L<Bio::Annotation::DBLink> object representing
the foreign key of references to their db_xref, if there
is a medline ID.
Example :
Returns : A persistent Bio::Annotation::DBLink object
Args : The Bio::Annotation::Reference object for which to emulate
the foreign key object_crc64
Title : _crc64
Usage :
Function: Computes and returns the CRC64 checksum for a given
reference object.
The method uses the reference's authors, title, and
location properties.
Example :
Returns : the CRC64 as a string
Args : the Bio::Annotation::Reference object for which to compute
the CRC