.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
.\"
.\" 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 "Metabase::Fact::Hash 3pm"
.TH Metabase::Fact::Hash 3pm "2022-10-14" "perl v5.34.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"
Metabase::Fact::Hash \- fact subtype for simple hashes
.SH "VERSION"
.IX Header "VERSION"
version 0.025
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 4
\&  # defining the fact class
\&  package MyComment;
\&  use Metabase::Fact::Hash;
\&  our @ISA = qw/Metabase::Fact::Hash/;
\&
\&  sub required_keys { qw/poster/ }
\&
\&  sub optional_keys { qw/comment/ }
\&
\&  sub content_metadata {
\&    my $self = shift;
\&    return {
\&      poster => [ \*(Aq//str\*(Aq => $self\->content\->{poster} ],
\&    };
\&  }
\&
\&  sub validate_content {
\&    my $self = shift;
\&    $self\->SUPER::validate_content; # required and optional keys
\&
\&    # other analysis of values
\&  }
.Ve
.PP
\&...and then...
.PP
.Vb 8
\&  # using the fact class
\&  my $fact = MyFact\->new(
\&    resource => \*(AqRJBS/Metabase\-Fact\-0.001.tar.gz\*(Aq,
\&    content => {
\&      poster  => \*(Aqlarry\*(Aq,
\&      comment => \*(AqMetabase rocks!\*(Aq,
\&    }
\&  );
\&
\&  $client\->send_fact($fact);
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Many (if not most) facts to be stored in a Metabase are just hashes of simple
data.  Metabase::Fact::Hash is a subclass of Metabase::Fact
with most of the required Fact methods already implemented.  If you write your
class as a subclass of Metabase::Fact::Hash, you can store simple hashes in it.
.PP
You should implement \f(CW\*(C`required_keys\*(C'\fR and/or \f(CW\*(C`optional_keys\*(C'\fR as shown in the
\&\s-1SYNOPSIS.\s0  The superclass \f(CW\*(C`valiate_content\*(C'\fR will ensure that required keys
exist and that only required an optional keys exist.  You may wish to subclass
\&\f(CW\*(C`validate_content\*(C'\fR to validate the specific content of the hash given to the
constructor.
.PP
You may wish to implement a \f(CW\*(C`content_metadata\*(C'\fR method to generate metadata
about the hash contents.
.SH "ATTRIBUTES"
.IX Header "ATTRIBUTES"
.SS "Arguments provided to new"
.IX Subsection "Arguments provided to new"
\fIresource\fR
.IX Subsection "resource"
.PP
\&\fBrequired\fR
.PP
The canonical resource (\s-1URI\s0) the Fact relates to.  For \s-1CPAN\s0 distributions, this
would be a \f(CW\*(C`cpan:///distfile/\*(C'\fR \s-1URL.\s0  (See URI::cpan.)
.PP
\fIcontent\fR
.IX Subsection "content"
.PP
\&\fBrequired\fR
.PP
A reference to the actual information associated with the fact.
The exact form of the content is up to each Fact class to determine.
.SH "METHODS"
.IX Header "METHODS"
For information on the methods provided by this class, see
Metabase::Fact.
.SH "BUGS"
.IX Header "BUGS"
Please report any bugs or feature using the \s-1CPAN\s0 Request Tracker.
Bugs can be submitted through the web interface at
<http://rt.cpan.org/Dist/Display.html?Queue=Metabase\-Fact>
.PP
When submitting a bug or request, please include a test file or a patch to an
existing test-file that illustrates the bug or desired feature.
.SH "AUTHORS"
.IX Header "AUTHORS"
.IP "\(bu" 4
David Golden <dagolden@cpan.org>
.IP "\(bu" 4
Ricardo Signes <rjbs@cpan.org>
.IP "\(bu" 4
H.Merijn Brand <hmbrand@cpan.org>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is Copyright (c) 2016 by David Golden.
.PP
This is free software, licensed under:
.PP
.Vb 1
\&  The Apache License, Version 2.0, January 2004
.Ve