.\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.14)
.\"
.\" 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::Axes 3pm"
.TH TM::Axes 3pm "2010-06-20" "perl v5.10.1" "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::Axes \- Topic Maps, Axes for TM::match*
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
The \s-1TM\s0 module offers the method \f(CW\*(C`match\*(C'\fR (and friends) to query assertions in a \s-1TM\s0 data
structure. While there is a generic search specification, it will be too slow. Instead some axes
have been implemented specifically. These are listed below.
.SH "SEARCH SPECIFICATIONS"
.IX Header "SEARCH SPECIFICATIONS"
Automatically generated from \s-1TM\s0 (1.54)
.IP "Code:<empty>" 4
.IX Item "Code:<empty>"
returns all assertions
.IP "Code:anyid" 4
.IX Item "Code:anyid"
return all assertions where a given toplet appears somehow
.Sp
.Vb 1
\&          \*(Aqanyid\*(Aq => \*(Aqthe toplet\*(Aq
.Ve
.IP "Code:aplayer.arole.bplayer.brole.type" 4
.IX Item "Code:aplayer.arole.bplayer.brole.type"
return all assertions of a given type where a given toplet plays a given role and there exist another given role with another given toplet as player
.Sp
.Vb 5
\&          \*(Aqbplayer\*(Aq => \*(Aqthe player for the brole\*(Aq,
\&          \*(Aqaplayer\*(Aq => \*(Aqthe player toplet for the arole\*(Aq,
\&          \*(Aqarole\*(Aq => \*(Aqthe role toplet (incl subclasses) for the aplayer\*(Aq,
\&          \*(Aqtype\*(Aq => \*(Aqthe type of the assertion\*(Aq,
\&          \*(Aqbrole\*(Aq => \*(Aqthe other role toplet (incl subclasses)\*(Aq
.Ve
.IP "Code:aplayer.arole.brole.type" 4
.IX Item "Code:aplayer.arole.brole.type"
return all assertions of a given type where a given toplet plays a given role and there exist another given role
.Sp
.Vb 4
\&          \*(Aqaplayer\*(Aq => \*(Aqthe player toplet for the arole\*(Aq,
\&          \*(Aqarole\*(Aq => \*(Aqthe role toplet (incl subclasses) for the aplayer\*(Aq,
\&          \*(Aqtype\*(Aq => \*(Aqthe type of the assertion\*(Aq,
\&          \*(Aqbrole\*(Aq => \*(Aqthe other role toplet (incl subclasses)\*(Aq
.Ve
.IP "Code:char.irole" 4
.IX Item "Code:char.irole"
deprecated: return all assertions which are characteristics for a given toplet
.Sp
.Vb 2
\&          \*(Aqirole\*(Aq => \*(Aqthe toplet for which characteristics are sought\*(Aq,
\&          \*(Aqchar\*(Aq => \*(Aq1\*(Aq
.Ve
.IP "Code:char.topic" 4
.IX Item "Code:char.topic"
return all assertions which are characteristics for a given toplet
.Sp
.Vb 2
\&          \*(Aqtopic\*(Aq => \*(Aqthe toplet for which characteristics are sought\*(Aq,
\&          \*(Aqchar\*(Aq => \*(Aq1\*(Aq
.Ve
.IP "Code:char.topic.type" 4
.IX Item "Code:char.topic.type"
return all assertions which are a characteristic of a given type for a given topic
.Sp
.Vb 3
\&          \*(Aqtopic\*(Aq => \*(Aqthe toplet for which these characteristics are sought\*(Aq,
\&          \*(Aqchar\*(Aq => \*(Aq1\*(Aq,
\&          \*(Aqtype\*(Aq => \*(Aqtype of characteristic\*(Aq
.Ve
.IP "Code:char.type" 4
.IX Item "Code:char.type"
return all assertions which are characteristics for some given type
.Sp
.Vb 2
\&          \*(Aqchar\*(Aq => \*(Aq1\*(Aq,
\&          \*(Aqtype\*(Aq => \*(Aqthe characteristic type\*(Aq
.Ve
.IP "Code:char.type.value" 4
.IX Item "Code:char.type.value"
return all assertions which are characteristics for some topic of a given value for some given type
.Sp
.Vb 3
\&          \*(Aqvalue\*(Aq => \*(Aqthe value for which all characteristics are sought\*(Aq,
\&          \*(Aqchar\*(Aq => \*(Aq1\*(Aq,
\&          \*(Aqtype\*(Aq => \*(Aqthe characteristic type\*(Aq
.Ve
.IP "Code:char.value" 4
.IX Item "Code:char.value"
return all assertions which are characteristics for some topic of a given value
.Sp
.Vb 2
\&          \*(Aqvalue\*(Aq => \*(Aqthe value for which all characteristics are sought\*(Aq,
\&          \*(Aqchar\*(Aq => \*(Aq1\*(Aq
.Ve
.IP "Code:class.type" 4
.IX Item "Code:class.type"
returns all assertions where there are instances of a given toplet
.Sp
.Vb 2
\&          \*(Aqclass\*(Aq => \*(Aqwhich toplet should be the class\*(Aq,
\&          \*(Aqtype\*(Aq => \*(Aqisa\*(Aq
.Ve
.IP "Code:instance.type" 4
.IX Item "Code:instance.type"
returns all assertions where there are classes of a given toplet
.Sp
.Vb 2
\&          \*(Aqtype\*(Aq => \*(Aqisa\*(Aq,
\&          \*(Aqinstance\*(Aq => \*(Aqwhich toplet should be the instance\*(Aq
.Ve
.IP "Code:iplayer" 4
.IX Item "Code:iplayer"
return all assertions where a given toplet is a player
.Sp
.Vb 1
\&          \*(Aqiplayer\*(Aq => \*(Aqthe player toplet\*(Aq
.Ve
.IP "Code:iplayer.irole" 4
.IX Item "Code:iplayer.irole"
return all assertions where a given toplet is a player of a given role
.Sp
.Vb 2
\&          \*(Aqiplayer\*(Aq => \*(Aqthe player toplet\*(Aq,
\&          \*(Aqirole\*(Aq => \*(Aqthe role toplet (incl subclasses)\*(Aq
.Ve
.IP "Code:iplayer.irole.type" 4
.IX Item "Code:iplayer.irole.type"
return all assertions of a given type where a given toplet is a player of a given role
.Sp
.Vb 3
\&          \*(Aqiplayer\*(Aq => \*(Aqthe player toplet\*(Aq,
\&          \*(Aqirole\*(Aq => \*(Aqthe role toplet (incl subclasses)\*(Aq,
\&          \*(Aqtype\*(Aq => \*(Aqthe type of the assertion\*(Aq
.Ve
.IP "Code:iplayer.type" 4
.IX Item "Code:iplayer.type"
return all assertions of a given type where a given toplet is a player
.Sp
.Vb 2
\&          \*(Aqiplayer\*(Aq => \*(Aqthe player toplet\*(Aq,
\&          \*(Aqtype\*(Aq => \*(Aqthe type of the assertion\*(Aq
.Ve
.IP "Code:irole" 4
.IX Item "Code:irole"
return all assertions where there is a given role
.Sp
.Vb 1
\&          \*(Aqirole\*(Aq => \*(Aqthe role toplet (incl subclasses)\*(Aq
.Ve
.IP "Code:irole.type" 4
.IX Item "Code:irole.type"
return all assertions of a given type where there is a given role
.Sp
.Vb 2
\&          \*(Aqirole\*(Aq => \*(Aqthe role toplet (incl subclasses)\*(Aq,
\&          \*(Aqtype\*(Aq => \*(Aqthe type of the assertion\*(Aq
.Ve
.IP "Code:lid" 4
.IX Item "Code:lid"
return one particular assertions with a given \s-1ID\s0
.Sp
.Vb 1
\&          \*(Aqlid\*(Aq => \*(Aqthe ID of the assertion\*(Aq
.Ve
.IP "Code:nochar" 4
.IX Item "Code:nochar"
returns all associations (so no names or occurrences)
.Sp
.Vb 1
\&          \*(Aqnochar\*(Aq => \*(Aq1\*(Aq
.Ve
.IP "Code:subclass.type" 4
.IX Item "Code:subclass.type"
returns all assertions where there are subclasses of a given toplet
.Sp
.Vb 2
\&          \*(Aqsubclass\*(Aq => \*(Aqwhich toplet should be the superclass\*(Aq,
\&          \*(Aqtype\*(Aq => \*(Aqis\-subclass\-of\*(Aq
.Ve
.IP "Code:superclass.type" 4
.IX Item "Code:superclass.type"
returns all assertions where there are superclasses of a given toplet
.Sp
.Vb 2
\&          \*(Aqsuperclass\*(Aq => \*(Aqwhich toplet should be the subclass\*(Aq,
\&          \*(Aqtype\*(Aq => \*(Aqis\-subclass\-of\*(Aq
.Ve
.IP "Code:type" 4
.IX Item "Code:type"
return all assertions with a given type
.Sp
.Vb 1
\&          \*(Aqtype\*(Aq => \*(Aqthe type of the assertion\*(Aq
.Ve
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\s-1TM\s0
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
Copyright 200[8] 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.