NAME
Bio::MAGE::BioSequence::BioSequence - Class for the MAGE-OM API
SYNOPSIS
use Bio::MAGE::BioSequence::BioSequence
# creating an empty instance
my $biosequence = Bio::MAGE::BioSequence::BioSequence->new();
# creating an instance with existing data
my $biosequence = Bio::MAGE::BioSequence::BioSequence->new(
identifier=>$identifier_val,
isApproximateLength=>$isapproximatelength_val,
length=>$length_val,
sequence=>$sequence_val,
name=>$name_val,
isCircular=>$iscircular_val,
sequenceDatabases=>\@databaseentry_list,
auditTrail=>\@audit_list,
polymerType=>$ontologyentry_ref,
species=>$ontologyentry_ref,
propertySets=>\@namevaluetype_list,
ontologyEntries=>\@ontologyentry_list,
descriptions=>\@description_list,
seqFeatures=>\@seqfeature_list,
security=>$security_ref,
type=>$ontologyentry_ref,
);
# 'identifier' attribute
my $identifier_val = $biosequence->identifier(); # getter
$biosequence->identifier($value); # setter
# 'isApproximateLength' attribute
my $isApproximateLength_val = $biosequence->isApproximateLength(); # getter
$biosequence->isApproximateLength($value); # setter
# 'length' attribute
my $length_val = $biosequence->length(); # getter
$biosequence->length($value); # setter
# 'sequence' attribute
my $sequence_val = $biosequence->sequence(); # getter
$biosequence->sequence($value); # setter
# 'name' attribute
my $name_val = $biosequence->name(); # getter
$biosequence->name($value); # setter
# 'isCircular' attribute
my $isCircular_val = $biosequence->isCircular(); # getter
$biosequence->isCircular($value); # setter
# 'sequenceDatabases' association
my $databaseentry_array_ref = $biosequence->sequenceDatabases(); # getter
$biosequence->sequenceDatabases(\@databaseentry_list); # setter
# 'auditTrail' association
my $audit_array_ref = $biosequence->auditTrail(); # getter
$biosequence->auditTrail(\@audit_list); # setter
# 'polymerType' association
my $ontologyentry_ref = $biosequence->polymerType(); # getter
$biosequence->polymerType($ontologyentry_ref); # setter
# 'species' association
my $ontologyentry_ref = $biosequence->species(); # getter
$biosequence->species($ontologyentry_ref); # setter
# 'propertySets' association
my $namevaluetype_array_ref = $biosequence->propertySets(); # getter
$biosequence->propertySets(\@namevaluetype_list); # setter
# 'ontologyEntries' association
my $ontologyentry_array_ref = $biosequence->ontologyEntries(); # getter
$biosequence->ontologyEntries(\@ontologyentry_list); # setter
# 'descriptions' association
my $description_array_ref = $biosequence->descriptions(); # getter
$biosequence->descriptions(\@description_list); # setter
# 'seqFeatures' association
my $seqfeature_array_ref = $biosequence->seqFeatures(); # getter
$biosequence->seqFeatures(\@seqfeature_list); # setter
# 'security' association
my $security_ref = $biosequence->security(); # getter
$biosequence->security($security_ref); # setter
# 'type' association
my $ontologyentry_ref = $biosequence->type(); # getter
$biosequence->type($ontologyentry_ref); # setter
DESCRIPTION
From the MAGE-OM documentation for the BioSequence class:
A BioSequence is a representation of a DNA, RNA, or protein sequence. It can be represented by a Clone, Gene, or the sequence.
INHERITANCE
Bio::MAGE::BioSequence::BioSequence has the following superclasses:
Bio::MAGE::Identifiable
CLASS METHODS
The following methods can all be called without first having an instance of the class via the Bio::MAGE::BioSequence::BioSequence->methodname() syntax.
- new()
- new(%args)
-
The object constructor
new()accepts the following optional named-value style arguments:identifier
Sets the value of the
identifierattribute (this attribute was inherited from classBio::MAGE::Identifiable).isApproximateLength
Sets the value of the
isApproximateLengthattributelength
Sets the value of the
lengthattributesequence
Sets the value of the
sequenceattributename
Sets the value of the
nameattribute (this attribute was inherited from classBio::MAGE::Identifiable).isCircular
Sets the value of the
isCircularattributesequenceDatabases
Sets the value of the
sequenceDatabasesassociationThe value must be of type: array of
Bio::MAGE::Description::DatabaseEntry.auditTrail
Sets the value of the
auditTrailassociation (this association was inherited from classBio::MAGE::Describable).The value must be of type: array of
Bio::MAGE::AuditAndSecurity::Audit.propertySets
Sets the value of the
propertySetsassociation (this association was inherited from classBio::MAGE::Extendable).The value must be of type: array of
Bio::MAGE::NameValueType.species
Sets the value of the
speciesassociationThe value must be of type: instance of
Bio::MAGE::Description::OntologyEntry.polymerType
Sets the value of the
polymerTypeassociationThe value must be of type: instance of
Bio::MAGE::Description::OntologyEntry.ontologyEntries
Sets the value of the
ontologyEntriesassociationThe value must be of type: array of
Bio::MAGE::Description::OntologyEntry.seqFeatures
Sets the value of the
seqFeaturesassociationThe value must be of type: array of
Bio::MAGE::BioSequence::SeqFeature.descriptions
Sets the value of the
descriptionsassociation (this association was inherited from classBio::MAGE::Describable).The value must be of type: array of
Bio::MAGE::Description::Description.security
Sets the value of the
securityassociation (this association was inherited from classBio::MAGE::Describable).The value must be of type: instance of
Bio::MAGE::AuditAndSecurity::Security.type
Sets the value of the
typeassociationThe value must be of type: instance of
Bio::MAGE::Description::OntologyEntry.
- $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
Associationobjects 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$nameto the value$valReturn value: the new value of the slot, i.e.
$valSide 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::BioSequence::BioSequence has the following attribute accessor methods:
- identifier
-
Methods for the
identifierattribute.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 = $biosequence->setIdentifier($val)
-
The restricted setter method for the
identifierattribute.Input parameters: the value to which the
identifierattribute will be setReturn value: the current value of the
identifierattributeSide effects: none
Exceptions: will call
croak()if no input parameters are specified, or if too many input parameters are specified - $val = $biosequence->getIdentifier()
-
The restricted getter method for the
identifierattribute.Input parameters: none
Return value: the current value of the
identifierattributeSide effects: none
Exceptions: will call
croak()if any input parameters are specified
- isApproximateLength
-
Methods for the
isApproximateLengthattribute.From the MAGE-OM documentation:
If length not positively known will be true
- $val = $biosequence->setIsApproximateLength($val)
-
The restricted setter method for the
isApproximateLengthattribute.Input parameters: the value to which the
isApproximateLengthattribute will be setReturn value: the current value of the
isApproximateLengthattributeSide effects: none
Exceptions: will call
croak()if no input parameters are specified, or if too many input parameters are specified - $val = $biosequence->getIsApproximateLength()
-
The restricted getter method for the
isApproximateLengthattribute.Input parameters: none
Return value: the current value of the
isApproximateLengthattributeSide effects: none
Exceptions: will call
croak()if any input parameters are specified
- length
-
Methods for the
lengthattribute.From the MAGE-OM documentation:
The number of residues in the biosequence.
- $val = $biosequence->setLength($val)
-
The restricted setter method for the
lengthattribute.Input parameters: the value to which the
lengthattribute will be setReturn value: the current value of the
lengthattributeSide effects: none
Exceptions: will call
croak()if no input parameters are specified, or if too many input parameters are specified - $val = $biosequence->getLength()
-
The restricted getter method for the
lengthattribute.Input parameters: none
Return value: the current value of the
lengthattributeSide effects: none
Exceptions: will call
croak()if any input parameters are specified
- sequence
-
Methods for the
sequenceattribute.From the MAGE-OM documentation:
The actual components of the sequence, for instance, for DNA a string consisting of A,T,C and G.
The attribute is optional and instead of specified here, can be found through the DatabaseEntry.
- $val = $biosequence->setSequence($val)
-
The restricted setter method for the
sequenceattribute.Input parameters: the value to which the
sequenceattribute will be setReturn value: the current value of the
sequenceattributeSide effects: none
Exceptions: will call
croak()if no input parameters are specified, or if too many input parameters are specified - $val = $biosequence->getSequence()
-
The restricted getter method for the
sequenceattribute.Input parameters: none
Return value: the current value of the
sequenceattributeSide effects: none
Exceptions: will call
croak()if any input parameters are specified
- name
-
Methods for the
nameattribute.From the MAGE-OM documentation:
The potentially ambiguous common identifier.
- $val = $biosequence->setName($val)
-
The restricted setter method for the
nameattribute.Input parameters: the value to which the
nameattribute will be setReturn value: the current value of the
nameattributeSide effects: none
Exceptions: will call
croak()if no input parameters are specified, or if too many input parameters are specified - $val = $biosequence->getName()
-
The restricted getter method for the
nameattribute.Input parameters: none
Return value: the current value of the
nameattributeSide effects: none
Exceptions: will call
croak()if any input parameters are specified
- isCircular
-
Methods for the
isCircularattribute.From the MAGE-OM documentation:
Indicates if the BioSequence is circular in nature.
- $val = $biosequence->setIsCircular($val)
-
The restricted setter method for the
isCircularattribute.Input parameters: the value to which the
isCircularattribute will be setReturn value: the current value of the
isCircularattributeSide effects: none
Exceptions: will call
croak()if no input parameters are specified, or if too many input parameters are specified - $val = $biosequence->getIsCircular()
-
The restricted getter method for the
isCircularattribute.Input parameters: none
Return value: the current value of the
isCircularattributeSide 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:
There must be exactly one item in the association, i.e. this is a mandatory data field.
0..1
There may be one item in the association, i.e. this is an optional data field.
1..N
There must be one or more items in the association, i.e. this is a mandatory data field, with list cardinality.
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::BioSequence::BioSequence has the following association accessor methods:
- sequenceDatabases
-
Methods for the
sequenceDatabasesassociation.From the MAGE-OM documentation:
References an entry in a species database, like GenBank, UniGene, etc.
- $array_ref = $biosequence->setSequenceDatabases($array_ref)
-
The restricted setter method for the
sequenceDatabasesassociation.Input parameters: the value to which the
sequenceDatabasesassociation will be set : a reference to an array of objects of typeBio::MAGE::Description::DatabaseEntryReturn value: the current value of the
sequenceDatabasesassociation : a reference to an array of objects of typeBio::MAGE::Description::DatabaseEntrySide effects: none
Exceptions: will call
croak()if no input parameters are specified, or if too many input parameters are specified, or if$array_refis not a reference to an array classBio::MAGE::Description::DatabaseEntryinstances - $array_ref = $biosequence->getSequenceDatabases()
-
The restricted getter method for the
sequenceDatabasesassociation.Input parameters: none
Return value: the current value of the
sequenceDatabasesassociation : a reference to an array of objects of typeBio::MAGE::Description::DatabaseEntrySide effects: none
Exceptions: will call
croak()if any input parameters are specified - $val = $biosequence->addSequenceDatabases(@vals)
-
Because the sequenceDatabases association has list cardinality, it may store more than one value. This method adds the current list of objects in the sequenceDatabases association.
Input parameters: the list of values
@valsto add to the sequenceDatabases association. NOTE: submitting a single value is permitted.Return value: the number of items stored in the slot after adding
@valsSide 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 classBio::MAGE::Description::DatabaseEntry
- auditTrail
-
Methods for the
auditTrailassociation.From the MAGE-OM documentation:
A list of Audit instances that track changes to the instance of Describable.
- $array_ref = $biosequence->setAuditTrail($array_ref)
-
The restricted setter method for the
auditTrailassociation.Input parameters: the value to which the
auditTrailassociation will be set : a reference to an array of objects of typeBio::MAGE::AuditAndSecurity::AuditReturn value: the current value of the
auditTrailassociation : a reference to an array of objects of typeBio::MAGE::AuditAndSecurity::AuditSide effects: none
Exceptions: will call
croak()if no input parameters are specified, or if too many input parameters are specified, or if$array_refis not a reference to an array classBio::MAGE::AuditAndSecurity::Auditinstances - $array_ref = $biosequence->getAuditTrail()
-
The restricted getter method for the
auditTrailassociation.Input parameters: none
Return value: the current value of the
auditTrailassociation : a reference to an array of objects of typeBio::MAGE::AuditAndSecurity::AuditSide effects: none
Exceptions: will call
croak()if any input parameters are specified - $val = $biosequence->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
@valsto add to the auditTrail association. NOTE: submitting a single value is permitted.Return value: the number of items stored in the slot after adding
@valsSide 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 classBio::MAGE::AuditAndSecurity::Audit
- propertySets
-
Methods for the
propertySetsassociation.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 = $biosequence->setPropertySets($array_ref)
-
The restricted setter method for the
propertySetsassociation.Input parameters: the value to which the
propertySetsassociation will be set : a reference to an array of objects of typeBio::MAGE::NameValueTypeReturn value: the current value of the
propertySetsassociation : a reference to an array of objects of typeBio::MAGE::NameValueTypeSide effects: none
Exceptions: will call
croak()if no input parameters are specified, or if too many input parameters are specified, or if$array_refis not a reference to an array classBio::MAGE::NameValueTypeinstances - $array_ref = $biosequence->getPropertySets()
-
The restricted getter method for the
propertySetsassociation.Input parameters: none
Return value: the current value of the
propertySetsassociation : a reference to an array of objects of typeBio::MAGE::NameValueTypeSide effects: none
Exceptions: will call
croak()if any input parameters are specified - $val = $biosequence->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
@valsto add to the propertySets association. NOTE: submitting a single value is permitted.Return value: the number of items stored in the slot after adding
@valsSide 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 classBio::MAGE::NameValueType
- species
-
Methods for the
speciesassociation.From the MAGE-OM documentation:
The organism from which this sequence was obtained.
- $val = $biosequence->setSpecies($val)
-
The restricted setter method for the
speciesassociation.Input parameters: the value to which the
speciesassociation will be set : one of the accepted enumerated values.Return value: the current value of the
speciesassociation : 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$valis not an instance of classBio::MAGE::Description::OntologyEntry - $val = $biosequence->getSpecies()
-
The restricted getter method for the
speciesassociation.Input parameters: none
Return value: the current value of the
speciesassociation : an instance of typeBio::MAGE::Description::OntologyEntry.Side effects: none
Exceptions: will call
croak()if any input parameters are specified
- polymerType
-
Methods for the
polymerTypeassociation.From the MAGE-OM documentation:
A choice of protein, RNA, or DNA.
- $val = $biosequence->setPolymerType($val)
-
The restricted setter method for the
polymerTypeassociation.Input parameters: the value to which the
polymerTypeassociation will be set : one of the accepted enumerated values.Return value: the current value of the
polymerTypeassociation : 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$valis not an instance of classBio::MAGE::Description::OntologyEntry - $val = $biosequence->getPolymerType()
-
The restricted getter method for the
polymerTypeassociation.Input parameters: none
Return value: the current value of the
polymerTypeassociation : an instance of typeBio::MAGE::Description::OntologyEntry.Side effects: none
Exceptions: will call
croak()if any input parameters are specified
- ontologyEntries
-
Methods for the
ontologyEntriesassociation.From the MAGE-OM documentation:
Ontology entries referring to common values associated with BioSequences, such as gene names, go ids, etc.
- $array_ref = $biosequence->setOntologyEntries($array_ref)
-
The restricted setter method for the
ontologyEntriesassociation.Input parameters: the value to which the
ontologyEntriesassociation will be set : a reference to an array of objects of typeBio::MAGE::Description::OntologyEntryReturn value: the current value of the
ontologyEntriesassociation : a reference to an array of objects of typeBio::MAGE::Description::OntologyEntrySide effects: none
Exceptions: will call
croak()if no input parameters are specified, or if too many input parameters are specified, or if$array_refis not a reference to an array classBio::MAGE::Description::OntologyEntryinstances - $array_ref = $biosequence->getOntologyEntries()
-
The restricted getter method for the
ontologyEntriesassociation.Input parameters: none
Return value: the current value of the
ontologyEntriesassociation : a reference to an array of objects of typeBio::MAGE::Description::OntologyEntrySide effects: none
Exceptions: will call
croak()if any input parameters are specified - $val = $biosequence->addOntologyEntries(@vals)
-
Because the ontologyEntries association has list cardinality, it may store more than one value. This method adds the current list of objects in the ontologyEntries association.
Input parameters: the list of values
@valsto add to the ontologyEntries association. NOTE: submitting a single value is permitted.Return value: the number of items stored in the slot after adding
@valsSide 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 classBio::MAGE::Description::OntologyEntry
- seqFeatures
-
Methods for the
seqFeaturesassociation.From the MAGE-OM documentation:
Association to annotations for subsequences. Corresponds to the GenBank Frame Table.
- $array_ref = $biosequence->setSeqFeatures($array_ref)
-
The restricted setter method for the
seqFeaturesassociation.Input parameters: the value to which the
seqFeaturesassociation will be set : a reference to an array of objects of typeBio::MAGE::BioSequence::SeqFeatureReturn value: the current value of the
seqFeaturesassociation : a reference to an array of objects of typeBio::MAGE::BioSequence::SeqFeatureSide effects: none
Exceptions: will call
croak()if no input parameters are specified, or if too many input parameters are specified, or if$array_refis not a reference to an array classBio::MAGE::BioSequence::SeqFeatureinstances - $array_ref = $biosequence->getSeqFeatures()
-
The restricted getter method for the
seqFeaturesassociation.Input parameters: none
Return value: the current value of the
seqFeaturesassociation : a reference to an array of objects of typeBio::MAGE::BioSequence::SeqFeatureSide effects: none
Exceptions: will call
croak()if any input parameters are specified - $val = $biosequence->addSeqFeatures(@vals)
-
Because the seqFeatures association has list cardinality, it may store more than one value. This method adds the current list of objects in the seqFeatures association.
Input parameters: the list of values
@valsto add to the seqFeatures association. NOTE: submitting a single value is permitted.Return value: the number of items stored in the slot after adding
@valsSide 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 classBio::MAGE::BioSequence::SeqFeature
- descriptions
-
Methods for the
descriptionsassociation.From the MAGE-OM documentation:
Free hand text descriptions. Makes available the associations of Description to an instance of Describable.
- $array_ref = $biosequence->setDescriptions($array_ref)
-
The restricted setter method for the
descriptionsassociation.Input parameters: the value to which the
descriptionsassociation will be set : a reference to an array of objects of typeBio::MAGE::Description::DescriptionReturn value: the current value of the
descriptionsassociation : a reference to an array of objects of typeBio::MAGE::Description::DescriptionSide effects: none
Exceptions: will call
croak()if no input parameters are specified, or if too many input parameters are specified, or if$array_refis not a reference to an array classBio::MAGE::Description::Descriptioninstances - $array_ref = $biosequence->getDescriptions()
-
The restricted getter method for the
descriptionsassociation.Input parameters: none
Return value: the current value of the
descriptionsassociation : a reference to an array of objects of typeBio::MAGE::Description::DescriptionSide effects: none
Exceptions: will call
croak()if any input parameters are specified - $val = $biosequence->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
@valsto add to the descriptions association. NOTE: submitting a single value is permitted.Return value: the number of items stored in the slot after adding
@valsSide 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 classBio::MAGE::Description::Description
- security
-
Methods for the
securityassociation.From the MAGE-OM documentation:
Information on the security for the instance of the class.
- $val = $biosequence->setSecurity($val)
-
The restricted setter method for the
securityassociation.Input parameters: the value to which the
securityassociation will be set : one of the accepted enumerated values.Return value: the current value of the
securityassociation : 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$valis not an instance of classBio::MAGE::AuditAndSecurity::Security - $val = $biosequence->getSecurity()
-
The restricted getter method for the
securityassociation.Input parameters: none
Return value: the current value of the
securityassociation : an instance of typeBio::MAGE::AuditAndSecurity::Security.Side effects: none
Exceptions: will call
croak()if any input parameters are specified
- type
-
Methods for the
typeassociation.From the MAGE-OM documentation:
The type of biosequence, i.e. gene, exon, UniGene cluster, fragment, BAC, EST, etc.
- $val = $biosequence->setType($val)
-
The restricted setter method for the
typeassociation.Input parameters: the value to which the
typeassociation will be set : one of the accepted enumerated values.Return value: the current value of the
typeassociation : 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$valis not an instance of classBio::MAGE::Description::OntologyEntry - $val = $biosequence->getType()
-
The restricted getter method for the
typeassociation.Input parameters: none
Return value: the current value of the
typeassociation : an instance of typeBio::MAGE::Description::OntologyEntry.Side effects: none
Exceptions: will call
croak()if any input parameters are specified
sub initialize {
my $self = shift; return 1;}
SLOTS, ATTRIBUTES, AND ASSOCIATIONS
In the Perl implementation of MAGE-OM classes, there are three types of class data members: slots, attributes, and associations.
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. 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.
ATTRIBUTES AND ASSOCIATIONS
The terms attribute and association indicate data members of the class that were specified directly from the UML model.
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)
AUTHOR
Jason E. Stewart (jasons 'at' cpan 'dot' org)
SEE ALSO
perl(1).
5 POD Errors
The following errors were encountered while parsing the POD:
- Around line 550:
'=item' outside of any '=over'
- Around line 635:
You forgot a '=back' before '=head2'
- Around line 1097:
Expected '=item 2'
- Around line 1102:
Expected '=item 3'
- Around line 1107:
Expected '=item 4'