Metabase::Fact::Hash - fact subtype for simple hashes
# defining the fact class package MyComment; use base 'Metabase::Fact::Hash'; sub required_keys { qw/poster/ } sub optional_keys { qw/comment/ } sub content_metadata { my $self = shift; return { poster => [ '//str' => $self->content->{poster} ], }; } sub validate_content { my $self = shift; $self->SUPER::validate_content; # required and optional keys # other analysis of values }
...and then...
# using the fact class my $fact = MyFact->new( resource => 'RJBS/Metabase-Fact-0.001.tar.gz', content => { poster => 'larry', comment => 'Metabase rocks!', } ); $client->send_fact($fact);
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.
You may wish to implement a content_metadata method to generate metadata about the hash contents.
content_metadata
You should also implement a validate_content method to validate the structure of the hash you're given.
validate_content
required
The canonical resource (URI) the Fact relates to. For CPAN distributions, this would be a cpan:///distfile/ URL. (See URI::cpan.)
cpan:///distfile/
A reference to the actual information associated with the fact. The exact form of the content is up to each Fact class to determine.
For information on the methods provided by this class, see Metabase::Fact.
Please report any bugs or feature using the CPAN Request Tracker. Bugs can be submitted through the web interface at http://rt.cpan.org/Dist/Display.html?Queue=Metabase-Fact
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.
David A. Golden (DAGOLDEN)
Ricardo J. B. Signes (RJBS)
Portions copyright (c) 2008-2009 by David A. Golden Portions copyright (c) 2008-2009 by Ricardo J. B. Signes
Licensed under the same terms as Perl itself (the "License"). You may not use this file except in compliance with the License. A copy of the License was distributed with this file or you may obtain a copy of the License from http://dev.perl.org/licenses/
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
To install Metabase::Fact, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Metabase::Fact
CPAN shell
perl -MCPAN -e shell install Metabase::Fact
For more information on module installation, please visit the detailed CPAN module installation guide.