Erick Antezana > ONTO-PERL-1.41 > OBO::Util::ObjectSet

Download:
ONTO-PERL/ONTO-PERL-1.41.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  1
Open  0
View/Report Bugs
Source  

add

  Usage    - $set->add($element)
  Returns  - the added element
  Args     - the element to be added. It must have an ID
  Function - adds an element to this set

add_all

  Usage    - $set->add_all($ele1, $ele2, $ele3, ...)
  Returns  - the last added id (e.g. an object of type OBO::XO::OBO_ID)
  Args     - the elements to be added
  Function - adds the given elements to this set

remove

  Usage    - $set->remove($element_to_be_removed)
  Returns  - 1 (true) if this set contained the given element
  Args     - element (it must have an ID) to be removed from this set, if present
  Function - removes an element from this set if it is present

contains

  Usage    - $set->contains($id)
  Returns  - 1 (true) or 0 (false)
  Args     - the element (it must have an ID) to look up
  Function - tells if the given ID is in this set

equals

  Usage    - $set->equals($other_set)
  Returns  - 1 (true) or 0 (false)
  Args     - the other set to check with
  Function - tells if this set is equal to the given one

NAME ^

OBO::Util::ObjectSet - An implementation of a set of OBO ontology objects.

SYNOPSIS ^

use OBO::Util::ObjectSet;

$set = OBO::Util::ObjectSet->new();

$id = OBO::XO::OBO_ID->new();

$size = $set->size();

if ($ok) {

        $set->add($term);

} else {

        $set->add($term);
        
        $set->add($relationship);

}

DESCRIPTION ^

The OBO::Util::ObjectSet class implements a set of ontology objects such as Terms, Relationships, etc.

AUTHOR ^

Erick Antezana, <erick.antezana -@- gmail.com>

COPYRIGHT AND LICENSE ^

Copyright (C) 2007, 2008, 2009, 2010 by Erick Antezana

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.8.7 or, at your option, any later version of Perl 5 you may have available.

syntax highlighting: