##############################
#
# Bio::MAGE::Protocol
#
##############################
# C O P Y R I G H T   N O T I C E
#  Copyright (c) 2001-2006 by:
#    * The MicroArray Gene Expression Database Society (MGED)
#
# Permission is hereby granted, free of charge, to any person
# obtaining a copy of this software and associated documentation files
# (the "Software"), to deal in the Software without restriction,
# including without limitation the rights to use, copy, modify, merge,
# publish, distribute, sublicense, and/or sell copies of the Software,
# and to permit persons to whom the Software is furnished to do so,
# subject to the following conditions:
#
# The above copyright notice and this permission notice shall be
# included in all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
# BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
# ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.



package Bio::MAGE::Protocol;

use strict;

use base qw(Bio::MAGE::Base);

use Carp;
use Tie::IxHash;

use vars qw($__XML_LISTS);

use Bio::MAGE::Protocol::Protocol;
use Bio::MAGE::Protocol::Parameter;
use Bio::MAGE::Protocol::ParameterValue;
use Bio::MAGE::Protocol::ProtocolApplication;
use Bio::MAGE::Protocol::Software;
use Bio::MAGE::Protocol::Hardware;
use Bio::MAGE::Protocol::HardwareApplication;
use Bio::MAGE::Protocol::SoftwareApplication;
use Bio::MAGE::Protocol::Parameterizable;
use Bio::MAGE::Protocol::ParameterizableApplication;


=head1 NAME

Bio::MAGE::Protocol - Container module for classes in the MAGE package: Protocol

=head1 SYNOPSIS

  use Bio::MAGE::Protocol;

=head1 DESCRIPTION

This is a I<package> module that encapsulates a number of classes in
the Bio::MAGE hierarchy. These classes belong to the
Protocol package of the MAGE-OM object model.

=head1 CLASSES

The Bio::MAGE::Protocol module contains the following
Bio::MAGE classes:

=over


=item * Protocol


=item * Parameter


=item * ParameterValue


=item * ProtocolApplication


=item * Software


=item * Hardware


=item * HardwareApplication


=item * SoftwareApplication


=item * Parameterizable


=item * ParameterizableApplication


=back



=head1 CLASS METHODS

=over

=item @class_list = Bio::MAGE::Protocol::classes();

This method returns a list of non-fully qualified class names
(i.e. they do not have 'Bio::MAGE::' as a prefix) in this package.

=cut

sub classes {
  return ('Protocol','Parameter','ParameterValue','ProtocolApplication','Software','Hardware','HardwareApplication','SoftwareApplication','Parameterizable','ParameterizableApplication');
}





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

The C<new()> method is the class constructor.

B<Parameters>: if given a list of name/value parameters the
corresponding slots, attributes, or associations will have their
initial values set by the constructor.

B<Return value>: It returns a reference to an object of the class.

B<Side effects>: It invokes the C<initialize()> method if it is defined
by the class.

=cut

#
# code for new() inherited from Base.pm
#

=item @names = class->get_slot_names()

The C<get_slot_names()> method is used to retrieve the name of all
slots defined in a given class.

B<NOTE>: the list of names does not include attribute or association
names.

B<Return value>: A list of the names of all slots defined for this class.

B<Side effects>: none

=cut

#
# code for get_slot_names() inherited from Base.pm
#

=item @name_list = get_attribute_names()

returns the list of attribute data members for this class.

=cut

#
# code for get_attribute_names() inherited from Base.pm
#

=item @name_list = get_association_names()

returns the list of association data members for this class.

=cut

#
# code for get_association_names() inherited from Base.pm
#

=item @class_list = get_superclasses()

returns the list of superclasses for this class.

=cut

#
# code for get_superclasses() inherited from Base.pm
#

=item @class_list = get_subclasses()

returns the list of subclasses for this class.

=cut

#
# code for get_subclasses() inherited from Base.pm
#

=item $name = class_name()

Returns the full class name for this class.

=cut

#
# code for class_name() inherited from Base.pm
#

=item $package_name = package_name()

Returns the base package name (i.e. no 'namespace::') of the package
that contains this class.

=cut

#
# code for package_name() inherited from Base.pm
#

=item %assns = associations()

returns the association meta-information in a hash where the keys are
the association names and the values are C<Association> objects that
provide the meta-information for the association.

=cut

#
# code for associations() inherited from Base.pm
#



=back

=head1 INSTANCE METHODS

