Erick Antezana > ONTO-PERL > OBO::Core::SubsetDef

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

Dependencies

Annotate this POD

CPAN RT

Open  0
View/Report Bugs
Source  

name

  Usage    - print $subset_def->name() or $subset_def->name($name)
  Returns  - the subset def name (string)
  Args     - the subset def name (string)
  Function - gets/sets the subset def name

description

  Usage    - print $subset_def->description() or $subset_def->description($desc)
  Returns  - the subset def description (string)
  Args     - the subset def description (string)
  Function - gets/sets the synonym description

as_string

  Usage    - $subset_def->as_string() or $subset_def->as_string("GO_SLIM", "GO Slim")
  Returns  - the subset def definition (string)
  Args     - the subset def definition (string)
  Function - gets/sets the definition of this synonym

equals

  Usage    - print $subset_def->equals($another_subset_def)
  Returns  - either 1 (true) or 0 (false)
  Args     - the subset def definition to compare with
  Function - tells whether this subset def definition is equal to the given argument (another subset def definition)

NAME ^

OBO::Core::SubsetDef - A description of a term subset. The value for this tag should contain a subset name and a subset description.

SYNOPSIS ^

use OBO::Core::SubsetDef;

use strict;

my $std1 = OBO::Core::SubsetDef->new();

my $std2 = OBO::Core::SubsetDef->new();

# name

$std1->name('GO_SLIM');

$std2->name('APO_SLIM');

# description

$std1->description('GO slim');

$std2->description('APO slim');

# subset def as string

my $std3 = OBO::Core::SubsetDef->new();

$std3->as_string('GO_SLIM', 'GO Slim');

if ($std1->equals($std3)) {

        print "subset 1 is the same as subset 3\n";

}

DESCRIPTION ^

A description of a term subset. The value for this tag should contain a subset name, a space, and a quote enclosed subset description, as follows:

        subsetdef: GO_SLIM "GO Slim"

AUTHOR ^

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

COPYRIGHT AND LICENSE ^

Copyright (c) 2006-2013 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: