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