PerlBean::Attribute::Multi::Unique::Associative::MethodKey - contains unique associative MULTI bean attribute information
use strict; use PerlBean::Attribute::Multi::Unique::Associative::MethodKey; my $attr = PerlBean::Attribute::Multi::Unique::Associative::MethodKey->new( { attribute_name => 'ssns_i_know_from_people', short_description => 'all SSNs I know from people', } ); use IO::File; -d 'tmp' || mkdir('tmp'); my $fh = IO::File->new('> tmp/PerlBean_Attribute_Multi_Unique_Associative_MethodKey.pl.out'); $attr->write_methods($fh); $attr->write_doc_methods($fh);
Unique, associative MULTI bean attribute information
PerlBean::Attribute::Multi::Unique::Associative::MethodKey contains information on unique associative MULTI bean attribute that gets its key from an object method. It is a subclass of PerlBean::Attribute::Multi. The code generation and documentation methods from PerlBean::Attribute are implemented.
PerlBean::Attribute::Multi::Unique::Associative::MethodKey
PerlBean::Attribute::Multi
PerlBean::Attribute
Creates a new PerlBean::Attribute::Multi::Unique::Associative::MethodKey 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.
OPT_HASH_REF
Error::Simple
Options for OPT_HASH_REF may include:
id_method
Passed to set_id_method(). Defaults to 'get_id'.
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().
Options for OPT_HASH_REF inherited through package PerlBean::Attribute::Single may include:
PerlBean::Attribute::Single
allow_empty
Passed to set_allow_empty(). Defaults to 1.
allow_isa
Passed to set_allow_isa(). Must be an ARRAY reference.
ARRAY
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.
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.
'PerlBean::Attribute'
undef
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.
PerlBean
main
This method is inherited from package 'PerlBean::Attribute'. Calls get_package() and replaces :+ with C <_>.
get_package()
:+
This method is inherited from package 'PerlBean::Attribute'. Determins and returns the type of the attribute. The type is either BOOLEAN, SINGLE or MULTI.
BOOLEAN
SINGLE
MULTI
This method is inherited from package 'PerlBean::Attribute::Single'. Writes %ALLOW_ISA line for the attribute. FILEHANDLE is an IO::Handle object.
'PerlBean::Attribute::Single'
%ALLOW_ISA
FILEHANDLE
IO::Handle
This method is inherited from package 'PerlBean::Attribute::Single'. Writes %ALLOW_REF line for the attribute. FILEHANDLE is an IO::Handle object.
%ALLOW_REF
This method is inherited from package 'PerlBean::Attribute::Single'. Writes %ALLOW_RX line for the attribute. FILEHANDLE is an IO::Handle object.
%ALLOW_RX
This method is inherited from package 'PerlBean::Attribute::Single'. Writes %ALLOW_VALUE line for the attribute. FILEHANDLE is an IO::Handle object.
%ALLOW_VALUE
This method is inherited from package 'PerlBean::Attribute::Multi'. Writes %DEFAULT_VALUE line for the attribute. FILEHANDLE is an IO::Handle object.
'PerlBean::Attribute::Multi'
%DEFAULT_VALUE
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.
This method is an implementation from package 'PerlBean::Attribute::Multi'. Writes documentation for the access methods for the attribute in the case the attibute methods are inherited. FILEHANDLE is an IO::Handle object. Access methods are set..., add..., delete..., exists..., keys... and values....
This method is inherited from package 'PerlBean::Attribute::Multi'. Writes documentation for _initialize() for the attribute. FILEHANDLE is an IO::Handle object.
_initialize()
This method is an implementation from package 'PerlBean::Attribute::Multi'. Writes documentation for the access methods for the attribute. FILEHANDLE is an IO::Handle object. Access methods are set..., add..., delete..., exists..., keys... and values....
This method is an implementation from package 'PerlBean::Attribute::Multi'. Writes the access methods for the attribute. FILEHANDLE is an IO::Handle object. Access methods are set..., add..., delete..., exists..., keys... and values....
This method is inherited from package 'PerlBean::Attribute::Multi'. Writes _initialize() option parsing code for the attribute. FILEHANDLE is an IO::Handle object.
Set the method to obtain the ID from the item in the list. VALUE is the value. Default value at initialization is 'get_id'. On error an exception Error::Simple is thrown.
VALUE
'get_id'
Returns the method to obtain the ID from the item in the list.
set_attribute_name(), get_attribute_name()
set_default_value(), get_default_value()
set_exception_class(), get_exception_class()
set_mandatory(), is_mandatory()
set_method_base(), get_method_base()
set_perl_bean(), get_perl_bean()
set_short_description(), get_short_description()
set_allow_empty(), is_allow_empty()
set_allow_isa(), add_allow_isa(), delete_allow_isa(), exists_allow_isa(), values_allow_isa()
set_allow_ref(), add_allow_ref(), delete_allow_ref(), exists_allow_ref(), values_allow_ref()
set_allow_rx(), add_allow_rx(), delete_allow_rx(), exists_allow_rx(), values_allow_rx()
set_allow_value(), add_allow_value(), delete_allow_value(), exists_allow_value(), values_allow_value()
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::Ordered, PerlBean::Attribute::Single, PerlBean::Collection, PerlBean::Method, PerlBean::Method::Constructor, PerlBean::Style
None known (yet.)
First development: November 2002
Vincenzo Zocca
Copyright 2002, 2003 by Vincenzo Zocca
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
To install PerlBean, copy and paste the appropriate command in to your terminal.
cpanm
cpanm PerlBean
CPAN shell
perl -MCPAN -e shell install PerlBean
For more information on module installation, please visit the detailed CPAN module installation guide.