.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" 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::Model::Xref 3pm"
.TH GO::Model::Xref 3pm "2021-01-09" "perl v5.32.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::Model::Xref \- cross reference to an external database
.Ve
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 5
\&  my $xrefs = $term\->dbxref_list();
\&  foreach my $xref (@$xrefs) P
\&    printf "Term %s has an xref %s:%s\en", 
\&            $term\->name, $xref\->xref_key, $xref\->dbname;
\&  }
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
represents a cross reference to an external database. an Xref is made
up of a key (ie the accession number, or whatever the value of the
unique field being keyed off of is) and a database name. this should
theorerically be enough to uniquely identify any databased entity.
.SH "NOTES"
.IX Header "NOTES"
Like all the GO::Model::* classes, this uses accessor methods to get
or set the attributes. by using the accessor method without any
arguments gets the value of the attribute. if you pass in an argument,
then the attribuet will be set according to that argument.
.PP
for instance
.PP
.Vb 2
\&  # this sets the value of the attribute
\&  $my_object\->attribute_name("my value");
\&
\&  # this gets the value of the attribute
\&  $my_value = $my_object\->attribute_name();
.Ve
.SS "xref_key"
.IX Subsection "xref_key"
.Vb 5
\&  Alias   \- acc
\&  Alias   \- accession
\&  Usage   \-
\&  Returns \-
\&  Args    \-
\&
\& accessor: gets/sets the key/id of the cross reference
.Ve
.SS "xref_keytype"
.IX Subsection "xref_keytype"
.Vb 3
\&  Usage   \-
\&  Returns \-
\&  Args    \-
\&
\& accessor: gets/sets the key/id type of the cross reference
.Ve
.SS "as_str"
.IX Subsection "as_str"
.Vb 3
\&  Usage   \-
\&  Returns \-
\&  Args    \-
.Ve
.SS "xref_dbname"
.IX Subsection "xref_dbname"
.Vb 4
\&  Alias   \- dbname
\&  Usage   \-
\&  Returns \-
\&  Args    \-
\&
\& accessor: gets/sets the database name of the cross reference
.Ve
.PP
must be a valid database name
.SS "xref_desc"
.IX Subsection "xref_desc"
.Vb 4
\&  Alias   \- name
\&  Usage   \-
\&  Returns \-
\&  Args    \-
\&
\& accessor: gets/sets the description of the accession no
.Ve
.PP
useful for interpro
.SS "to_xml"
.IX Subsection "to_xml"
.Vb 3
\&  Usage   \- print $xref\->to_xml()
\&  Returns \- string
\&  Args    \- indent [integer]
.Ve
.PP
\&\s-1XML\s0 representation; you probably shouldn't call this directly, this
will be called by entities that own xrefs