Christopher J. Madsen > Palm-PDB-1.015 > Palm::Raw

Download:
Palm-PDB-1.015.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Module Version: 1.015   Source  

NAME ^

Palm::Raw - Handler for "raw" Palm databases

VERSION ^

This document describes version 1.015 of Palm::Raw, released August 9, 2014 as part of Palm-PDB version 1.015.

SYNOPSIS ^

    use Palm::Raw;

For standalone programs.

    use Palm::Raw();
    @ISA = qw( Palm::Raw );

For Palm::PDB helper modules.

DESCRIPTION ^

The Raw PDB handler is a helper class for the Palm::PDB package. It is intended as a generic handler for any database, or as a fallback default handler.

If you have a standalone program and want it to be able to parse any type of database, use

    use Palm::Raw;

If you are using Palm::Raw as a parent class for your own database handler, use

    use Palm::Raw();

If you omit the parentheses, Palm::Raw will register itself as the default handler for all databases, which is probably not what you want.

The Raw handler does no processing on the database whatsoever. The AppInfo block, sort block, records and resources are simply strings, raw data from the database.

By default, the Raw handler only handles record databases (.pdb files). If you want it to handle resource databases (.prc files) as well, you need to call

    &Palm::PDB::RegisterPRCHandlers("Palm::Raw", "");

in your script.

AppInfo block

    $pdb->{appinfo}

This is a scalar, the raw data of the AppInfo block.

Sort block

    $pdb->{sort}

This is a scalar, the raw data of the sort block.

Records

    @{$pdb->{records}Z<>};

Each element in the "records" array is a reference-to-hash. In addition to the standard keys ("attributes", "category", and "id"), this hash contains the key "data"; its value is a string with the raw record data.

Resources

    @{$pdb->{resources}Z<>};

Each element in the "resources" array is a reference-to-hash. In addition to the standard keys ("type" and "id"), it contains the key "data"; its value is a string with the raw resource data.

SEE ALSO ^

Palm::PDB

CONFIGURATION AND ENVIRONMENT ^

Palm::Raw requires no configuration files or environment variables.

INCOMPATIBILITIES ^

None reported.

BUGS AND LIMITATIONS ^

No bugs have been reported.

AUTHORS ^

Andrew Arensburger <arensb AT ooblick.com>

Currently maintained by Christopher J. Madsen <perl AT cjmweb.net>

Please report any bugs or feature requests to <bug-Palm-PDB AT rt.cpan.org> or through the web interface at http://rt.cpan.org/Public/Bug/Report.html?Queue=Palm-PDB.

You can follow or contribute to Palm-PDB's development at https://github.com/madsen/Palm-PDB.

COPYRIGHT AND LICENSE ^

This software is copyright (c) 2000 by Andrew Arensburger.

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

DISCLAIMER OF WARRANTY ^

BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION.

IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENSE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

syntax highlighting: