Commit | Line | Data |
6e2766f2 |
1 | package DBIx::Class::Tree; |
bb17efa0 |
2 | # vim: ts=8:sw=4:sts=4:et |
6e2766f2 |
3 | |
4 | use strict; |
5 | use warnings; |
6 | |
6e2766f2 |
7 | use base qw( DBIx::Class ); |
8 | |
806b784d |
9 | our $VERSION = '0.03002'; |
6e2766f2 |
10 | |
11 | 1; |
82958127 |
12 | __END__ |
13 | |
14 | =head1 NAME |
15 | |
af9120b0 |
16 | DBIx::Class::Tree - Manipulate and anaylze tree structured data. |
82958127 |
17 | |
82958127 |
18 | =head1 DESCRIPTION |
19 | |
5e44a0c6 |
20 | The tree modules provide the tools to represent, modify, and analyze |
9d3d72a3 |
21 | trees of data with DBIx::Class. |
22 | |
23 | =head1 COMPONENTS |
24 | |
5e44a0c6 |
25 | L<DBIx::Class::Tree::AdjacencyList> - Manage a tree of data using the |
af9120b0 |
26 | common adjacency list model. |
74d97bdc |
27 | |
5e44a0c6 |
28 | L<DBIx::Class::Tree::AdjacencyList::Ordered> - Glue DBIx::Class::Ordered |
af9120b0 |
29 | and DBIx::Class::Tree::AdjacencyList together. |
74d97bdc |
30 | |
31 | =head1 DAG |
32 | |
5e44a0c6 |
33 | All tree related modules must conform to have and use the basic traversal |
34 | methods of a DAG. For the most part this just means that Tree modules |
35 | must provide the appearance of having multiple parents per node (via a |
36 | parents() method) but may very well never return more than one parent. |
37 | All utility modules, such as a Visitor module, should do its best to |
38 | never assume that a node only has one parent. There are situations |
39 | where this is not possible - in those cases the module's documentation |
74d97bdc |
40 | should clearly state that it is not compatible with DAGs. |
41 | |
5e44a0c6 |
42 | So far there is no Tree::DAG module, but there will be. These requirements |
43 | are vague, and the requirements of Tree modules to be DAG compatible will |
74d97bdc |
44 | become more defined in due course. |
9d3d72a3 |
45 | |
82958127 |
46 | =head1 AUTHOR |
47 | |
48 | Aran Clary Deltac <bluefeet@cpan.org> |
49 | |
50 | =head1 LICENSE |
51 | |
52 | You may distribute this code under the same terms as Perl itself. |
53 | |