• Bio::MAGE::Description::Description
• SYNOPSIS
• DESCRIPTION
• INHERITANCE
• CLASS METHODS
• ATTRIBUTES
• ASSOCIATIONS
• BUGS
• AUTHOR
• SEE ALSO

Bio::MAGE::Description::Description

SYNOPSIS

  use Bio::MAGE::Description::Description;

    # creating an empty instance
  my $description = Bio::MAGE::Description::Description->new();

    # creating an already populated instance
  my $description = Bio::MAGE::Description::Description->new(URI=>$URI_value,
                        text=>$text_value,
                        databaseReferences=>$databaseReferences_value,
                        externalReference=>$externalReference_value,
                        bibliographicReferences=>$bibliographicReferences_value,
                        annotations=>$annotations_value);

    # setting and retrieving object attributes
  my $URI_val = $description->URI();
  $description->URI($value);

  my $text_val = $description->text();
  $description->text($value);

    # setting and retrieving object associations
  my $databaseReferences_val = $description->databaseReferences();
  $description->databaseReferences($value);

  my $externalReference_val = $description->externalReference();
  $description->externalReference($value);

  my $bibliographicReferences_val = $description->bibliographicReferences();
  $description->bibliographicReferences($value);

  my $annotations_val = $description->annotations();
  $description->annotations($value);

DESCRIPTION

From the MAGE-OM documentation for the Description class:

A free text description of an object.

INHERITANCE

Bio::MAGE::Description::Description has the following super classes

• Bio::MAGE::Describable
  

CLASS METHODS

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

new()

new(%args)

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

• URI
  Sets the value of the URI attribute (from Bio::MAGE::Description::Description).

• text
  Sets the value of the text attribute (from Bio::MAGE::Description::Description).

• databaseReferences
  Sets the value of the databaseReferences association (from Bio::MAGE::Description::Description).

• externalReference
  Sets the value of the externalReference association (from Bio::MAGE::Description::Description).

• bibliographicReferences
  Sets the value of the bibliographicReferences association (from Bio::MAGE::Description::Description).

• annotations
  Sets the value of the annotations association (from Bio::MAGE::Description::Description).

• security
  Sets the value of the security association (from Bio::MAGE::Describable).

• auditTrail
  Sets the value of the auditTrail association (from Bio::MAGE::Describable).

• descriptions
  Sets the value of the descriptions association (from Bio::MAGE::Describable).

• propertySets
  Sets the value of the propertySets association (from Bio::MAGE::Extendable).

$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->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

@names = $obj->get_slot_names()

The get_slot_names() method is used to retrieve the name of all slots defined for a given object.

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

Side effects: none

$name = class_name()

Returns the full class name for this class, Bio::MAGE::Description::Description.

$package_name = package()

Returns the unresolved package name (i.e. no 'Bio::MAGE::') of the package that contains class, Bio::MAGE::Description::Description.

@classes = subclasses()

returns the list of subclasses for this class.

@classes = superclasses()

returns the list of superclasses for this class.

@methods = attribute_methods()

returns the list of attribute accessor methods for this class.

@methods = association_methods()

returns the list of association accessor methods for this class.

%assns = associations()

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

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::Description::Description: has the following attribute accessor methods:

URI

From the MAGE-OM documentation for the URI attribute:

A reference to the location and type of an outside resource.

$val = $description->setURI($val)

The restricted setter method for the URI attribute.

Input parameters: the value to which the URI attribute will be set

Return value: the current value of the URI attribute

Side effects: none

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

$val = $description->getURI()

The restricted getter method for the URI attribute.

Input parameters: none

Return value: the current value of the URI attribute

Side effects: none

Exceptions: will call croak() if any input parameters are specified

text

From the MAGE-OM documentation for the text attribute:

The description.

$val = $description->setText($val)

The restricted setter method for the text attribute.

Input parameters: the value to which the text attribute will be set

Return value: the current value of the text attribute

Side effects: none

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

$val = $description->getText()

The restricted getter method for the text attribute.

Input parameters: none

Return value: the current value of the text attribute

Side effects: none

Exceptions: will call croak() if any input parameters are specified

ASSOCIATIONS

Associations are references to other class objects which can be shared by multiple class instances at the same time. In the Perl implementation of MAGE-OM classes, associations are implemented using three separate methods:

get*

Retrieves the current value. If the association has list cardinality, an array reference is returned.

set*

Sets the current value replacing any existing value. If the association has list cardinality, the argument must be an array reference. Unless you know what you are doing, you probably should be using the add* methods.

add*

