docs/models/entities.rst

   1 Entities and Attributes
   2 =======================
   3
   4 .. automodule:: philo.models.base
   5
   6 One of the core concepts in Philo is the relationship between the :class:`Entity` and :class:`Attribute` classes. :class:`Attribute`\ s represent an arbitrary key/value pair by having one :class:`GenericForeignKey` to an :class:`Entity` and another to an :class:`AttributeValue`.
   7
   8
   9 Attributes
  10 ----------
  11
  12 .. autoclass:: Attribute
  13         :members:
  14
  15 .. autoclass:: AttributeValue
  16         :members:
  17
  18 .. automodule:: philo.models.base
  19         :members: attribute_value_limiter
  20
  21 .. autoclass:: JSONValue
  22         :show-inheritance:
  23
  24 .. autoclass:: ForeignKeyValue
  25         :show-inheritance:
  26
  27 .. autoclass:: ManyToManyValue
  28         :show-inheritance:
  29
  30 .. automodule:: philo.models.base
  31         :noindex:
  32         :members: value_content_type_limiter
  33
  34 .. autofunction:: register_value_model(model)
  35 .. autofunction:: unregister_value_model(model)
  36
  37 Entities
  38 --------
  39
  40 .. autoclass:: Entity
  41         :members:
  42         :exclude-members: attribute_set
  43
  44 .. autoclass:: TreeManager
  45         :members:
  46
  47 .. autoclass:: TreeEntity
  48         :show-inheritance:
  49         :members:
  50         :exclude-members: attribute_set
  51
  52         .. attribute:: objects
  53
  54                 An instance of :class:`TreeManager`.
  55
  56         .. automethod:: get_path