Migration finished
[dbsrgits/DBIx-Class-Tree.git] / README
CommitLineData
609f3762 1NAME
2 DBIx::Class::Tree - Manipulate and anaylze tree structured data.
609f3762 3
4DESCRIPTION
5 The tree modules provide the tools to represent, modify, and analyze
6 trees of data with DBIx::Class.
7
8COMPONENTS
9 DBIx::Class::Tree::AdjacencyList - Manage a tree of data using the
af9120b0 10 common adjacency list model.
609f3762 11
12 DBIx::Class::Tree::AdjacencyList::Ordered - Glue DBIx::Class::Ordered
af9120b0 13 and DBIx::Class::Tree::AdjacencyList together.
609f3762 14
15DAG
16 All tree related modules must conform to have and use the basic
17 traversal methods of a DAG. For the most part this just means that Tree
18 modules must provide the appearance of having multiple parents per node
19 (via a parents() method) but may very well never return more than one
20 parent. All utility modules, such as a Visitor module, should do its
21 best to never assume that a node only has one parent. There are
22 situations where this is not possible - in those cases the module's
23 documentation should clearly state that it is not compatible with DAGs.
24
25 So far there is no Tree::DAG module, but there will be. These
26 requirements are vague, and the requirements of Tree modules to be DAG
27 compatible will become more defined in due course.
28
29AUTHOR
30 Aran Clary Deltac <bluefeet@cpan.org>
31
32LICENSE
33 You may distribute this code under the same terms as Perl itself.
34