NAME

PerlBean::Attribute::Single - contains SINGLE bean attribute information

SYNOPSIS

 use strict;
 use PerlBean::Attribute::Single;
 my $attr = PerlBean::Attribute::Single->new( {
     attribute_name => 'name',
     short_description => 'my name',
 } );
 
 use IO::File;
 -d 'tmp' || mkdir('tmp');
 my $fh = IO::File->new('> tmp/PerlBean_Attribute_Single.pl.out');
 $attr->write_methods($fh);
 $attr->write_doc_methods($fh);

ABSTRACT

SINGLE bean attribute information

DESCRIPTION

PerlBean::Attribute::Single contains SINGLE bean attribute information. It is a subclass of PerlBean::Attribute. The code and documentation methods are implemented.

CONSTRUCTOR

new(OPT_HASH_REF)

Creates a new PerlBean::Attribute::Single object. OPT_HASH_REF is a hash reference used to pass initialization options. OPT_HASH_REF is mandatory. On error an exception Error::Simple is thrown.

Options for OPT_HASH_REF may include:

allow_empty

Passed to set_allow_empty(). Defaults to 1.

allow_isa

Passed to set_allow_isa(). Must be an ARRAY reference.

allow_ref

Passed to set_allow_ref(). Must be an ARRAY reference.

allow_rx

Passed to set_allow_rx(). Must be an ARRAY reference.

allow_value

Passed to set_allow_value(). Must be an ARRAY reference.

Options for OPT_HASH_REF inherited through package PerlBean::Attribute may include:

attribute_name

Passed to set_attribute_name(). Mandatory option.

default_value

Passed to set_default_value().

exception_class

Passed to set_exception_class(). Defaults to 'Error::Simple'.

mandatory

Passed to set_mandatory(). Defaults to 0.

method_base

Passed to set_method_base().

perl_bean

Passed to set_perl_bean().

short_description

Passed to set_short_description().

METHODS

get_overloaded_attribute()

This method is inherited from package 'PerlBean::Attribute'. Searches superclass packages for an identically named PerlBean::Attribute. If found it is returned otherwise undef is returned.

get_package()

This method is inherited from package 'PerlBean::Attribute'. Returns the package name. The package name is obtained from the PerlBean to which the PerlBean::Attribute belongs. Or, if the PerlBean::Attribute does not belong to a PerlBean, main is returned.

get_package_us()

This method is inherited from package 'PerlBean::Attribute'. Calls get_package() and replaces :+ with C <_>.

type()

This method is inherited from package 'PerlBean::Attribute'. Determins and returns the type of the attribute. The type is either BOOLEAN, SINGLE or MULTI.

write_allow_isa(FILEHANDLE)

Writes %ALLOW_ISA line for the attribute. FILEHANDLE is an IO::Handle object.

write_allow_ref(FILEHANDLE)

Writes %ALLOW_REF line for the attribute. FILEHANDLE is an IO::Handle object.

write_allow_rx(FILEHANDLE)

Writes %ALLOW_RX line for the attribute. FILEHANDLE is an IO::Handle object.

write_allow_value(FILEHANDLE)

Writes %ALLOW_VALUE line for the attribute. FILEHANDLE is an IO::Handle object.

write_default_value(FILEHANDLE)

This method is an implementation from package 'PerlBean::Attribute'. Writes %DEFAULT_VALUE line for the attribute. FILEHANDLE is an IO::Handle object.

write_doc_clauses(FILEHANDLE)

This method is inherited from package 'PerlBean::Attribute'. Writes documentation for the clauses to which the contents the contents of the attribute must adhere. FILEHANDLE is an IO::Handle object.

write_doc_inherit_methods(FILEHANDLE)

This method is an implementation from package 'PerlBean::Attribute'. Writes documentation for the access methods for the attribute in the case the attibute methods are inherited. FILEHANDLE is an IO::Handle object.

write_doc_init(FILEHANDLE)

This method is an implementation from package 'PerlBean::Attribute'. Writes documentation for _initialize() for the attribute. FILEHANDLE is an IO::Handle object.

write_doc_methods(FILEHANDLE)

This method is an implementation from package 'PerlBean::Attribute'. Writes documentation for the access methods for the attribute. FILEHANDLE is an IO::Handle object.

write_methods(FILEHANDLE)

This method is an implementation from package 'PerlBean::Attribute'. Writes the access methods for the attribute. FILEHANDLE is an IO::Handle object.

write_opt_init(FILEHANDLE)

This method is an implementation from package 'PerlBean::Attribute'. Writes _initialize() option parsing code for the attribute. FILEHANDLE is an IO::Handle object.

set_allow_empty(VALUE)

State that the attribute is allowed to be empty. VALUE is the value. Default value at initialization is 1. On error an exception Error::Simple is thrown.

is_allow_empty()

Returns whether the attribute is allowed to be empty or not.

set_allow_isa(ARRAY)

