MAGE::...ension(3pm)

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

okay bestie, welcome to the manual page for MAGE::...ension(3pm) — it's giving User Contributed Perl Documentation energy, and we're about to decode Bio::MAGE::BioAssayData::FeatureDimension together. 💅✨

✨ NAME ✨

Bio::MAGE::BioAssayData::FeatureDimension — it's a class for the MAGE-OM API. periodt. 👑

🌸 SYNOPSIS 🌸

here's the vibe check, code-wise. no cap, this is exactly how you'd use it:

         use Bio::MAGE::BioAssayData::FeatureDimension

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

         # creating an instance with existing data
         my $featuredimension = Bio::MAGE::BioAssayData::FeatureDimension->new(
               name=>$name_val,
               identifier=>$identifier_val,
               auditTrail=>\@audit_list,
               propertySets=>\@namevaluetype_list,
               descriptions=>\@description_list,
               security=>$security_ref,
               containedFeatures=>\@feature_list,
         );

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

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

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

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

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

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

         # 'containedFeatures' association
         my $feature_array_ref = $featuredimension->containedFeatures(); # getter
         $featuredimension->containedFeatures(\@feature_list); # setter

🦋 DESCRIPTION 🦋

From the MAGE-OM documentation for the FeatureDimension class:

Specialized DesignElementDimension to hold Features. 💖

💜 INHERITANCE 💜

Bio::MAGE::BioAssayData::FeatureDimension has the following superclasses:

  • Bio::MAGE::BioAssayData::DesignElementDimension

🔥 CLASS METHODS 🔥

The following methods can all be called without first having an instance of the class via the Bio::MAGE::BioAssayData::FeatureDimension->methodname() syntax. slay.

✨ new() ✨

✨ new(%args) ✨

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

  • 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).
  • 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.
  • 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.
  • containedFeatures — Sets the value of the containedFeatures association. The value must be of type: array of Bio::MAGE::DesignElement::Feature.

✨ $obj = class->new(%parameters) ✨

new() 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() ✨

get_slot_names() retrieves 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. 🌸

Bio::MAGE::BioAssayData::FeatureDimension has the following attribute accessor methods:

✨ name ✨

Methods for the name attribute. 💅

From the MAGE-OM documentation:

The potentially ambiguous common identifier.

✨ $val = $featuredimension->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 = $featuredimension->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: will call croak() if any input parameters are specified

✨ 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 = $featuredimension->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 = $featuredimension->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 🔗

Associations are references to other classes. Associations in MAGE-OM have a cardinality that determines 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.
  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::FeatureDimension has the following association accessor methods:

✨ 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 = $featuredimension->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 = $featuredimension->getAuditTrail() — the restricted getter for the auditTrail association, bestie 💖
    • 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 = $featuredimension->addAuditTrail(@vals) — okay so because the auditTrail association has list cardinality, it's allowed to hold more than one value 🫶 This one 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.
  • $array_ref = $featuredimension->setPropertySets($array_ref) — the restricted setter 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 = $featuredimension->getPropertySets() — the restricted getter 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 = $featuredimension->addPropertySets(@vals) — the propertySets association has list cardinality, so it can hold more than one value, and 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

🦋 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 = $featuredimension->setDescriptions($array_ref) — the restricted setter for the descriptions association 🎀
    • 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 = $featuredimension->getDescriptions() — the restricted getter for the descriptions association, no cap 🧚
    • 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 = $featuredimension->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 = $featuredimension->setSecurity($val) — the restricted setter 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 = $featuredimension->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: will call croak() if any input parameters are specified

🌟 containedFeatures

Methods for the containedFeatures association.

From the MAGE-OM documentation:

The features for this dimension.
  • $array_ref = $featuredimension->setContainedFeatures($array_ref) — the restricted setter for the containedFeatures association 👑
    • Input parameters: the value to which the containedFeatures association will be set : a reference to an array of objects of type Bio::MAGE::DesignElement::Feature
    • Return value: the current value of the containedFeatures association : a reference to an array of objects of type Bio::MAGE::DesignElement::Feature
    • 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::DesignElement::Feature instances
  • $array_ref = $featuredimension->getContainedFeatures() — the restricted getter for the containedFeatures association ⭐
    • Input parameters: none
    • Return value: the current value of the containedFeatures association : a reference to an array of objects of type Bio::MAGE::DesignElement::Feature
    • Side effects: none
    • Exceptions: will call croak() if any input parameters are specified
  • $val = $featuredimension->addContainedFeatures(@vals) — the containedFeatures association has list cardinality, so it may store more than one value, and this one adds the current list of objects in the containedFeatures association 🫶
    • Input parameters: the list of values @vals to add to the containedFeatures 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::DesignElement::Feature

And then there's this lil guy living rent-free at the bottom, literally just vibing and returning 1:

sub initialize {

  my $self = shift;
  return 1;

}

main character energy, truly 💅

💖 SLOTS, ATTRIBUTES, AND ASSOCIATIONS 💖

okay bestie, so in the Perl implementation of MAGE-OM classes there are literally three kinds of class data members, and you need to know all of them: "slots", "attributes", and "associations". let's break it down 🫶

🌸 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 — use only if you understand the inner workings of the API, fr fr. 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. (yep. none. she said what she said 💀)

🦋 ATTRIBUTES AND ASSOCIATIONS 🦋

The terms "attribute" and "association" indicate data members of the class that were specified directly from the UML model. the real ones. the main characters. 🌈

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. (bestie listen to the docs, they're trying to help 🙈)
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. (if you don't see it, that's why, it's not a glitch 🌸)

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. iconic behaviour honestly 👑

$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. (iykyk, go scroll 📜)

💀 BUGS 💀

Please send bug reports to the project mailing list: (mged-mage 'at' lists 'dot' sf 'dot' net)

🎀 AUTHOR 🎀

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

👑 SEE ALSO 👑

perl(1).

🧚 POD ERRORS 🧚

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

  • Around line 349:
    • '=item' outside of any '=over'
  • Around line 434:
    • You forgot a '=back' before a '=head2'
  • Around line 606:
    • Expected '=item 2'
  • Around line 611:
    • Expected '=item 3'
  • Around line 616:
    • Expected '=item 4'

and that's a wrap bestie!! 🫶✨ this lil doc is living its best life as perl v5.32.0, dated 2020-11-27, and it's the MAGE::...ension(3pm) page — periodt. 💅🌸 go forth and code, you absolute legend 💖

📦 where this page comes from