/ 
Dezi-App-0.016
River stage one • 2 direct dependents • 8 total dependents
/ Dezi::InvIndex::Header

NAME

Dezi::InvIndex::Header - read/write InvIndex metadata

SYNOPSIS

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

DESCRIPTION

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

CONSTANTS

All the SWISH::3 constants are imported into this namespace, including:

  • SWISH_DOC_PROP_MAP

METHODS

header_file

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

swish_header_file

Alias for header_file(). For backwards compatibility with SWISH::Prog.

BUILD

Read and initialize the 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 header_file() file. This is a read-only accessor.

invindex

The Dezi::InvIndex object which the Dezi::InvIndex::Header 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, <karpet@dezi.org>

BUGS

Please report any bugs or feature requests to bug-dezi-app at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Dezi-App. 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 Dezi::InvIndex::Header

You can also look for information at:

COPYRIGHT AND LICENSE

Copyright 2018 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://dezi.org/, http://swish-e.org/, http://lucy.apache.org/