This method exists only for associations with list cardinality. It appends a list of objects to any values that may already be stored in the association.

Bio::MAGE::Description::Description: has the following association accessor methods:

databaseReferences

From the MAGE-OM documentation for the databaseReferences association:

References to entries in databases.

$array_ref = $description->setDatabaseReferences($array_ref)

The restricted setter method for the databaseReferences association.

Input parameters: the value to which the databaseReferences association will be set : a reference to an array of objects of type Bio::MAGE::Description::DatabaseEntry

Return value: the current value of the databaseReferences association : a reference to an array of objects of type Bio::MAGE::Description::DatabaseEntry

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::DatabaseEntry instances

$array_ref = $description->getDatabaseReferences()

The restricted getter method for the databaseReferences association.

Input parameters: none

Return value: the current value of the databaseReferences association : a reference to an array of objects of type Bio::MAGE::Description::DatabaseEntry

Side effects: none

Exceptions: will call croak() if any input parameters are specified

$description->addDatabaseReferences(@vals)

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

Input parameters: the list of values @vals to add to the databaseReferences association. NOTE: submitting a single value is permitted.

Return value: none

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::DatabaseEntry

externalReference

From the MAGE-OM documentation for the externalReference association:

Specifies where the described instance was originally obtained from.

$val = $description->setExternalReference($val)

The restricted setter method for the externalReference association.

Input parameters: the value to which the externalReference association will be set : an instance of type Bio::MAGE::Description::ExternalReference.

Return value: the current value of the externalReference association : an instance of type Bio::MAGE::Description::ExternalReference.

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::ExternalReference

$val = $description->getExternalReference()

The restricted getter method for the externalReference association.

Input parameters: none

Return value: the current value of the externalReference association : an instance of type Bio::MAGE::Description::ExternalReference.

Side effects: none

Exceptions: will call croak() if any input parameters are specified

bibliographicReferences

From the MAGE-OM documentation for the bibliographicReferences association:

References to existing literature.

$array_ref = $description->setBibliographicReferences($array_ref)

The restricted setter method for the bibliographicReferences association.

Input parameters: the value to which the bibliographicReferences association will be set : a reference to an array of objects of type Bio::MAGE::BQS::BibliographicReference

Return value: the current value of the bibliographicReferences association : a reference to an array of objects of type Bio::MAGE::BQS::BibliographicReference

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::BQS::BibliographicReference instances

$array_ref = $description->getBibliographicReferences()

The restricted getter method for the bibliographicReferences association.

Input parameters: none

Return value: the current value of the bibliographicReferences association : a reference to an array of objects of type Bio::MAGE::BQS::BibliographicReference

Side effects: none

Exceptions: will call croak() if any input parameters are specified

$description->addBibliographicReferences(@vals)

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

Input parameters: the list of values @vals to add to the bibliographicReferences association. NOTE: submitting a single value is permitted.

Return value: none

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::BQS::BibliographicReference

annotations

From the MAGE-OM documentation for the annotations association:

Allows specification of ontology entries related to the instance being described.

$array_ref = $description->setAnnotations($array_ref)

The restricted setter method for the annotations association.

Input parameters: the value to which the annotations association will be set : a reference to an array of objects of type Bio::MAGE::Description::OntologyEntry

Return value: the current value of the annotations 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 = $description->getAnnotations()

The restricted getter method for the annotations association.

Input parameters: none

Return value: the current value of the annotations 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

$description->addAnnotations(@vals)

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

Input parameters: the list of values @vals to add to the annotations association. NOTE: submitting a single value is permitted.

Return value: none

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

Associations Inherited from Bio::MAGE::Describable

security

From the MAGE-OM documentation for the security association:

Information on the security for the instance of the class.

$val = $describable->setSecurity($val)

The restricted setter method for the security association.

Input parameters: the value to which the security association will be set : an instance of type Bio::MAGE::AuditAndSecurity::Security.

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 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 = $describable->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

auditTrail

From the MAGE-OM documentation for the auditTrail association:

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

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

$describable->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: none

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

descriptions

From the MAGE-OM documentation for the descriptions association:

Free hand text descriptions. Makes available the associations of Description to an instance of Describable.

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

$describable->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: none

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

Associations Inherited from Bio::MAGE::Extendable

propertySets

From the MAGE-OM documentation for the propertySets association:

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 = $extendable->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 = $extendable->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

$extendable->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: none

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

BUGS

Please send bug reports to mged-mage@lists.sf.net

AUTHOR

Jason E. Stewart (www.openinformatics.com)

SEE ALSO

perl(1).