NAME

Meta::Db::Enum - Object to store enumeration data.

COPYRIGHT

Copyright (C) 2001, 2002 Mark Veltzer; All rights reserved.

LICENSE

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.

DETAILS

        MANIFEST: Enum.pm
        PROJECT: meta
        VERSION: 0.36

SYNOPSIS

        package foo;
        use Meta::Db::Enum qw();
        my($pieces)=Meta::Db::Enum->new();
        $pieces->push("Pawn");
        $pieces->push("Rook");
        $pieces->push("Knight");
        $pieces->push("Bishop");
        $pieces->push("King");
        $pieces->push("Queen");

DESCRIPTION

This is an object to store a the definition for an enumeration type.

FUNCTIONS

        BEGIN()
        new($)
        print($$)
        printd($$)
        printx($$)
        getsql_create($$$)
        getsql_drop($$$)
        get_string($)
        TEST($)

FUNCTION DOCUMENTATION

BEGIN()

Create get/set methods for the following attributes: "name", "description", "default". name - name for this enumerated type. description - description of this enumerated type. default - default value for this enumerated type.

new($)

A constructor for this class.

print($$)

This will print the current enum value to the prescribed file.

printd($$)

This method will print the object in DocBook XML format using the a writer object received.

printx($$)

This will print the current object in XML DocBook format using the a writer object received.

getsql_create($$$)

This method receives an Enum object and a statement collection and add to that statement collection a list of statements needed to create this object over an SQL connection.

getsql_drop($$$)

This method receives an Enum object and a statement collection and add to that statement collection a list of statements needed to drop this object over an SQL connection.

get_string($)

This will give you a string which catenates all the members with ",".

TEST($)

Test suite for this object.

SUPER CLASSES

Meta::Ds::Ochash(3), Meta::Ds::Connected(3)

BUGS

None.

AUTHOR

        Name: Mark Veltzer
        Email: mailto:veltzer@cpan.org
        WWW: http://www.veltzer.org
        CPAN id: VELTZER

HISTORY

        0.00 MV this time really make the databases work
        0.01 MV ok. This is for real
        0.02 MV ok - this time I realy mean it
        0.03 MV c++ and perl code quality checks
        0.04 MV make quality checks on perl code
        0.05 MV more perl checks
        0.06 MV check that all uses have qw
        0.07 MV fix todo items look in pod documentation
        0.08 MV more on tests/more checks to perl
        0.09 MV fix all tests change
        0.10 MV change new methods to have prototypes
        0.11 MV perl code quality
        0.12 MV more perl quality
        0.13 MV more perl quality
        0.14 MV perl documentation
        0.15 MV get graph stuff going
        0.16 MV more perl quality
        0.17 MV perl qulity code
        0.18 MV more perl code quality
        0.19 MV revision change
        0.20 MV languages.pl test online
        0.21 MV history change
        0.22 MV db stuff
        0.23 MV more data sets
        0.24 MV perl packaging
        0.25 MV PDMT
        0.26 MV some chess work
        0.27 MV md5 project
        0.28 MV database
        0.29 MV perl module versions in files
        0.30 MV movies and small fixes
        0.31 MV thumbnail user interface
        0.32 MV more thumbnail issues
        0.33 MV website construction
        0.34 MV web site automation
        0.35 MV SEE ALSO section fix
        0.36 MV md5 issues

SEE ALSO

Meta::Ds::Connected(3), Meta::Ds::Ochash(3), strict(3)

TODO

-descripbe the default in the SGML output