.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43)
.\"
.\" 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 "GO::IO::OBDXML 3pm"
.TH GO::IO::OBDXML 3pm "2023-12-18" "perl v5.36.0" "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"
.Vb 1
\&  GO::IO::OBDXML \- dump GO terms as xml
.Ve
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&    my $apph = GO::AppHandle\->connect(\-d=>$go, \-dbhost=>$dbhost);
\&    my $term = $apph\->get_term({acc=>00003677});
\&
\&    #### ">\-" is STDOUT
\&    my $out = new FileHandle(">\-");
\&
\&    my $xml_out = GO::IO::OBDXML\->new(\-output=>$out);
\&    $xml_out\->start_document();
\&    $xml_out\->draw_term($term);
\&    $xml_out\->end_document();
.Ve
.PP
\&\s-1OR:\s0
.PP
.Vb 3
\&    my $apph = GO::AppHandle\->connect(\-d=>$go, \-dbhost=>$dbhost);
\&    my $term = $apph\->get_node_graph(\-acc=>00003677, \-depth=>2);
\&    my $out = new FileHandle(">\-");
\&
\&    my $xml_out = GO::IO::OBDXML(\-output=>$out);
\&    $xml_out\->start_document();
\&    $xml_out\->draw_graph($term, 3677);
\&    $xml_out\->end_document();
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Utility class to dump \s-1GO\s0 terms as \s-1OBD XML.\s0  Currently you just call
start_ducument, then draw_term for each term, then end_document.
.SS "new"
.IX Subsection "new"
.Vb 3
\&    Usage   \- my $xml_out = GO::IO::OBDXML\->new(\-output=>$out);
\&    Returns \- None
\&    Args    \- Output FileHandle
.Ve
.PP
Initializes the writer object.  To write to standard out, do:
.PP
my \f(CW$out\fR = new FileHandle(\*(L">\-\*(R");
my \f(CW$xml_out\fR = new \s-1GO::IO::OBDXML\s0(\-output=>$out);
.SS "cgi_header"
.IX Subsection "cgi_header"
.Vb 3
\&    Usage   \- $xml_out\->cgi_header;
\&    Returns \- None
\&    Args    \- None
.Ve
.PP
cgi_header prints the \*(L"Content-type: text/xml\*(R" statement.
If creating a \s-1CGI\s0 script, you should call this before start_document.
.SS "start_document"
.IX Subsection "start_document"
.Vb 3
\&    Usage   \- $xml_out\->start_document;
\&    Returns \- None
\&    Args    \- None
.Ve
.PP
start_document takes care of the fiddly bits like xml declarations,
namespaces, etc.  It draws the initial tags and leaves the document
ready to add go:term nodes.
.SS "start_graph"
.IX Subsection "start_graph"
.Vb 3
\&    Usage   \- $xml_out\->start_graph;
\&    Returns \- None
\&    Args    \- None
.Ve
.PP
start_graph opens a new graph segment.
.SS "end_document"
.IX Subsection "end_document"
.Vb 1
\&    Usage   \- $xml_out\->end_document;
.Ve
.PP
Call this when done.
.SS "end_graph"
.IX Subsection "end_graph"
.Vb 1
\&    Usage   \- $xml_out\->end_graph;
.Ve
.PP
Call this when done a graph segment.
.SS "draw_node_graph"
.IX Subsection "draw_node_graph"
.Vb 7
\&    Usage   \- $xml_out\->draw_node_graph(\-graph=>$graph);
\&    Returns \- None
\&    Args    \-graph=>$graph,
\&            \-show_associations=>\*(Aqyes\*(Aq or \*(Aqno\*(Aq, # optional, default \*(Aqyes\*(Aq.
\&            \-show_terms=>\*(Aqyes\*(Aq or \*(Aqno\*(Aq,        # optional, default \*(Aqyes\*(Aq.
\&            \-show_xrefs=>\*(Aqyes\*(Aq or \*(Aqno\*(Aq,        # optional, default \*(Aqyes\*(Aq.
\&            \-show_evidence=>\*(Aqyes\*(Aq or \*(Aqno\*(Aq,     # optional, default \*(Aqyes\*(Aq.
.Ve
.SS "draw_term"
.IX Subsection "draw_term"
.Vb 8
\&    Usage   \- $xml_out\->draw_term();
\&    Returns \- None
\&    Args    \-term=>$term,
\&            \-graph=>$graph,                    # optional
\&            \-show_associations=>\*(Aqyes\*(Aq or \*(Aqno\*(Aq, # optional, default \*(Aqyes\*(Aq.
\&            \-show_terms=>\*(Aqyes\*(Aq or \*(Aqno\*(Aq,        # optional, default \*(Aqyes\*(Aq.
\&            \-show_xrefs=>\*(Aqyes\*(Aq or \*(Aqno\*(Aq,        # optional, default \*(Aqyes\*(Aq.
\&            \-show_evidence=>\*(Aqyes\*(Aq or \*(Aqno\*(Aq,     # optional, default \*(Aqyes\*(Aq.
.Ve