MAGE::...mation(3pm)

📦 version 20030502.3, in debian bookworm, debian trixie, ubuntu jammy, ubuntu noble, ubuntu resolute, ubuntu stonking

💖 NAME 💖

Bestie, get comfy, because this whole page is about Bio::MAGE::BioAssayData::Transformation — a Class for the MAGE-OM API ✨. It lives in the MAGE::...mation(3pm) page (User Contributed Perl Documentation), and yeah, the name got cut off up top, that's just how it is, no cap 🎀.

🌸 SYNOPSIS 🌸

Okay so here's the vibe — you can spin up an empty one, or you can bring your whole friend group of existing data:

use Bio::MAGE::BioAssayData::Transformation

# creating an empty instance
my $transformation = Bio::MAGE::BioAssayData::Transformation->new();

# creating an instance with existing data
my $transformation = Bio::MAGE::BioAssayData::Transformation->new(
      name=>$name_val,
      identifier=>$identifier_val,
      quantitationTypeMapping=>$quantitationtypemapping_ref,
      designElementMapping=>$designelementmapping_ref,
      auditTrail=>\@audit_list,
      propertySets=>\@namevaluetype_list,
      protocolApplications=>\@protocolapplication_list,
      descriptions=>\@description_list,
      security=>$security_ref,
      bioAssayDataSources=>\@bioassaydata_list,
      derivedBioAssayDataTarget=>$derivedbioassaydata_ref,
      bioAssayMapping=>$bioassaymapping_ref,
);

# 'name' attribute
my $name_val = $transformation->name(); # getter
$transformation->name($value); # setter

# 'identifier' attribute
my $identifier_val = $transformation->identifier(); # getter
$transformation->identifier($value); # setter

# 'quantitationTypeMapping' association
my $quantitationtypemapping_ref = $transformation->quantitationTypeMapping(); # getter
$transformation->quantitationTypeMapping($quantitationtypemapping_ref); # setter

# 'designElementMapping' association
my $designelementmapping_ref = $transformation->designElementMapping(); # getter
$transformation->designElementMapping($designelementmapping_ref); # setter

# 'auditTrail' association
my $audit_array_ref = $transformation->auditTrail(); # getter
$transformation->auditTrail(\@audit_list); # setter

# 'propertySets' association
my $namevaluetype_array_ref = $transformation->propertySets(); # getter
$transformation->propertySets(\@namevaluetype_list); # setter

# 'protocolApplications' association
my $protocolapplication_array_ref = $transformation->protocolApplications(); # getter
$transformation->protocolApplications(\@protocolapplication_list); # setter

# 'descriptions' association
my $description_array_ref = $transformation->descriptions(); # getter
$transformation->descriptions(\@description_list); # setter

# 'security' association
my $security_ref = $transformation->security(); # getter
$transformation->security($security_ref); # setter

# 'bioAssayDataSources' association
my $bioassaydata_array_ref = $transformation->bioAssayDataSources(); # getter
$transformation->bioAssayDataSources(\@bioassaydata_list); # setter

# 'derivedBioAssayDataTarget' association
my $derivedbioassaydata_ref = $transformation->derivedBioAssayDataTarget(); # getter
$transformation->derivedBioAssayDataTarget($derivedbioassaydata_ref); # setter

# 'bioAssayMapping' association
my $bioassaymapping_ref = $transformation->bioAssayMapping(); # getter
$transformation->bioAssayMapping($bioassaymapping_ref); # setter

🦋 DESCRIPTION 🦋

Straight from the MAGE-OM documentation for the "Transformation" class, and I'm quoting the vibe exactly:

The process by which derivedBioAssays are created from measuredBioAssays and/or derivedBioAssays. It uses mappings to indicate the input and output dimensions.

So basically it's the glow-up machine where derivedBioAssays are born from measuredBioAssays and/or other derivedBioAssays, and the mappings are what tell you the input and output dimensions. Iconic behavior honestly 💅.

👑 INHERITANCE 👑

Bio::MAGE::BioAssayData::Transformation has the following superclasses — aka the family it inherited its whole personality from:

  • Bio::MAGE::BioEvent::BioEvent