Set the list of allowed classes absolutely. ARRAY is the list value. Each element in the list is allowed to occur only once. Multiple occurences of the same element yield in the last occuring element to be inserted and the rest to be ignored. On error an exception Error::Simple is thrown.

add_allow_isa(ARRAY)

Add additional values on the list of allowed classes. ARRAY is the list value. The addition may not yield to multiple identical elements in the list. Hence, multiple occurences of the same element cause the last occurence to be inserted. On error an exception Error::Simple is thrown.

delete_allow_isa(ARRAY)

Delete elements from the list of allowed classes. Returns the number of deleted elements. On error an exception Error::Simple is thrown.

exists_allow_isa(ARRAY)

Returns the count of items in ARRAY that are in the list of allowed classes.

values_allow_isa()

Returns an ARRAY containing all values of the list of allowed classes.

set_allow_ref(ARRAY)

Set the list of allowed references absolutely. ARRAY is the list value. Each element in the list is allowed to occur only once. Multiple occurences of the same element yield in the last occuring element to be inserted and the rest to be ignored. On error an exception Error::Simple is thrown.

add_allow_ref(ARRAY)

Add additional values on the list of allowed references. ARRAY is the list value. The addition may not yield to multiple identical elements in the list. Hence, multiple occurences of the same element cause the last occurence to be inserted. On error an exception Error::Simple is thrown.

delete_allow_ref(ARRAY)

Delete elements from the list of allowed references. Returns the number of deleted elements. On error an exception Error::Simple is thrown.

exists_allow_ref(ARRAY)

Returns the count of items in ARRAY that are in the list of allowed references.

values_allow_ref()

Returns an ARRAY containing all values of the list of allowed references.

set_allow_rx(ARRAY)

Set the list of allow regular expressions absolutely. ARRAY is the list value. Each element in the list is allowed to occur only once. Multiple occurences of the same element yield in the last occuring element to be inserted and the rest to be ignored. On error an exception Error::Simple is thrown.

add_allow_rx(ARRAY)

Add additional values on the list of allow regular expressions. ARRAY is the list value. The addition may not yield to multiple identical elements in the list. Hence, multiple occurences of the same element cause the last occurence to be inserted. On error an exception Error::Simple is thrown.

delete_allow_rx(ARRAY)

Delete elements from the list of allow regular expressions. Returns the number of deleted elements. On error an exception Error::Simple is thrown.

exists_allow_rx(ARRAY)

Returns the count of items in ARRAY that are in the list of allow regular expressions.

values_allow_rx()

Returns an ARRAY containing all values of the list of allow regular expressions.

set_allow_value(ARRAY)

Set allowed values absolutely. ARRAY is the list value. Each element in the list is allowed to occur only once. Multiple occurences of the same element yield in the last occuring element to be inserted and the rest to be ignored. On error an exception Error::Simple is thrown.

add_allow_value(ARRAY)

Add additional values on allowed values. ARRAY is the list value. The addition may not yield to multiple identical elements in the list. Hence, multiple occurences of the same element cause the last occurence to be inserted. On error an exception Error::Simple is thrown.

delete_allow_value(ARRAY)

Delete elements from allowed values. Returns the number of deleted elements. On error an exception Error::Simple is thrown.

exists_allow_value(ARRAY)

Returns the count of items in ARRAY that are in allowed values.

values_allow_value()

Returns an ARRAY containing all values of allowed values.

INHERITED METHODS FROM PerlBean::Attribute

To access attribute named attribute_name:

set_attribute_name(), get_attribute_name()

To access attribute named default_value:

set_default_value(), get_default_value()

To access attribute named exception_class:

set_exception_class(), get_exception_class()

To access attribute named mandatory:

set_mandatory(), is_mandatory()

To access attribute named method_base:

set_method_base(), get_method_base()

To access attribute named perl_bean:

set_perl_bean(), get_perl_bean()

To access attribute named short_description:

set_short_description(), get_short_description()

SEE ALSO

PerlBean, PerlBean::Attribute, PerlBean::Attribute::Boolean, PerlBean::Attribute::Factory, PerlBean::Attribute::Multi, PerlBean::Attribute::Multi::Ordered, PerlBean::Attribute::Multi::Unique, PerlBean::Attribute::Multi::Unique::Associative, PerlBean::Attribute::Multi::Unique::Associative::MethodKey, PerlBean::Attribute::Multi::Unique::Ordered, PerlBean::Collection, PerlBean::Method, PerlBean::Method::Constructor, PerlBean::Style

BUGS

None known (yet.)

HISTORY

First development: November 2002

AUTHOR

Vincenzo Zocca

COPYRIGHT

Copyright 2002, 2003 by Vincenzo Zocca

LICENSE

This file is part of the PerlBean module hierarchy for Perl by Vincenzo Zocca.

The PerlBean module hierarchy 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.

The PerlBean module hierarchy 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 the PerlBean module hierarchy; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA