Added docs for Collections.
[philo.git] / docs / models / entities.rst
1 Entities and Attributes
2 =======================
3
4 .. module:: 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    :members: value_content_type_limiter
32
33 .. autofunction:: register_value_model(model)
34 .. autofunction:: unregister_value_model(model)
35
36 Entities
37 --------
38
39 .. autoclass:: Entity
40    :members:
41    :exclude-members: attribute_set
42
43 .. autoclass:: TreeManager
44    :members:
45
46 .. autoclass:: TreeEntity
47    :members:
48    :exclude-members: attribute_set
49
50    .. attribute:: objects
51
52       An instance of :class:`TreeManager`.
53    
54    .. automethod:: get_path