Uid App
=======

.. _uid-app:

All stuff related with image :ref:`The Unified Internal Database` and site pages like index and about
are defined in this module.

uid.models
----------

Submission and user data
^^^^^^^^^^^^^^^^^^^^^^^^

Inside model library, you can manage :ref:`The Unified Internal Database` objects.
The main object is :py:class:`uid.models.Submission` which is the object that
a registered user create when starts creating a new submission. Animals and Samples
data loaded by user are manged by the :py:class:`uid.models.Animal` and
:py:class:`uid.models.Sample` class. The original name of such objects (defined
as ``Data source id`` from the IMAGE metadata rules) is managed by
:py:class:`uid.models.Animal` and :py:class:`uid.models.Sample` respectively
which track also the ``biosample_id`` of such objects and its :ref:`Common statuses`.
Here are presented the relations between :py:class:`uid.models.Submission` objects:

.. image:: ../_static/uid_submission.1degree.png

Through relationship, you could rerieve all animal belonging to a submission,
for example::

  from uid.models import Submission, Animal

  submission = Submission.objects.get(pk=1)
  animals = Animal.objects.filter(submission=submission)

in this example ``animals`` is a :py:class:`django.db.models.query.QuerySet` instance
with all animals defined in selected submission. You can also fecth all animals
from the submission instance itself::

  animals = submission.animal_set

This command is equivalent of the previous.

Private data
^^^^^^^^^^^^

Submission data (Animals, Samples) are considered private to the user when they are stored in
:ref:`The Unified Internal Database`. Each table (:py:class:`django.models.Model`)
has an ``owner`` column in which a relation to :py:class:`django.contrib.auth.models.User`
is defined. In such way, is possible to get all objects belonging to such user::

  from uid.models import User

  user = User.objects.get(username="test")
  user_animals = Animal.objects.filter(owner=user)

:py:class:`django.contrib.auth.models.User` are also contained in authenticated
sessions, and could be used in Views::

  user_animals = Animal.objects.filter(owner=request.user)

The :py:class:`common.views.OwnerMixin` extends the default ``get_queryset`` of
:py:class:`django.views.generic.detail.SingleObjectMixin` in order to filter
``QuerySet`` using ``self.request.user``. Such Mixin can be inherited by all
:py:class:`django.views.generic.detail.SingleObjectMixin` and
:py:class:`django.views.generic.list.MultipleObjectMixin` derived classes in
order to filter objects relying on django authenticated sessions::

  from django.views.generic import DetailView, ListView

  from uid.models import Submission
  from common.views import OwnerMixin

  class DetailSubmissionView(OwnerMixin, DetailView):
      model = Submission
      template_name = "submissions/submission_detail.html"

  class ListSubmissionsView(OwnerMixin, ListView):
      model = Submission
      template_name = "submissions/submission_list.html"
      ordering = ['-created_at']
      paginate_by = 10

since :py:class:`common.views.OwnerMixin` inherits from
:py:class:`django.contrib.auth.mixins.LoginRequiredMixin`, an authentication
sessions is required to access to derived views. The login redirect will be managed
if the session is anonymous

uid.models module contents
^^^^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: uid.models
   :members:
   :show-inheritance:


uid.mixins
----------------

uid.mixins module contents
^^^^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: uid.mixins
  :members:
  :show-inheritance:
  :undoc-members:


uid.views
----------------

uid.views module contents
^^^^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: uid.views
  :members:
  :show-inheritance:
  :undoc-members: