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

Bio::MAGE::Identifiable

SYNOPSIS

  use Bio::MAGE::Identifiable;

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

    # creating an already populated instance
  my $identifiable = Bio::MAGE::Identifiable->new(identifier=>$identifier_value,
                        name=>$name_value);

    # setting and retrieving object attributes
  my $identifier_val = $identifiable->identifier();
  $identifiable->identifier($value);

  my $name_val = $identifiable->name();
  $identifiable->name($value);

DESCRIPTION

From the MAGE-OM documentation for the Identifiable class:

An Identifiable class is one that has an unambiguous reference within the scope. It also has a potentially ambiguous name.

INHERITANCE

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

• Bio::MAGE::Describable
  

Bio::MAGE::Identifiable has the following subclasses

• Bio::MAGE::BioMaterial::Compound
  
• Bio::MAGE::BioEvent::BioEvent
  
• Bio::MAGE::ArrayDesign::DesignElementGroup
  
• Bio::MAGE::QuantitationType::QuantitationType
  
• Bio::MAGE::ArrayDesign::Zone
  
• Bio::MAGE::BioAssayData::BioAssayDimension
  
• Bio::MAGE::BioAssayData::QuantitationTypeDimension
  
• Bio::MAGE::ArrayDesign::ArrayDesign
  
• Bio::MAGE::AuditAndSecurity::Contact
  
• Bio::MAGE::Experiment::FactorValue
  
• Bio::MAGE::BioAssayData::BioAssayData
  
• Bio::MAGE::Array::ArrayManufacture
  
• Bio::MAGE::DesignElement::DesignElement
  
• Bio::MAGE::BioAssayData::DesignElementDimension
  
• Bio::MAGE::Description::Database
  
• Bio::MAGE::Experiment::Experiment
  
• Bio::MAGE::Array::ArrayGroup
  
• Bio::MAGE::AuditAndSecurity::Security
  
• Bio::MAGE::BioAssay::Channel
  
• Bio::MAGE::Protocol::Parameterizable
  
• Bio::MAGE::AuditAndSecurity::SecurityGroup
  
• Bio::MAGE::Array::Array
  
• Bio::MAGE::BioAssay::Image
  
• Bio::MAGE::Protocol::Parameter
  
• Bio::MAGE::BioAssay::BioAssay
  
• Bio::MAGE::HigherLevelAnalysis::BioAssayDataCluster
  
• Bio::MAGE::Experiment::ExperimentalFactor
  
• Bio::MAGE::BioSequence::BioSequence
  
• Bio::MAGE::BioMaterial::BioMaterial
  

CLASS METHODS

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

new()

new(%args)

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

• identifier
  Sets the value of the identifier attribute (from Bio::MAGE::Identifiable).

• name
  Sets the value of the name attribute (from Bio::MAGE::Identifiable).

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

$package_name = package()

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

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

identifier

From the MAGE-OM documentation for the identifier attribute:

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

From the MAGE-OM documentation for the name attribute:

The potentially ambiguous common identifier.

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

BUGS

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

AUTHOR

Jason E. Stewart (www.openinformatics.com)

SEE ALSO

perl(1).