NAME
Bio::DB::BioSQL::ClusterAdaptor - DESCRIPTION of Object
SYNOPSIS
Give standard usage here
DESCRIPTION
Describe the object here
FEEDBACK
Mailing Lists
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.
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 - Hilmar Lapp
Email hlapp at gmx.net
APPENDIX
The rest of the documentation details each of the object methods. Internal methods are usually preceded with a _
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.
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.
A Bio::ClusterI references a namespace with authority, and
possibly a species.
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.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.
ClusterIs have a BioNamespace as foreign key, and possibly
a species.
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.
Bio::ClusterI has annotations as children.
Example :
Returns : TRUE on success, and FALSE otherwise
Args : The Bio::DB::PersistentObjectI implementing object for which the
child objects shall be made persistent.remove_children
Title : remove_children
Usage :
Function: This method is to cascade deletes in maintained objects.
We need to undefine the primary keys of all contained
annotation objects 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().remove_members
Title : remove_members
Usage :
Function: Dissociates all cluster members from this cluster.
Note that this method does not delete the members
themselves, it only removes the association between them
and this cluster.
Example :
Returns : TRUE on success and FALSE otherwise
Args : The persistent object for which to remove the membersattach_children
Title : attach_children
Usage :
Function: Possibly retrieve and attach child objects of the given object.
This is needed when whole object trees are supposed to be built
when a base object is queried for and returned. An example would
be Bio::SeqI objects and all the annotation objects that hang off
of it.
This is called by the find_by_XXXX() methods once the base object
has been built.
For Bio::ClusterIs, we need to get the annotation objects.
Example :
Returns : TRUE on success, and FALSE otherwise.
Args : The object for which to find and to which to attach the child
objects.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.
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, a Bio::Factory::ObjectFactoryI compliant object to
be used for creating the object.populate_from_row
Title : populate_from_row
Usage :
Function: Populates an object with values from columns of the row.
Example :
Returns : The object populated, 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.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.
Most of these methods cache certain adaptors or otherwise reduce call
path and object creation overhead. There's no magic here._bionamespace_adaptor
Title : _bionamespace_adaptor
Usage : $obj->_bionamespace_adaptor($newval)
Function: Get/set cached persistence adaptor for the bionamespace.
In OO speak, consider the access class of this method protected.
I.e., call from descendants, but not from outside.
Example :
Returns : value of _bionamespace_adaptor (a Bio::DB::PersistenceAdaptorI
instance)
Args : new value (a Bio::DB::PersistenceAdaptorI instance, optional)_cluster_factory
Title : _cluster_factory
Usage : $obj->_cluster_factory($newval)
Function: Get/set the Bio::Factory::ObjectFactoryI to use
Example :
Returns : value of _cluster_factory (a scalar)
Args : on set, new value (a scalar or undef, optional)_object_slot
Title : _object_slot
Usage : $term = $obj->_object_slot($slot, $value);
Function: Obtain the persistent L<Bio::Annotation::SimpleValue>
representation of certain slots that map to ontology term
associations (e.g. size).
This is an internal method.
Example :
Returns : A persistent L<Bio::Annotation::SimpleValue> object
Args : The slot for which to obtain the SimpleValue object.
The value of the slot._ontology_term
Title : _ontology_term
Usage : $term = $obj->_ontology_term($name,$ontology)
Function: Obtain the persistent ontology term with the given name
and ontology.
This is an internal method.
Example :
Returns : A persistent Bio::Ontology::TermI object
Args : The name for the term.
The ontology name for the term.
Whether or not to find the term.