=over

=cut

=item $obj_copy = $obj->new()

When invoked with an existing object reference and not a class name,
the C<new()> method acts as a copy constructor - with the new object's
initial values set to be those of the existing object.

B<Parameters>: No input parameters  are used in the copy  constructor,
the initial values are taken directly from the object to be copied.

B<Return value>: It returns a reference to an object of the class.

B<Side effects>: It invokes the C<initialize()> method if it is defined
by the class.

=cut

#
# code for new() inherited from Base.pm
#

=item $obj->set_slots(%parameters)

=item $obj->set_slots(\@name_list, \@value_list)

The C<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.

B<Return value>: none

B<Side effects>: will call C<croak()> if a slot_name is used that the class
does not define.

=cut

#
# code for set_slots() inherited from Base.pm
#

=item @obj_list = $obj->get_slots(@name_list)

The C<get_slots()> method is used to get the values of a number of
slots at the same time.

B<Return value>: a list of instance objects

B<Side effects>: none

=cut

#
# code for get_slots() inherited from Base.pm
#

=item $val = $obj->set_slot($name,$val)

The C<set_slot()> method sets the slot C<$name> to the value C<$val>

B<Return value>: the new value of the slot, i.e. C<$val>

B<Side effects>: none

=cut

#
# code for set_slot() inherited from Base.pm
#

=item $val = $obj->get_slot($name)

The C<get_slot()> method is used to get the values of a number of
slots at the same time.

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

B<Side effects>: none

=cut

#
# code for get_slot() inherited from Base.pm
#



=item $val = $protocol->xml_lists()

=item $inval = $protocol->xml_lists($inval)

This is the unified setter/getter method for the xml_lists slot.

If C<$inval> is specified, the setter method is invoked, with no
parameters, the getter method is invoked.

Input parameters: the optional C<$inval> will invoke the setter method.

Return value: for both setter and getter the current value of the xml_lists
slot

Side effects: none

Exceptions: none

=cut


sub xml_lists {
  my $self = shift;
  if (@_) {
    $self->{__XML_LISTS} = shift;
  }
  return $self->{__XML_LISTS};
}





=item $val = $protocol->tagname()

=item $inval = $protocol->tagname($inval)

This is the unified setter/getter method for the tagname slot.

If C<$inval> is specified, the setter method is invoked, with no
parameters, the getter method is invoked.

Input parameters: the optional C<$inval> will invoke the setter method.

Return value: for both setter and getter the current value of the tagname
slot

Side effects: none

Exceptions: none

=cut


sub tagname {
  my $self = shift;
  if (@_) {
    $self->{__TAGNAME} = shift;
  }
  return $self->{__TAGNAME};
}





=item $val = $protocol->hardware_list()

=item $inval = $protocol->hardware_list($inval)

This is the unified setter/getter method for the hardware_list slot.

If C<$inval> is specified, the setter method is invoked, with no
parameters, the getter method is invoked.

Input parameters: the optional C<$inval> will invoke the setter method.

Return value: for both setter and getter the current value of the hardware_list
slot

Side effects: none

Exceptions: none

=cut


sub hardware_list {
  my $self = shift;
  if (@_) {
    $self->{__HARDWARE_LIST} = shift;
  }
  return $self->{__HARDWARE_LIST};
}





=item $val = $protocol->software_list()

=item $inval = $protocol->software_list($inval)

This is the unified setter/getter method for the software_list slot.

If C<$inval> is specified, the setter method is invoked, with no
parameters, the getter method is invoked.

Input parameters: the optional C<$inval> will invoke the setter method.

Return value: for both setter and getter the current value of the software_list
slot

Side effects: none

Exceptions: none

=cut


sub software_list {
  my $self = shift;
  if (@_) {
    $self->{__SOFTWARE_LIST} = shift;
  }
  return $self->{__SOFTWARE_LIST};
}





=item $val = $protocol->protocol_list()

=item $inval = $protocol->protocol_list($inval)

This is the unified setter/getter method for the protocol_list slot.

If C<$inval> is specified, the setter method is invoked, with no
parameters, the getter method is invoked.

Input parameters: the optional C<$inval> will invoke the setter method.

Return value: for both setter and getter the current value of the protocol_list
slot

Side effects: none

Exceptions: none

=cut


sub protocol_list {
  my $self = shift;
  if (@_) {
    $self->{__PROTOCOL_LIST} = shift;
  }
  return $self->{__PROTOCOL_LIST};
}






