Peter Karman > SWISH-Prog-0.70 > SWISH::Prog::InvIndex::Meta

Download:
SWISH-Prog-0.70.tar.gz

Dependencies

Annotate this POD

Website

CPAN RT

Open  0
View/Report Bugs
Module Version: 0.70   Source   Latest Release: SWISH-Prog-0.75

NAME ^

SWISH::Prog::InvIndex::Meta - read/write InvIndex metadata

SYNOPSIS ^

 use Data::Dump qw( dump );
 use SWISH::Prog::InvIndex;
 my $index = SWISH::Prog::InvIndex->new(path => 'path/to/index');
 my $meta = $index->meta;
 for my $key (keys %{ $meta->data }) {
    dump $meta->$key;
 }

DESCRIPTION ^

A SWISH::Prog::InvIndex::Meta object represents the metadata for an InvIndex. It supports the Swish3 swish.xml header file format only at this time.

METHODS ^

swish_header_file

Class or object method. Returns the basename of the header file. Default is swish.xml.

init

Read and initialize the swish_header_file().

data

The contents of the header file as a Perl hashref. This is a read-only accessor.

file

The full path to the swish_header_file() file. This is a read-only accessor.

invindex

The SWISH::Prog::InvIndex object which the SWISH::Prog::InvIndex::Meta object represents.

get_properties

Returns hashref of PropertyNames with aliases resolved.

get_pure_properties

Returns arrayref of PropertyName values, excluding aliases.

get_property_map

Returns hashref of alias names to pure names.

AUTHOR ^

Peter Karman, <perl@peknet.com>

BUGS ^

Please report any bugs or feature requests to bug-swish-prog at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=SWISH-Prog. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT ^

You can find documentation for this module with the perldoc command.

    perldoc SWISH::Prog

You can also look for information at:

COPYRIGHT AND LICENSE ^

Copyright 2008-2009 by Peter Karman

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

SEE ALSO ^

http://swish-e.org/

syntax highlighting: