.\" Automatically generated by Pod::Man 4.10 (Pod::Simple 3.35)
.\"
.\" 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" ''
.    ds C`
.    ds C'
'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 >0, 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.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "TM::Materialized::Stream 3pm"
.TH TM::Materialized::Stream 3pm "2019-09-07" "perl v5.28.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::Materialized::Stream \- Topic Maps, abstract class for maps with stream based input/output drivers
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&  # this class will never be directly used for instantiation
\&  # see the description in TM and individual low\-level drivers (AsTMa, ...)
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This class is a subclass of \s-1TM\s0, so it implements map objects. It is abstract, though, as it only
defined how a stream-based driver package should behave. It may thus be inherited by classes which
implement external formats (TM::Materialized::AsTMa, TM::Materialized::XML, ....).
.SH "INTERFACE"
.IX Header "INTERFACE"
.SS "Constructor"
.IX Subsection "Constructor"
The constructor of implementations should expect a hash as parameter containing the field(s) from
\&\s-1TM\s0 and one or more of the following:
.IP "\fIurl\fR:" 4
.IX Item "url:"
If given, then the instance will be read from this url whenever synced in.
.IP "\fIfile\fR:" 4
.IX Item "file:"
If given, then the data will be read/written from/to this file. This is just a convenience as it
will be mapped to \fIurl\fR.
.IP "\fIinline\fR:" 4
.IX Item "inline:"
If given, then the instance will be read directly from this text provided inline when synced.
.PP
If several fields (\f(CW\*(C`file\*(C'\fR, \f(CW\*(C`url\*(C'\fR, \f(CW\*(C`inline\*(C'\fR) are specified, it is undefined which one will be
taken.
.PP
Examples (using AsTMa):
.PP
.Vb 2
\&   # opening from an AsTMa= file
\&   $atm = new TM::Materialized::AsTMa (file   => \*(Aqhere.atm\*(Aq);
\&
\&   # why need a file? files are evil, anyway
\&   $atm = new TM::Materialized::AsTMa (inline => \*(Aq# this is AsTMa\*(Aq);
.Ve
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\s-1TM\s0
.SH "AUTHOR INFORMATION"
.IX Header "AUTHOR INFORMATION"
Copyright 200[2\-6], Robert Barta <drrho@cpan.org>, All rights reserved.
.PP
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.
http://www.perl.com/perl/misc/Artistic.html