NAME

PerlBean::Attribute::Multi::Unique::Associative::MethodKey - contains unique associative MULTI bean attribute information

SYNOPSIS

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->writeMethods ($fh);
$attr->writeDocMethods ($fh);

ABSTRACT

Unique, associative MULTI bean attribute information

DESCRIPTION

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.

CONSTRUCTOR

new (OPT_HASH_REF)

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.

Options for OPT_HASH_REF may include:

id_method: Passed to "setIdMethod ()". Defaults to getId.

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

attribute_name: Passed to "setAttributeName ()". Mandatory option.
default_value: Passed to "setDefaultValue ()".
exception_class: Passed to "setExceptionClass ()". Defaults to Error::Simple.
mandatory: Passed to "setMandatory ()". Defaults to 0.
method_base: Passed to "setMethodBase ()".
perl_bean: Passed to "setPerlBean ()".
short_description: Passed to "setShortDescription ()".

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

allow_empty: Passed to "setAllowEmpty ()". Defaults to 1.
allow_isa: Passed to "setAllowIsa ()". Must be an ARRAY reference.
allow_ref: Passed to "setAllowRef ()". Must be an ARRAY reference.
allow_rx: Passed to "setAllowRx ()". Must be an ARRAY reference.
allow_value: Passed to "setAllowValue ()". Must be an ARRAY reference.

METHODS

getOverloadedAttribute (): 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
getPackage (): 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.
getPackageUS (): This method is inherited from package 'PerlBean::Attribute'. Calls getPackage () 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.
writeAllowIsa (FILEHANDLE): This method is inherited from package 'PerlBean::Attribute::Single'. Writes %ALLOW_ISA line for the attribute. FILEHANDLE is an IO::Handle object.
writeAllowRef (FILEHANDLE): This method is inherited from package 'PerlBean::Attribute::Single'. Writes %ALLOW_REF line for the attribute. FILEHANDLE is an IO::Handle object.
writeAllowRx (FILEHANDLE): This method is inherited from package 'PerlBean::Attribute::Single'. Writes %ALLOW_RX line for the attribute. FILEHANDLE is an IO::Handle object.
writeAllowValue (FILEHANDLE): This method is inherited from package 'PerlBean::Attribute::Single'. Writes %ALLOW_VALUE line for the attribute. FILEHANDLE is an IO::Handle object.
writeDefaultValue (FILEHANDLE): This method is inherited from package 'PerlBean::Attribute::Multi'. Writes %DEFAULT_VALUE line for the attribute. FILEHANDLE is an IO::Handle object.
writeDocClauses (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.
writeDocInheritMethods (FILEHANDLE): This method is overloaded 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. As package PerlBean::Attribute::Multi is intended to group its subclasses this method actually throws an exception. Access methods are set..., add..., delete..., exists..., keys... and values....
writeDocInit (FILEHANDLE): This method is inherited from package 'PerlBean::Attribute::Multi'. Writes documentation for _initialize () for the attribute. FILEHANDLE is an IO::Handle object.
writeDocMethods (FILEHANDLE): This method is overloaded from package 'PerlBean::Attribute::Multi'. Writes documentation for the access methods for the attribute. FILEHANDLE is an IO::Handle object. As package PerlBean::Attribute::Multi is intended to group its subclasses this method actually throws an exception. Access methods are set..., add..., delete..., exists..., keys... and values....
writeMethods (FILEHANDLE): This method is overloaded from package 'PerlBean::Attribute::Multi'. Writes the access methods for the attribute. FILEHANDLE is an IO::Handle object. As package PerlBean::Attribute::Multi is intended to group its subclasses this method actually throws an exception. Access methods are set..., add..., delete..., exists..., keys... and values....
writeOptInit (FILEHANDLE): This method is inherited from package 'PerlBean::Attribute::Multi'. Writes _initialize () option parsing code for the attribute. FILEHANDLE is an IO::Handle object.
setIdMethod (VALUE): Set the method to obtain the ID from the item in the list. VALUE is the value. Default value at initialization is getId. On error an exception Error::Simple is thrown.
getIdMethod (): Returns the method to obtain the ID from the item in the list.

INHERITED METHODS FROM PerlBean::Attribute

To access attribute named attribute_name:: setAttributeName (), getAttributeName ()
To access attribute named default_value:: setDefaultValue (), getDefaultValue ()
To access attribute named exception_class:: setExceptionClass (), getExceptionClass ()
To access attribute named mandatory:: setMandatory (), isMandatory ()
To access attribute named method_base:: setMethodBase (), getMethodBase ()
To access attribute named perl_bean:: setPerlBean (), getPerlBean ()
To access attribute named short_description:: setShortDescription (), getShortDescription ()

INHERITED METHODS FROM PerlBean::Attribute::Single

To access attribute named allow_empty:: setAllowEmpty (), isAllowEmpty ()
To access attribute named allow_isa:: setAllowIsa (), addAllowIsa (), deleteAllowIsa (), existsAllowIsa (), valuesAllowIsa ()
To access attribute named allow_ref:: setAllowRef (), addAllowRef (), deleteAllowRef (), existsAllowRef (), valuesAllowRef ()
To access attribute named allow_rx:: setAllowRx (), addAllowRx (), deleteAllowRx (), existsAllowRx (), valuesAllowRx ()
To access attribute named allow_value:: setAllowValue (), addAllowValue (), deleteAllowValue (), existsAllowValue (), valuesAllowValue ()

BUGS

None known (yet.)

HISTORY

First development: November 2002

AUTHOR

Vincenzo Zocca

COPYRIGHT

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

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.

	Global
`s`	Focus search bar
`?`	Bring up this help dialog

	GitHub
`g` `p`	Go to pull requests
`g` `i`	Go to GitHub issues (only if GitHub is preferred repository)

	POD
`g` `a`	Go to author
`g` `c`	Go to changes
`g` `i`	Go to issues
`g` `d`	Go to dist
`g` `r`	Go to repository/SCM
`g` `s`	Go to source
`g` `b`	Go to file browse

	Search terms
module: (e.g. module:Plugin)
distribution: (e.g. distribution:Dancer auth)
author: (e.g. author:SONGMU Redis)
version: (e.g. version:1.00)