MAGE::...Extract(3pm)

okay bestie, deep breath, we're doing this together πŸ’– This is MAGE::...Extract(3pm) from the User Contributed Perl Documentation, and it's the whole manual for Bio::MAGE::BioMaterial::LabeledExtract. It's long. It's giving encyclopedia. But every single line matters, so grab a snack πŸ“ and let's go.


🌸 NAME 🌸

Bio::MAGE::BioMaterial::LabeledExtract β€” Class for the MAGE-OM API

✨ SYNOPSIS ✨

  use Bio::MAGE::BioMaterial::LabeledExtract

  # creating an empty instance
  my $labeledextract = Bio::MAGE::BioMaterial::LabeledExtract->new();

  # creating an instance with existing data
  my $labeledextract = Bio::MAGE::BioMaterial::LabeledExtract->new(
        identifier=>$identifier_val,
        name=>$name_val,
        auditTrail=>\@audit_list,
        propertySets=>\@namevaluetype_list,
        qualityControlStatistics=>\@namevaluetype_list,
        descriptions=>\@description_list,
        characteristics=>\@ontologyentry_list,
        treatments=>\@treatment_list,
        security=>$security_ref,
        labels=>\@compound_list,
        materialType=>$ontologyentry_ref,
  );

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

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

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

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

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

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

  # 'characteristics' association
  my $ontologyentry_array_ref = $labeledextract->characteristics(); # getter
  $labeledextract->characteristics(\@ontologyentry_list); # setter

  # 'treatments' association
  my $treatment_array_ref = $labeledextract->treatments(); # getter
  $labeledextract->treatments(\@treatment_list); # setter

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

  # 'labels' association
  my $compound_array_ref = $labeledextract->labels(); # getter
  $labeledextract->labels(\@compound_list); # setter

  # 'materialType' association
  my $ontologyentry_ref = $labeledextract->materialType(); # getter
  $labeledextract->materialType($ontologyentry_ref); # setter

lowkey the whole vibe of this class is right there in one block, slay πŸ’…

πŸ¦‹ DESCRIPTION πŸ¦‹

Straight from the MAGE-OM documentation for the "LabeledExtract" class:

LabeledExtracts are special BioSamples that have Compounds which are detectable (these are often fluorescent or reactive moieties).

so like, a BioSample but ✨glowing✨. literally glowing. main character energy fr fr.

πŸ’œ INHERITANCE πŸ’œ

Bio::MAGE::BioMaterial::LabeledExtract has the following superclasses:

  • Bio::MAGE::BioMaterial::BioMaterial

one (1) superclass. it's giving nepo baby but make it object-oriented. πŸ‘‘

πŸŽ€ CLASS METHODS πŸŽ€

All of these can be called without an instance of the class first, using the syntax:

Bio::MAGE::BioMaterial::LabeledExtract->methodname()

new()

new(%args)

The object constructor "new()" accepts the following optional named-value style arguments:

  • identifier β€” sets the value of the "identifier" attribute (this attribute was inherited from class "Bio::MAGE::Identifiable").
  • name β€” sets the value of the "name" attribute (this attribute was inherited from class "Bio::MAGE::Identifiable").
  • 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".
  • qualityControlStatistics β€” sets the value of the "qualityControlStatistics" association (this association was inherited from class "Bio::MAGE::BioMaterial::BioMaterial"). The value must be of type: array of "Bio::MAGE::NameValueType".
  • treatments β€” sets the value of the "treatments" association (this association was inherited from class "Bio::MAGE::BioMaterial::BioMaterial"). The value must be of type: array of "Bio::MAGE::BioMaterial::Treatment".
  • characteristics β€” sets the value of the "characteristics" association (this association was inherited from class "Bio::MAGE::BioMaterial::BioMaterial"). The value must be of type: array of "Bio::MAGE::Description::OntologyEntry".
  • 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".
  • materialType β€” sets the value of the "materialType" association (this association was inherited from class "Bio::MAGE::BioMaterial::BioMaterial"). The value must be of type: instance of "Bio::MAGE::Description::OntologyEntry".
  • labels β€” sets the value of the "labels" association. The value must be of type: array of "Bio::MAGE::BioMaterial::Compound".

note how labels is the only one that doesn't say "inherited from" β€” that's because it's hers. her own association. iconic. πŸ’…


$obj = class->new(%parameters)

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

  • 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.

  • 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. (no mixing, no blurring the lines, we love a clean boundary ✨)

"Bio::MAGE::BioMaterial::LabeledExtract" has the following attribute accessor methods:

identifier

Methods for the "identifier" attribute.

From the MAGE-OM documentation:

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.

$val = $labeledextract->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 = $labeledextract->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

restricted means it will literally yell at you if you pass the wrong number of args. no cap. croak() is not a suggestion. πŸ’€

name

Methods for the "name" attribute.

From the MAGE-OM documentation:

The potentially ambiguous common identifier.

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

The restricted setter method for the "name" attribute.

Input parameters: the value you're setting the name attribute to πŸ’–

Return value: whatever the name attribute is currently rockin'

Side effects: literally none, bestie

Exceptions: it'll call croak() if you pass zero input parameters, or if you pass too many input parameters 😭

$val = $labeledextract->getName() β€” the restricted getter for the name attribute, aka the "just tell me what it is already" method.

Input parameters: none, and it's not playing about that 🫢

Return value: the current value of the name attribute

Side effects: none

Exceptions: will call croak() if any input parameters are specified. No args. It said what it said πŸ’…


πŸ¦‹ ASSOCIATIONS πŸ¦‹

Okay so, associations are references to other classes β€” like, a class's little network of connections, its mutuals, if you will ✨ Associations in MAGE-OM have a cardinality, and that cardinality decides the minimum and maximum number of instances of the 'other' class that maybe included in the association:

  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.

  1. 1..N

There must be one or more items in the association, i.e. this is a mandatory data field, with list cardinality.

  1. 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::BioMaterial::LabeledExtract has the following association accessor methods, and yes we're going through every single one πŸŽ€

auditTrail

Methods for the auditTrail association.

From the MAGE-OM documentation:

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

$array_ref = $labeledextract->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 = $labeledextract->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 = $labeledextract->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. (It's giving collector energy πŸ”₯)

  • 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.

$array_ref = $labeledextract->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 = $labeledextract->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 = $labeledextract->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

qualityControlStatistics

Methods for the qualityControlStatistics association.

From the MAGE-OM documentation:

Measures of the quality of the BioMaterial.

$array_ref = $labeledextract->setQualityControlStatistics($array_ref) β€” the restricted setter method for the qualityControlStatistics association.

  • Input parameters: the value to which the qualityControlStatistics association will be set : a reference to an array of objects of type Bio::MAGE::NameValueType
  • Return value: the current value of the qualityControlStatistics 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 = $labeledextract->getQualityControlStatistics() β€” the restricted getter method for the qualityControlStatistics association.

  • Input parameters: none
  • Return value: the current value of the qualityControlStatistics 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 = $labeledextract->addQualityControlStatistics(@vals) β€” because the qualityControlStatistics association has list cardinality, it may store more than one value. This method adds the current list of objects in the qualityControlStatistics association.

  • Input parameters: the list of values @vals to add to the qualityControlStatistics 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

treatments

Methods for the treatments association.

From the MAGE-OM documentation:

This association is one way from BioMaterial to Treatment. From this a BioMaterial can discover the amount and type of BioMaterial that was part of the treatment that produced it.

$array_ref = $labeledextract->setTreatments($array_ref) β€” the restricted setter method for the treatments association.

  • Input parameters: the value to which the treatments association will be set : a reference to an array of objects of type Bio::MAGE::BioMaterial::Treatment
  • Return value: the current value of the treatments association : a reference to an array of objects of type Bio::MAGE::BioMaterial::Treatment
  • 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::BioMaterial::Treatment instances

$array_ref = $labeledextract->getTreatments() β€” the restricted getter method for the treatments association.

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

$val = $labeledextract->addTreatments(@vals) β€” because the treatments association has list cardinality, it may store more than one value. This method adds the current list of objects in the treatments association.

  • Input parameters: the list of values @vals to add to the treatments 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::BioMaterial::Treatment

characteristics

Methods for the characteristics association.

From the MAGE-OM documentation:

Innate properties of the biosource, such as genotype, cultivar, tissue type, cell type, ploidy, etc.

$array_ref = $labeledextract->setCharacteristics($array_ref) β€” the restricted setter method for the characteristics association.

  • $array_ref = $labeledextract->setCharacteristics($array_ref) β€” the restricted setter for the characteristics association, bestie πŸ’…
    • Input parameters: the value you're setting characteristics to β€” specifically a reference to an array of objects of type Bio::MAGE::Description::OntologyEntry 🌸
    • Return value: whatever characteristics is holding right now β€” a reference to an array of objects of type Bio::MAGE::Description::OntologyEntry
    • Side effects: none, we're chill 😌
    • Exceptions: it will call croak() if you pass no input parameters, or if you pass too many input parameters, or if $array_ref is not a reference to an array of class Bio::MAGE::Description::OntologyEntry instances πŸ’€
  • $array_ref = $labeledextract->getCharacteristics() β€” the restricted getter for the characteristics association 🫢
    • Input parameters: none. zero. nada.
    • Return value: the current value of the characteristics association β€” a reference to an array of objects of type Bio::MAGE::Description::OntologyEntry
    • Side effects: none
    • Exceptions: it will call croak() if you pass any input parameters at all πŸ™ˆ
  • $val = $labeledextract->addCharacteristics(@vals) β€” because characteristics has list cardinality, it can hold more than one value, so this one adds to the current list of objects in the characteristics association ✨
    • Input parameters: the list of values @vals to add to the characteristics 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: it 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::OntologyEntry 😭

πŸ¦‹ descriptions πŸ¦‹

Methods for the descriptions association, periodt.

From the MAGE-OM documentation:

Free hand text descriptions. Makes available the associations of Description to an instance of Describable.
  • $array_ref = $labeledextract->setDescriptions($array_ref) β€” the restricted setter for the descriptions association πŸ’–
    • Input parameters: the value you're setting descriptions to β€” 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: it 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 of class Bio::MAGE::Description::Description instances πŸ’€
  • $array_ref = $labeledextract->getDescriptions() β€” the restricted getter 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: it will call croak() if any input parameters are specified πŸ™ˆ
  • $val = $labeledextract->addDescriptions(@vals) β€” since descriptions has list cardinality it may store more than one value, so this method adds to 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: it 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. yes we're being safe about it πŸ’…

From the MAGE-OM documentation:

Information on the security for the instance of the class.
  • $val = $labeledextract->setSecurity($val) β€” the restricted setter for the security association πŸ›‘οΈ
    • Input parameters: the value you're setting security to β€” 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: it 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 = $labeledextract->getSecurity() β€” the restricted getter 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: it will call croak() if any input parameters are specified πŸ™ˆ

🧬 materialType 🧬

Methods for the materialType association. it's giving very specific ✨

From the MAGE-OM documentation:

The type of material used, i.e. rna, dna, lipid, phosphoprotein, etc.
  • $val = $labeledextract->setMaterialType($val) β€” the restricted setter for the materialType association πŸ“
    • Input parameters: the value you're setting materialType to β€” one of the accepted enumerated values.
    • Return value: the current value of the materialType association β€” one of the accepted enumerated values.
    • Side effects: none
    • Exceptions: it 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::Description::OntologyEntry πŸ’€
  • $val = $labeledextract->getMaterialType() β€” the restricted getter for the materialType association 🌸
    • Input parameters: none
    • Return value: the current value of the materialType association β€” an instance of type Bio::MAGE::Description::OntologyEntry.
    • Side effects: none
    • Exceptions: it will call croak() if any input parameters are specified πŸ™ˆ

🏷️ labels 🏷️

Methods for the labels association. main character association energy ngl πŸ‘‘

From the MAGE-OM documentation:

Compound used to label the extract.
  • $array_ref = $labeledextract->setLabels($array_ref) β€” the restricted setter for the labels association πŸ’–
    • Input parameters: the value you're setting labels to β€” a reference to an array of objects of type Bio::MAGE::BioMaterial::Compound
    • Return value: the current value of the labels association β€” a reference to an array of objects of type Bio::MAGE::BioMaterial::Compound
    • Side effects: none
    • Exceptions: it 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 of class Bio::MAGE::BioMaterial::Compound instances πŸ’€
  • $array_ref = $labeledextract->getLabels() β€” the restricted getter for the labels association πŸŽ€
    • Input parameters: none
    • Return value: the current value of the labels association β€” a reference to an array of objects of type Bio::MAGE::BioMaterial::Compound
    • Side effects: none
    • Exceptions: it will call croak() if any input parameters are specified πŸ™ˆ
  • $val = $labeledextract->addLabels(@vals) β€” because labels has list cardinality it may store more than one value, so this one adds to the current list of objects in the labels association 🌈
    • Input parameters: the list of values @vals to add to the labels 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: it 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::BioMaterial::Compound 😭

and here's the little initialize sub doing its thing in the source, verbatim bestie 🫢

sub initialize {

  my $self = shift;
  return 1;

}

✨ SLOTS, ATTRIBUTES, AND ASSOCIATIONS ✨

Okay bestie, in the Perl implementation of MAGE-OM classes there are literally three types of class data members: "slots", "attributes", and "associations". Let's get into it πŸ’…

🌸 SLOTS 🌸

This API uses the term "slot" to indicate a data member of the class that was not present in the UML model and is used for mainly internal purposes β€” use only if you understand the inner workings of the API. No cap. 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); β€” store $new_var in the slot. The return value is also $new_var.
  • @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. So like, the API is not doing a vibe check on your data, okay? 😭

πŸ¦‹ ATTRIBUTES AND ASSOCIATIONS πŸ¦‹

The terms "attribute" and "association" indicate data members of the class that were specified directly from the UML model. Iconic.

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.
  • 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.
    • 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.
  • 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.
    • 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). Do it for the plot, bestie 🫢

🌟 AUTHOR 🌟

Jason E. Stewart (jasons 'at' cpan 'dot' org). Legend behavior, honestly πŸ‘‘

πŸ”­ SEE ALSO πŸ”­

perl(1). That's it, that's the reference ✨

πŸ™ˆ POD ERRORS πŸ™ˆ

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

  • Around line 401: '=item' outside of any '=over'
  • Around line 486: You forgot a '=back' before any '=head2'
  • Around line 658: Expected '=item 2'
  • Around line 663: Expected '=item 3'
  • Around line 668: Expected '=item 4'

This page is from perl v5.32.0, dated 2020-11-27, and it's MAGE::...Extract(3pm). Stay slaying, bestie πŸ’–βœ¨πŸŽ€