✨ CLASS METHODS ✨

These are the methods you can call without even having an instance yet — just go straight through the class using the

Bio::MAGE::BioAssayData::Transformation->methodname()

syntax. No object required, she's that independent 💅.

new()

new(%args)

The object constructor "new()" accepts the following optional named-value style arguments (optional, bestie — you don't have to pass all of these, but the option is there):

  • name — Sets the value of the "name" attribute (this attribute was inherited from class "Bio::MAGE::Identifiable").
  • identifier — Sets the value of the "identifier" attribute (this attribute was inherited from class "Bio::MAGE::Identifiable").
  • quantitationTypeMapping — Sets the value of the "quantitationTypeMapping" association.

The value must be of type: instance of "Bio::MAGE::BioAssayData::QuantitationTypeMapping".

  • designElementMapping — Sets the value of the "designElementMapping" association.

The value must be of type: instance of "Bio::MAGE::BioAssayData::DesignElementMapping".

  • auditTrail — Sets the value of the "auditTrail" association (this association was inherited from class "Bio::MAGE::Describable").

The value must be of type: array of "Bio::MAGE::AuditAndSecurity::Audit".

  • propertySets — Sets the value of the "propertySets" association (this association was inherited from class "Bio::MAGE::Extendable").

The value must be of type: array of "Bio::MAGE::NameValueType".

  • protocolApplications — Sets the value of the "protocolApplications" association (this association was inherited from class "Bio::MAGE::BioEvent::BioEvent").

The value must be of type: array of "Bio::MAGE::Protocol::ProtocolApplication".

  • descriptions — Sets the value of the "descriptions" association (this association was inherited from class "Bio::MAGE::Describable").

The value must be of type: array of "Bio::MAGE::Description::Description".

  • security — Sets the value of the "security" association (this association was inherited from class "Bio::MAGE::Describable").

The value must be of type: instance of "Bio::MAGE::AuditAndSecurity::Security".

  • derivedBioAssayDataTarget — Sets the value of the "derivedBioAssayDataTarget" association.

The value must be of type: instance of "Bio::MAGE::BioAssayData::DerivedBioAssayData".

  • bioAssayDataSources — Sets the value of the "bioAssayDataSources" association.

The value must be of type: array of "Bio::MAGE::BioAssayData::BioAssayData".

  • bioAssayMapping — Sets the value of the "bioAssayMapping" association.

The value must be of type: instance of "Bio::MAGE::BioAssayData::BioAssayMapping".

$obj = class->new(%parameters)

The "new()" method is the class constructor. The moment.

Parameters: if given a list of name/value parameters the corresponding slots, attributes, or associations will have their initial values set by the constructor.

Return value: It returns a reference to an object of the class.

Side effects: It invokes the "initialize()" method if it is defined by the class.

@names = class->get_slot_names()

The "get_slot_names()" method is used to retrieve the name of all slots defined in a given class.

NOTE: the list of names does not include attribute or association names. 👀

Return value: A list of the names of all slots defined for this class.

Side effects: none

@name_list = get_attribute_names()

returns the list of attribute data members for this class.

@name_list = get_association_names()

returns the list of association data members for this class.

@class_list = get_superclasses()

returns the list of superclasses for this class.

@class_list = get_subclasses()

returns the list of subclasses for this class.

$name = class_name()

Returns the full class name for this class.

$package_name = package_name()

Returns the base package name (i.e. no 'namespace::') of the package that contains this class.

%assns = associations()

returns the association meta-information in a hash where the keys are the association names and the values are "Association" objects that provide the meta-information for the association.

💜 INSTANCE METHODS 💜

$obj_copy = $obj->new()

When invoked with an existing object reference and not a class name, the "new()" method acts as a copy constructor — with the new object's initial values set to be those of the existing object. It's giving clone energy 🧚.

Parameters: No input parameters are used in the copy constructor, the initial values are taken directly from the object to be copied.

Return value: It returns a reference to an object of the class.

Side effects: It invokes the "initialize()" method if it is defined by the class.

$obj->set_slots(%parameters)

$obj->set_slots(\@name_list, \@value_list)

The "set_slots()" method is used to set a number of slots at the same time. It has two different invocation methods. The first takes a named parameter list, and the second takes two array references.

Return value: none

Side effects: will call "croak()" if a slot_name is used that the class does not define.

@obj_list = $obj->get_slots(@name_list)

The "get_slots()" method is used to get the values of a number of slots at the same time.

Return value: a list of instance objects

Side effects: none

$val = $obj->set_slot($name,$val)

The "set_slot()" method sets the slot $name to the value $val

Return value: the new value of the slot, i.e. $val

Side effects: none

$val = $obj->get_slot($name)

The "get_slot()" method is used to get the values of a number of slots at the same time.

Return value: a single slot value, or undef if the slot has not been initialized.

Side effects: none

🌈 ATTRIBUTES 🌈

Attributes are simple data types that belong to a single instance of a class. In the Perl implementation of the MAGE-OM classes, the interface to attributes is implemented using separate setter and getter methods for each attribute.

"Bio::MAGE::BioAssayData::Transformation" has the following attribute accessor methods:

name

Methods for the "name" attribute.

From the MAGE-OM documentation:

The potentially ambiguous common identifier.

$val = $transformation->setName($val)

The restricted setter method for the "name" attribute.

Input parameters: the value to which the "name" attribute will be set

Return value: the current value of the "name" attribute

Side effects: none

Exceptions: will call "croak()" if no input parameters are specified, or if too many input parameters are specified

$val = $transformation->getName()

The restricted getter method for the "name" attribute.

Input parameters: none

Return value: the current value of the "name" attribute

Side effects: none

Exceptions: she will hit you with a croak() if you dare pass any input parameters. Zero chill, but like, correct. 💅

🎀 identifier 🎀

Methods for the identifier attribute, bestie. Let's go.

From the MAGE-OM documentation, and I quote:

An identifier is an unambiguous string that is unique within the scope (i.e. a document, a set of related documents, or a repository) of its use.

Translation? It's the string that says this one, specifically this one — but only within its own little scope, okay? Don't come for it cross-repository. 🙈

$val = $transformation->setIdentifier($val)

The restricted setter method for the identifier attribute.

  • Input parameters: the value to which the identifier attribute will be set
  • Return value: the current value of the identifier attribute
  • Side effects: none
  • Exceptions: will call croak() if no input parameters are specified, or if too many input parameters are specified

$val = $transformation->getIdentifier()

The restricted getter method for the identifier attribute.

  • Input parameters: none
  • Return value: the current value of the identifier attribute
  • Side effects: none
  • Exceptions: will call croak() if any input parameters are specified

🔗 ASSOCIATIONS 🔗

Okay so this is the part where it gets ✨connected✨. Associations are references to other classes. And in MAGE-OM every association has a cardinality, which is basically the vibe check on how many of the other class are allowed to show up:

  1. There must be exactly one item in the association, i.e. this is a mandatory data field.
  2. 0..1 There may be one item in the association, i.e. this is an optional data field.
  3. 1..N There must be one or more items in the association, i.e. this is a mandatory data field, with list cardinality.
  4. 0..N There may be one or more items in the association, i.e. this is an optional data field, with list cardinality.

Bio::MAGE::BioAssayData::Transformation has the following association accessor methods — buckle up, there's a few 🫶

💜 quantitationTypeMapping 💜

Methods for the quantitationTypeMapping association.

From the MAGE-OM documentation:

The collection of mappings for the QuantitationTypes.

$val = $transformation->setQuantitationTypeMapping($val)

The restricted setter method for the quantitationTypeMapping association.

  • Input parameters: the value to which the quantitationTypeMapping association will be set : one of the accepted enumerated values.
  • Return value: the current value of the quantitationTypeMapping association : one of the accepted enumerated values.
  • Side effects: none
  • Exceptions: will call croak() if no input parameters are specified, or if too many input parameters are specified, or if $val is not an instance of class Bio::MAGE::BioAssayData::QuantitationTypeMapping

$val = $transformation->getQuantitationTypeMapping()

The restricted getter method for the quantitationTypeMapping association.

  • Input parameters: none
  • Return value: the current value of the quantitationTypeMapping association : an instance of type Bio::MAGE::BioAssayData::QuantitationTypeMapping.
  • Side effects: none
  • Exceptions: will call croak() if any input parameters are specified

🦋 designElementMapping 🦋

Methods for the designElementMapping association.

From the MAGE-OM documentation:

The collection of mappings for the DesignElements.

$val = $transformation->setDesignElementMapping($val)

The restricted setter method for the designElementMapping association.

  • Input parameters: the value to which the designElementMapping association will be set : one of the accepted enumerated values.
  • Return value: the current value of the designElementMapping association : one of the accepted enumerated values.
  • Side effects: none
  • Exceptions: will call croak() if no input parameters are specified, or if too many input parameters are specified, or if $val is not an instance of class Bio::MAGE::BioAssayData::DesignElementMapping

$val = $transformation->getDesignElementMapping()

The restricted getter method for the designElementMapping association.

  • Input parameters: none
  • Return value: the current value of the designElementMapping association : an instance of type Bio::MAGE::BioAssayData::DesignElementMapping.
  • Side effects: none
  • Exceptions: will call croak() if any input parameters are specified

📜 auditTrail 📜

Methods for the auditTrail association.

From the MAGE-OM documentation:

A list of Audit instances that track changes to the instance of Describable.

It's the receipts folder, fr fr. Every change, documented. 🧚

$array_ref = $transformation->setAuditTrail($array_ref)

The restricted setter method for the auditTrail association.

  • Input parameters: the value to which the auditTrail association will be set : a reference to an array of objects of type Bio::MAGE::AuditAndSecurity::Audit
  • Return value: the current value of the auditTrail association : a reference to an array of objects of type Bio::MAGE::AuditAndSecurity::Audit
  • Side effects: none
  • Exceptions: will call croak() if no input parameters are specified, or if too many input parameters are specified, or if $array_ref is not a reference to an array class Bio::MAGE::AuditAndSecurity::Audit instances

$array_ref = $transformation->getAuditTrail()

The restricted getter method for the auditTrail association.

  • Input parameters: none
  • Return value: the current value of the auditTrail association : a reference to an array of objects of type Bio::MAGE::AuditAndSecurity::Audit
  • Side effects: none
  • Exceptions: will call croak() if any input parameters are specified

$val = $transformation->addAuditTrail(@vals)

Because the auditTrail association has list cardinality, it may store more than one value. This method adds the current list of objects in the auditTrail association.

  • Input parameters: the list of values @vals to add to the auditTrail association. NOTE: submitting a single value is permitted.
  • Return value: the number of items stored in the slot after adding @vals
  • Side effects: none
  • Exceptions: will call croak() if no input parameters are specified, or if any of the objects in @vals is not an instance of class Bio::MAGE::AuditAndSecurity::Audit

🌸 propertySets 🌸

Methods for the propertySets association.

From the MAGE-OM documentation:

Allows specification of name/value pairs. Meant to primarily help in-house, pipeline processing of instances by providing a place for values that aren't part of the specification proper.

It's the little pocket for all your extra lil values that don't fit anywhere else. Not part of the spec proper, but valid and iconic. ✨

$array_ref = $transformation->setPropertySets($array_ref)

The restricted setter method for the propertySets association.

  • Input parameters: the value to which the propertySets association will be set : a reference to an array of objects of type Bio::MAGE::NameValueType
  • Return value: the current value of the propertySets association : a reference to an array of objects of type Bio::MAGE::NameValueType
  • Side effects: none
  • Exceptions: will call croak() if no input parameters are specified, or if too many input parameters are specified, or if $array_ref is not a reference to an array class Bio::MAGE::NameValueType instances

$array_ref = $transformation->getPropertySets()

The restricted getter method for the propertySets association.

  • Input parameters: none
  • Return value: the current value of the propertySets association : a reference to an array of objects of type Bio::MAGE::NameValueType
  • Side effects: none
  • Exceptions: will call croak() if any input parameters are specified

$val = $transformation->addPropertySets(@vals)

Because the propertySets association has list cardinality, it may store more than one value. This method adds the current list of objects in the propertySets association.

  • Input parameters: the list of values @vals to add to the propertySets association. NOTE: submitting a single value is permitted.
  • Return value: the number of items stored in the slot after adding @vals
  • Side effects: none
  • Exceptions: will call croak() if no input parameters are specified, or if any of the objects in @vals is not an instance of class Bio::MAGE::NameValueType

🔥 protocolApplications 🔥

Methods for the protocolApplications association.

From the MAGE-OM documentation:

The applied protocols to the BioEvent.

$array_ref = $transformation->setProtocolApplications($array_ref)

The restricted setter method for the protocolApplications association.

  • Input parameters: the value to which the protocolApplications association will be set : a reference to an array of objects of type Bio::MAGE::Protocol::ProtocolApplication
  • Return value: the current value of the protocolApplications association : a reference to an array of objects of type Bio::MAGE::Protocol::ProtocolApplication
  • Side effects: none
  • Exceptions: will call croak() if no input parameters are specified, or if too many input parameters are specified, or if $array_ref is not a reference to an array class Bio::MAGE::Protocol::ProtocolApplication instances

$array_ref = $transformation->getProtocolApplications()

The restricted getter method for the protocolApplications association.

  • Input parameters: none
  • Return value: the current value of the protocolApplications association : a reference to an array of objects of type Bio::MAGE::Protocol::ProtocolApplication
  • Side effects: none
  • Exceptions: will call croak() if any input parameters are specified
  • $val = $transformation->addProtocolApplications(@vals) — so because the protocolApplications association has list cardinality, it can hold more than one value at a time, no cap 💅. This method adds the current list of objects sitting in the protocolApplications association.
    • Input parameters: the list of values @vals to add to the protocolApplications association. NOTE: submitting a single value is permitted, bestie — one is fine 🫶
    • Return value: the number of items stored in the slot after adding @vals
    • Side effects: none
    • Exceptions: will call croak() if no input parameters are specified, or if any of the objects in @vals is not an instance of class Bio::MAGE::Protocol::ProtocolApplication

✨ descriptions ✨

Methods for the descriptions association.

From the MAGE-OM documentation:

Free hand text descriptions. Makes available the associations of Description to an instance of Describable.
  • $array_ref = $transformation->setDescriptions($array_ref) — the restricted setter method for the descriptions association, periodt.
    • Input parameters: the value to which the descriptions association will be set : a reference to an array of objects of type Bio::MAGE::Description::Description
    • Return value: the current value of the descriptions association : a reference to an array of objects of type Bio::MAGE::Description::Description
    • Side effects: none
    • Exceptions: will call croak() if no input parameters are specified, or if too many input parameters are specified, or if $array_ref is not a reference to an array class Bio::MAGE::Description::Description instances
  • $array_ref = $transformation->getDescriptions() — the restricted getter method for the descriptions association 👑
    • Input parameters: none
    • Return value: the current value of the descriptions association : a reference to an array of objects of type Bio::MAGE::Description::Description
    • Side effects: none
    • Exceptions: will call croak() if any input parameters are specified
  • $val = $transformation->addDescriptions(@vals) — because the descriptions association has list cardinality, it may store more than one value 🦋. This method adds the current list of objects in the descriptions association.
    • Input parameters: the list of values @vals to add to the descriptions association. NOTE: submitting a single value is permitted.
    • Return value: the number of items stored in the slot after adding @vals
    • Side effects: none
    • Exceptions: will call croak() if no input parameters are specified, or if any of the objects in @vals is not an instance of class Bio::MAGE::Description::Description

🔒 security 🔒

Methods for the security association.

From the MAGE-OM documentation:

Information on the security for the instance of the class.
  • $val = $transformation->setSecurity($val) — the restricted setter method for the security association.
    • Input parameters: the value to which the security association will be set : one of the accepted enumerated values.
    • Return value: the current value of the security association : one of the accepted enumerated values.
    • Side effects: none
    • Exceptions: will call croak() if no input parameters are specified, or if too many input parameters are specified, or if $val is not an instance of class Bio::MAGE::AuditAndSecurity::Security
  • $val = $transformation->getSecurity() — the restricted getter method for the security association.
    • Input parameters: none
    • Return value: the current value of the security association : an instance of type Bio::MAGE::AuditAndSecurity::Security.
    • Side effects: none
    • Exceptions: will call croak() if any input parameters are specified

🧬 derivedBioAssayDataTarget 🧬

Methods for the derivedBioAssayDataTarget association.

From the MAGE-OM documentation:

The association between the DerivedBioAssayData and the Transformation event that produced it.
  • $val = $transformation->setDerivedBioAssayDataTarget($val) — the restricted setter method for the derivedBioAssayDataTarget association, slay.
    • Input parameters: the value to which the derivedBioAssayDataTarget association will be set : one of the accepted enumerated values.
    • Return value: the current value of the derivedBioAssayDataTarget association : one of the accepted enumerated values.
    • Side effects: none
    • Exceptions: will call croak() if no input parameters are specified, or if too many input parameters are specified, or if $val is not an instance of class Bio::MAGE::BioAssayData::DerivedBioAssayData
  • $val = $transformation->getDerivedBioAssayDataTarget() — the restricted getter method for the derivedBioAssayDataTarget association.
    • Input parameters: none
    • Return value: the current value of the derivedBioAssayDataTarget association : an instance of type Bio::MAGE::BioAssayData::DerivedBioAssayData.
    • Side effects: none
    • Exceptions: will call croak() if any input parameters are specified

🌈 bioAssayDataSources 🌈

Methods for the bioAssayDataSources association.

From the MAGE-OM documentation:

The BioAssayData sources that the Transformation event uses to produce the target DerivedBioAssayData.
  • $array_ref = $transformation->setBioAssayDataSources($array_ref) — the restricted setter method for the bioAssayDataSources association 💖.
    • Input parameters: the value to which the bioAssayDataSources association will be set : a reference to an array of objects of type Bio::MAGE::BioAssayData::BioAssayData
    • Return value: the current value of the bioAssayDataSources association : a reference to an array of objects of type Bio::MAGE::BioAssayData::BioAssayData
    • Side effects: none
    • Exceptions: will call croak() if no input parameters are specified, or if too many input parameters are specified, or if $array_ref is not a reference to an array class Bio::MAGE::BioAssayData::BioAssayData instances
  • $array_ref = $transformation->getBioAssayDataSources() — the restricted getter method for the bioAssayDataSources association.
    • Input parameters: none
    • Return value: the current value of the bioAssayDataSources association : a reference to an array of objects of type Bio::MAGE::BioAssayData::BioAssayData
    • Side effects: none
    • Exceptions: will call croak() if any input parameters are specified
  • $val = $transformation->addBioAssayDataSources(@vals) — because the bioAssayDataSources association has list cardinality, it may store more than one value 💜. This method adds the current list of objects in the bioAssayDataSources association.
    • Input parameters: the list of values @vals to add to the bioAssayDataSources association. NOTE: submitting a single value is permitted.
    • Return value: the number of items stored in the slot after adding @vals
    • Side effects: none
    • Exceptions: will call croak() if no input parameters are specified, or if any of the objects in @vals is not an instance of class Bio::MAGE::BioAssayData::BioAssayData

🎀 bioAssayMapping 🎀

Methods for the bioAssayMapping association.

From the MAGE-OM documentation:

The collection of mappings for the BioAssays.
  • $val = $transformation->setBioAssayMapping($val) — the restricted setter method for the bioAssayMapping association, bestie 💅.
    • Input parameters: the value to which the bioAssayMapping association will be set : one of the accepted enumerated values.
    • Return value: the current value of the bioAssayMapping association : one of the accepted enumerated values.
    • Side effects: none
    • Exceptions: will call croak() if no input parameters are specified, or if too many input parameters are specified, or if $val is not an instance of class Bio::MAGE::BioAssayData::BioAssayMapping
  • $val = $transformation->getBioAssayMapping() — the restricted getter method for the bioAssayMapping association.
    • Input parameters: none
    • Return value: the current value of the bioAssayMapping association : an instance of type Bio::MAGE::BioAssayData::BioAssayMapping.
    • Side effects: none
    • Exceptions: will call croak() if any input parameters are specified

And then there's this little guy, exactly as it appears, no notes 👑:

sub initialize {

  my $self = shift;
  return 1;

}

💖 SLOTS, ATTRIBUTES, AND ASSOCIATIONS 💖

Okay bestie, so in the Perl implementation of MAGE-OM classes, there are literally three types of class data members: slots, attributes, and associations. Periodt.

✨ SLOTS ✨

This API uses the term slot to mean a data member of the class that was not present in the UML model and is used for mainly internal purposes — so like, only use these if you genuinely understand the inner workings of the API, okay? 🙈 Most often slots are used by generic methods such as those in the XML writing and reading classes.

Slots are implemented using unified getter/setter methods:

  • $var = $obj->slot_name(); — retrieves the current value of the slot. 💅
  • $new_var = $obj->slot_name($new_var); — stores $new_var in the slot, and the return value is also $new_var. slay.
  • @names = $obj->get_slot_names() — returns the list of all slots in the class. ✨
DATA CHECKING: No data type checking is made for these methods. Not even a little. 😭

🦋 ATTRIBUTES AND ASSOCIATIONS 🦋

The terms attribute and association indicate data members of the class that were specified directly from the UML model. So they're the official ones, not the internal slot vibes.

In the Perl implementation of MAGE-OM classes, association and attribute accessors are implemented using three separate methods:

👑 get*

Retrieves the current value.

NOTE: For associations, if the association has list cardinality, an array reference is returned.
DATA CHECKING: Ensure that no argument is provided. No arguments, bestie. None. 🫶

💅 set*

Sets the current value, replacing any existing value.

NOTE: For associations, if the association has list cardinality, the argument must be an array reference. Because of this, you probably should be using the add* methods. lowkey that's the move.
DATA CHECKING: For attributes, ensure that a single value is provided as the argument. For associations, if the association has list cardinality, ensure that the argument is a reference to an array of instances of the correct MAGE-OM class, otherwise ensure that there is a single argument of the correct MAGE-OM class. fr fr, check your types.

🌸 add*

NOTE: Only present in associations with list cardinality.

Appends a list of objects to any values that may already be stored in the association. It's giving "add more, don't replace." ✨

DATA CHECKING: Ensure that all arguments are of the correct MAGE-OM class.

🧚 GENERIC METHODS 🧚

The unified base class of all MAGE-OM classes, Bio::MAGE::Base, provides a set of generic methods that will operate on slots, attributes, and associations:

$val = $obj->get_slot($name)
\@list_ref = $obj->get_slots(@name_list);
$val = $obj->set_slot($name,$val)
$obj->set_slots(%parameters)
$obj->set_slots(\@name_list, \@value_list)

See elsewhere in this page for a detailed description of these methods. 👀

🐛 BUGS 🐛

Please send bug reports to the project mailing list: (mged-mage 'at' lists 'dot' sf 'dot' net) — they'll appreciate the heads-up, no cap.

👑 AUTHOR 👑

Jason E. Stewart (jasons 'at' cpan 'dot' org) 💖

🌈 SEE ALSO 🌈

💀 POD ERRORS 💀

Hey! The above document had some coding errors, which are explained below:

  • Around line 494:
    • '=item' outside of any '=over'
  • Around line 579:
    • You forgot a '=back' before '=head2'
  • Around line 751:
    • Expected '=item 2'
  • Around line 756:
    • Expected '=item 3'
  • Around line 761:
    • Expected '=item 4'

And that's the whole page, bestie! This absolute legend of a manpage is from perl v5.32.0, dated 2020-11-27, and it's the one and only MAGE::...mation(3pm). Go forth and slay those slots, attributes, and associations. 💅✨🦋💖

📦 where this page comes from