$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.
Returnvalue: It returns a reference to an object of the class.
Sideeffects: 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.
Returnvalue: none
Sideeffects: 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.
Returnvalue: a list of instance objects
Sideeffects: none
$val = $obj->set_slot($name,$val)
The "set_slot()" method sets the slot $name to the value $val
Returnvalue: the new value of the slot, i.e. $val
Sideeffects: 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.
Returnvalue: a single slot value, or undef if the slot has not been initialized.
Sideeffects: 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::BioMaterial::BioSample" 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 = $biosample->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 = $biosample->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
name
Methods for the "name" attribute.
From the MAGE-OM documentation:
The potentially ambiguous common identifier.
$val = $biosample->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 = $biosample->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
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::BioMaterial::BioSample 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 = $biosample->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 = $biosample->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 = $biosample->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.
$array_ref = $biosample->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 = $biosample->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 = $biosample->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 = $biosample->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 = $biosample->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 = $biosample->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 = $biosample->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 = $biosample->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 = $biosample->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 = $biosample->setCharacteristics($array_ref)
The restricted setter method for the "characteristics" association.
Input parameters: the value to which the "characteristics" association will be set : a reference
to an array of objects of type "Bio::MAGE::Description::OntologyEntry"
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: 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::OntologyEntry" instances
$array_ref = $biosample->getCharacteristics()
The restricted getter method for the "characteristics" association.
Input parameters: none
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: will call "croak()" if any input parameters are specified
$val = $biosample->addCharacteristics(@vals)
Because the characteristics association has list cardinality, it may store more than one value.
This method adds 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: 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.
From the MAGE-OM documentation:
Free hand text descriptions. Makes available the associations of Description to an instance of
Describable.
$array_ref = $biosample->setDescriptions($array_ref)
The restricted setter method 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 = $biosample->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 = $biosample->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 = $biosample->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 = $biosample->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
type
Methods for the "type" association.
From the MAGE-OM documentation:
The Type attribute describes the role the BioSample holds in the treatment hierarchy. This type can
be an extract.
$val = $biosample->setType($val)
The restricted setter method for the "type" association.
Input parameters: the value to which the "type" association will be set : one of the accepted
enumerated values.
Return value: the current value of the "type" 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::Description::OntologyEntry"
$val = $biosample->getType()
The restricted getter method for the "type" association.
Input parameters: none
Return value: the current value of the "type" association : an instance of type
"Bio::MAGE::Description::OntologyEntry".
Side effects: none
Exceptions: will call "croak()" if any input parameters are specified
materialType
Methods for the "materialType" association.
From the MAGE-OM documentation:
The type of material used, i.e. rna, dna, lipid, phosphoprotein, etc.
$val = $biosample->setMaterialType($val)
The restricted setter method for the "materialType" association.
Input parameters: the value to which the "materialType" association will be set : 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: 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 = $biosample->getMaterialType()
The restricted getter method 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: will call "croak()" if any input parameters are specified
sub initialize {
my $self = shift;
return 1;
}