#!/usr/local/bin/perl -w

################################################################################
# * 
# * Copyright Jean-Marc Aury / Institut de Genomique / DSV / CEA  
# *                            <jmaury@genoscope.cns.fr>
# *
# * 
# * This software is governed by the CeCILL license under French law and
# * abiding by the rules of distribution of free software.  You can  use, 
# * modify and/ or redistribute the software under the terms of the CeCILL
# * license as circulated by CEA, CNRS and INRIA at the following URL
# * "http://www.cecill.info". 
# * 
# * As a counterpart to the access to the source code and  rights to copy,
# * modify and redistribute granted by the license, users are provided only
# * with a limited warranty  and the software's author,  the holder of the
# * economic rights,  and the successive licensors  have only  limited
# * liability. 
# * 
# * In this respect, the user's attention is drawn to the risks associated
# * with loading,  using,  modifying and/or developing or reproducing the
# * software by the user in light of its specific status of free software,
# * that may mean  that it is complicated to manipulate,  and  that  also
# * therefore means  that it is reserved for developers  and  experienced
# * professionals having in-depth computer knowledge. Users are therefore
# * encouraged to load and test the software's suitability as regards their
# * requirements in conditions enabling the security of their systems and/or 
# * data to be ensured and,  more generally, to use and operate it in the 
# * same conditions as regards security. 
# * 
# * The fact that you are presently reading this means that you have had
# * knowledge of the CeCILL license and that you accept its terms.
################################################################################


=head1 NAME

GeneCollectionIterator - Structure 

=head1 AUTHORS

2005, Genoscope - CNS, Jean-Marc Aury, jmaury@genoscope.cns.fr

=cut

package LibAnnotation::Ortho::GeneCollectionIterator;

sub new {
    my $proto = shift;
    my $class = ref($proto) || $proto;
    my $self = {};
    bless $self, $class;
    $self->_organize(shift);
    $self->_currentIdx(0);
    return $self;
}

sub _list {
    my ($self, $arg) = @_;
    if(defined $arg) { $self->{'list'} = $arg; }
    else { return $self->{'list'}; }
}

sub _currentIdx {
    my($self, $arg) = @_;
    if(defined $arg) { $self->{'currentIdx'} = $arg; }
    else { return $self->{'currentIdx'}; }
}

sub _organize {
    my($self, $collection) = @_;
    my @list = ();
    foreach my $g (@{$collection->genes()}) { push(@list, $g); }
    $self->_list(\@list);
}

sub next {
    my($self) = @_;
    my $list = $self->_list();
    if($self->_currentIdx() >= scalar(@{$list})) { return 0; }
    else {
	my $elt = $list->[$self->_currentIdx()];
	$self->_currentIdx($self->_currentIdx() + 1);
	return $elt;
    }
}

1;
