.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.22)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.ie \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.el \{\
.    de IX
..
.\}
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "TM::Tree 3pm"
.TH TM::Tree 3pm "2010-02-15" "perl v5.14.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
TM::Tree \- Topic Maps, trait for induced tree retrieval
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 4
\&  use TM::Materialized::AsTMa;
\&  my $tm = new TM::Materialized::AsTMa (file => \*(Aqold_testament.atm\*(Aq);
\&  Class::Trait\->apply ( $tm => \*(AqTM::Tree\*(Aq );
\&  $tm\->sync_in;
\&
\&  # old\-testament pedigree
\&  print Dumper $tm\->tree (lid   => \*(Aqadam\*(Aq,
\&                          type  => \*(Aqhas\-parent\*(Aq,
\&                          arole => \*(Aqparent\*(Aq,
\&                          brole => \*(Aqchild\*(Aq );
\&
\&  # new\-testament inverse pedigree
\&  print Dumper $tm\->tree (lid   => \*(Aqgw\-bush\*(Aq,
\&                          type  => \*(Aqhas\-parent\*(Aq,
\&                          arole => \*(Aqchild\*(Aq,
\&                          brole => \*(Aqparent\*(Aq );
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Obviously, topic maps can carry information which is tree structured. A family pedigree is a typical
example of it; associations having a particular type, particular roles and you can derive a tree
structure from that.
.PP
This is exactly what this operator does: it takes one topic map basis and primed with a starting
node, an association type and two roles a tree will be returned to the caller.
.SH "INTERFACE"
.IX Header "INTERFACE"
.SS "Methods"
.IX Subsection "Methods"
.IP "\fBtree\fR" 4
.IX Item "tree"
\&\fI\f(CI$treeref\fI\fR = \fI\f(CI$tm\fI\fR\->tree (
                 \fI\f(CI$start_topic\fI\fR,
                 \fI\f(CI$type_topic\fI\fR,
                 \fI\f(CI$role_topic\fI\fR,
                 \fI\f(CI$role_topic\fI\fR,
                 [ depth => \fI\f(CI$integer\fI\fR ])
.Sp
\&\fI\f(CI$treeref\fI\fR = \fI\f(CI$tm\fI\fR\->tree_x (
                 \fI\f(CI$start_topic\fI\fR,
                 \fI\f(CI$type_topic\fI\fR,
                 \fI\f(CI$role_topic\fI\fR,
                 \fI\f(CI$role_topic\fI\fR,
                 [ depth => \fI\f(CI$integer\fI\fR ])
.Sp
This function will analyze the topic map and will detect all maplets of the given type (direct and
indirect ones) having the specified roles. Starting from the \fIstart topic\fR it will so find other
topics playing the \fIbrole\fR. Those will be used as a next starting point, and so forth.
.Sp
To avoid the tree to become too big, you can impose an optional limit. Loops are detected.
.Sp
Every output tree node contains following fields:
.RS 4
.ie n .IP """lid"":" 4
.el .IP "\f(CWlid\fR:" 4
.IX Item "lid:"
the lid of the node
.ie n .IP """children"":" 4
.el .IP "\f(CWchildren\fR:" 4
.IX Item "children:"
a list reference of child nodes, there is no specific sort order
.ie n .IP """children*"":" 4
.el .IP "\f(CWchildren*\fR:" 4
.IX Item "children*:"
\&\fBNote\fR: This is currently deactivated.
.Sp
for convenience this list reference contains all children, grand-children, grand-grand
children.... of this node (this list is neither sorted nor unique out of performance
considerations).
.RE
.RS 4
.Sp
The version \f(CW\*(C`tree_x\*(C'\fR does not honor subclassing of roles and type (but \f(CW\*(C`tree\*(C'\fR does). This means
that is can be considerably faster, especially if you use it for taxonomy stuff with \f(CW\*(C`isa\*(C'\fR and
\&\f(CW\*(C`is\-subclass\-of\*(C'\fR.
.RE
.IP "\fBtaxonomy\fR" 4
.IX Item "taxonomy"
\&\fI\f(CI$treeref\fI\fR = \fI\f(CI$tm\fI\fR\->taxonomy ([ \fI\f(CI$start_lid\fI\fR ])
.Sp
This function is a specialization of \f(CW\*(C`tree\*(C'\fR, in that it looks at a particular association type
(\f(CW\*(C`is\-subclass\-of\*(C'\fR) and the appropriate roles (\f(CW\*(C`superclass\*(C'\fR, \f(CW\*(C`subclass\*(C'\fR). Obviously the result is
a tree holding all subtypes.
.Sp
The only optional parameter is a toplet \f(CW\*(C`lid\*(C'\fR; that becomes the starting point of the tree. If that
parameter is missing, \f(CW\*(C`thing\*(C'\fR is assumed.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\s-1TM\s0
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
Copyright 200[3\-6] by Robert Barta, <drrho@cpan.org>
.PP
This library is free software; you can redistribute it and/or modify it under the same terms as Perl
itself.