/ 
onto-perl-1.03
/ CCO::Util::CCO_ID

NAME

CCO::Util::CCO_ID - A module for describing Cell Cycle Ontology (CCO) identifiers. Its namespace, subnamespace and number are stored.

SYNOPSIS

use CCO::Util::CCO_ID;

$id = CCO_ID->new();

$id->idspace("CCO");

$id->subnamespace("X");

$id->number("0000001");

$idspace = $id->idspace();

$subnamespace = $id->subnamespace();

$number = $id->number();

print $id->id_as_string();

$id->id_as_string("CCO:P1234567");

DESCRIPTION

The CCO::Util::CCO_ID class implements a Cell-Cycle Ontology identifier.

AUTHOR

Erick Antezana, <erant@psb.ugent.be>

COPYRIGHT AND LICENSE

Copyright (C) 2006, 2007 by erant

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.

idspace

Usage    - print $id->idspace() or $id->idspace($idspace)
Returns  - the idspace (string)
Args     - the idspace (string)
Function - gets/sets the idspace

subnamespace

Usage    - print $id->subnamespace() or $id->subnamespace($name)
Returns  - the subnamespace (string)
Args     - the subnamespace (string)
Function - gets/sets the subnamespace

number

Usage    - print $id->number() or $id->number($name)
Returns  - the number (scalar)
Args     - the number (scalar)
Function - gets/sets the number

id_as_string

Usage    - print $id->id_as_string() or $id->id_as_string("CCO:X0000001")
Returns  - the id as string (scalar)
Args     - the id as string
Function - gets/sets the id as string

equals

Usage    - print $id->equals($id)
Returns  - 1 (true) or 0 (false)
Args     - the other ID (CCO::Util::CCO_ID)
Function - tells if the IDs are equal

next_id

Usage    - $id->next_id()
Returns  - the next ID (CCO::Util::CCO_ID)
Args     - none
Function - returns the next ID

previous_id

Usage    - $id->previous_id()
Returns  - the previous ID (CCO::Util::CCO_ID)
Args     - none
Function - returns the previous ID