sub initialize {
  my $self = shift;

  $self->hardware_list([]);
  $self->software_list([]);
  $self->protocol_list([]);

  $self->xml_lists([Hardware=>$self->hardware_list(), Software=>$self->software_list(), Protocol=>$self->protocol_list()]);

  $self->tagname(q[Protocol_package]);
  return 1;
}


=item $array_ref = $protocol->getHardware_list()

This method handles the list for the C<Bio::MAGE::Protocol::Hardware> class. It
returns a reference to an array of the class objects that have been
associated with the package instance.

This is useful when retrieving data from parsed MAGE-ML file.

=cut

sub getHardware_list {
  my $self = shift;
  return $self->hardware_list();
}

=item $protocol->addHardware(@vals)

This method is an interface for adding C<Bio::MAGE::Protocol::Hardware> objects to
the C<hardware_list> list. It is generally used by generic methods such
as those in the XMLWriter.

Input parameters: the list of values C<@vals> to add to the owner
association. B<NOTE>: submitting a single value is permitted.

Return value: none

Side effects: none

Exceptions: will call C<croak()> if no input parameters are specified
, or if any of the objects in @vals is not a subclass of class C<Bio::MAGE::Protocol::Hardware>

=cut

sub addHardware {
  my $self = shift;
  croak(__PACKAGE__ . "::addHardware: no arguments passed to setter")
    unless scalar @_;
  foreach my $val (@_) {
    croak(__PACKAGE__ . "::addHardware: wrong type: " . ref($val) . " expected Bio::MAGE::Protocol::Hardware")
      unless UNIVERSAL::isa($val,'Bio::MAGE::Protocol::Hardware');
  }

  push(@{$self->hardware_list},@_);
}


=item $array_ref = $protocol->getSoftware_list()

This method handles the list for the C<Bio::MAGE::Protocol::Software> class. It
returns a reference to an array of the class objects that have been
associated with the package instance.

This is useful when retrieving data from parsed MAGE-ML file.

=cut

sub getSoftware_list {
  my $self = shift;
  return $self->software_list();
}

=item $protocol->addSoftware(@vals)

This method is an interface for adding C<Bio::MAGE::Protocol::Software> objects to
the C<software_list> list. It is generally used by generic methods such
as those in the XMLWriter.

Input parameters: the list of values C<@vals> to add to the owner
association. B<NOTE>: submitting a single value is permitted.

Return value: none

Side effects: none

Exceptions: will call C<croak()> if no input parameters are specified
, or if any of the objects in @vals is not a subclass of class C<Bio::MAGE::Protocol::Software>

=cut

sub addSoftware {
  my $self = shift;
  croak(__PACKAGE__ . "::addSoftware: no arguments passed to setter")
    unless scalar @_;
  foreach my $val (@_) {
    croak(__PACKAGE__ . "::addSoftware: wrong type: " . ref($val) . " expected Bio::MAGE::Protocol::Software")
      unless UNIVERSAL::isa($val,'Bio::MAGE::Protocol::Software');
  }

  push(@{$self->software_list},@_);
}


=item $array_ref = $protocol->getProtocol_list()

This method handles the list for the C<Bio::MAGE::Protocol::Protocol> class. It
returns a reference to an array of the class objects that have been
associated with the package instance.

This is useful when retrieving data from parsed MAGE-ML file.

=cut

sub getProtocol_list {
  my $self = shift;
  return $self->protocol_list();
}

=item $protocol->addProtocol(@vals)

This method is an interface for adding C<Bio::MAGE::Protocol::Protocol> objects to
the C<protocol_list> list. It is generally used by generic methods such
as those in the XMLWriter.

Input parameters: the list of values C<@vals> to add to the owner
association. B<NOTE>: submitting a single value is permitted.

Return value: none

Side effects: none

Exceptions: will call C<croak()> if no input parameters are specified
, or if any of the objects in @vals is not a subclass of class C<Bio::MAGE::Protocol::Protocol>

=cut

sub addProtocol {
  my $self = shift;
  croak(__PACKAGE__ . "::addProtocol: no arguments passed to setter")
    unless scalar @_;
  foreach my $val (@_) {
    croak(__PACKAGE__ . "::addProtocol: wrong type: " . ref($val) . " expected Bio::MAGE::Protocol::Protocol")
      unless UNIVERSAL::isa($val,'Bio::MAGE::Protocol::Protocol');
  }

  push(@{$self->protocol_list},@_);
}


