Rose::DB::Object::Metadata::Column::Enum - Enumerated column metadata.


Rose-DB-Object documentation  | view source Contained in the Rose-DB-Object distribution.

Index


NAME

Top

Rose::DB::Object::Metadata::Column::Enum - Enumerated column metadata.

SYNOPSIS

Top

  use Rose::DB::Object::Metadata::Column::Enum;

  $col = Rose::DB::Object::Metadata::Column::Enum->new(...);
  $col->make_methods(...);
  ...

DESCRIPTION

Top

Objects of this class store and manipulate metadata for enum columns. Column metadata objects store information about columns (data type, size, etc.) and are responsible for creating object methods that manipulate column values. An enum column accepts a restricted set of string values which are usually stored as sequential integers in the database.

This class inherits from Rose::DB::Object::Metadata::Column::Scalar. Inherited methods that are not overridden will not be documented a second time here. See the Rose::DB::Object::Metadata::Column::Scalar documentation for more information.

METHOD MAP

Top

get_set

Rose::DB::Object::MakeMethods::Generic, enum, interface => 'get_set', ...

get

Rose::DB::Object::MakeMethods::Generic, enum, interface => 'get', ...

get_set

Rose::DB::Object::MakeMethods::Generic, enum, interface => 'set', ...

See the Rose::DB::Object::Metadata::Column documentation for an explanation of this method map.

OBJECT METHODS

Top

type

Returns "enum".

values [VALUES]

Get or set a reference to an array of valid column values. This attribute is required.

AUTHOR

Top

John C. Siracusa (siracusa@gmail.com)

LICENSE

Top

Copyright (c) 2010 by John C. Siracusa. All rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.


Rose-DB-Object documentation  | view source Contained in the Rose-DB-Object distribution.