=item $protocol->obj2xml($writer)

Write out this object, and all sub-objects, as XML using the supplied
$writer to actually do the XML formatting.

Input parameters: $writer must be an XML writer, e.g. an instance of
Bio::MAGE::XML::Writer. It must have methods: write_start_tag(),
write_end_tag(), and obj2xml().

Return value: none

Side effects: all writing is delegated to the $writer - it's
write_start_tag() and write_end_tag() methods are invoked with the
appropriate data, and all class sub-objects of the C<Bio::MAGE::Protocol> instance will have their obj2xml() methods
invoked in turn. By allowing the $writer to do the actual formatting
of the output XML, it enables the user to precisely control the
format.

Exceptions: will call C<croak()> if no identifier has been set for the
C<Bio::MAGE::Protocol> instance.

=cut

sub obj2xml {
  my ($self,$writer) = @_;

  my $empty = 0;
  my $tag = $self->tagname();
  $writer->write_start_tag($tag,$empty);

  # we use IxHash because we need to preserve insertion order
  tie my %list_hash, 'Tie::IxHash', @{$self->xml_lists()};
  foreach my $list_name (keys %list_hash) {
    if (scalar @{$list_hash{$list_name}}) {
      my $tag = $list_name . '_assnlist';
      $writer->write_start_tag($tag,$empty);
      foreach my $obj (@{$list_hash{$list_name}}) {
	# this may seem a little odd, but the writer knows how to
	# write out the objects - this allows you to create your own
	# subclass of Bio::MAGE::XML::Writer and modify
	# the output of the obj2xml process
	$writer->obj2xml($obj);
      }
      $writer->write_end_tag($tag);
    }
  }

  # and we're done
  $writer->write_end_tag($tag);

}

=item $protocol->register($obj)

Store an object for later writing as XML.

Input parameters: object to be added to the list of registered objects.

Return value: none

Side effects: if $obj needs to be stored by this class, a reference
will be stored in the correct XML list for this class.

Exceptions: none

=cut

sub register {
  my ($self,$obj) = @_;

  # should we have the identifier checking code here??
  my %xml_lists = @{$self->xml_lists()};
  my $list_ref;
  foreach my $class (keys %xml_lists) {
    if ($obj->isa("Bio::MAGE::Protocol::$class")) {
      $list_ref = $xml_lists{$class};
      last;
    }
  }

  return unless defined $list_ref;
  push(@{$list_ref}, $obj);
}





=back

=head1 SLOTS, ATTRIBUTES, AND ASSOCIATIONS

In the Perl implementation of MAGE-OM classes, there are
three types of class data members: C<slots>, C<attributes>, and
C<associations>.

=head2 SLOTS

This API uses the term C<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:

=over

=item $var = $obj->slot_name();

Retrieves the current value of the slot.

=item $new_var = $obj->slot_name($new_var);

Store $new_var in the slot - the return value is also $new_var.

=item @names = $obj->get_slot_names()

Returns the list of all slots in the class.

=back

B<DATA CHECKING>: No data type checking is made for these methods.

=head2 ATTRIBUTES AND ASSOCIATIONS

The terms C<attribute> and C<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:

=over

=item get*

Retrieves the current value.

B<NOTE>: For associations, if the association has list cardinality, an
array reference is returned.

B<DATA CHECKING>: Ensure that no argument is provided.

=item set*

Sets the current value, B<replacing> any existing value.

B<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.

B<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.

=item add*

B<NOTE>: Only present in associations with list cardinality. 

Appends a list of objects to any values that may already be stored
in the association.

B<DATA CHECKING>: Ensure that all arguments are of the correct MAGE-OM class.

=back

=head2 GENERIC METHODS

The unified base class of all MAGE-OM classes, C<Bio::MAGE::Base>, provides a set of generic methods that
will operate on slots, attributes, and associations:

=over

=item $val = $obj->get_slot($name)

=item \@list_ref = $obj->get_slots(@name_list);

=item $val = $obj->set_slot($name,$val)

=item $obj->set_slots(%parameters)

=item $obj->set_slots(\@name_list, \@value_list)

See elsewhere in this page for a detailed description of these
methods.

=back

=cut


=head1 BUGS

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

=head1 AUTHOR

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

=head1 SEE ALSO

perl(1).

=cut

# all perl modules must be true...
1;

