NAME

OBO::Core::IDspace - A mapping between a "local" ID space and a "global" ID space

SYNOPSIS

use OBO::Core::IDspace;

use strict;

my $idspace = OBO::Core::IDspace->new();

$idspace->local_idspace("CCO");

$idspace->uri("http://www.cellcycleontology.org/ontology/CCO");

$idspace->description("cell cycle ontology terms);

DESCRIPTION

A mapping between a "local" ID space and a "global" ID space.

AUTHOR

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

COPYRIGHT AND LICENSE

Copyright (C) 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.

local_idspace

Usage    - print $idspace->local_idspace() or $idspace->local_idspace($local_idspace)
Returns  - the lcoal ID space(string)
Args     - the local ID space (string)
Function - gets/sets the local ID space

uri

Usage    - print $idspace->uri() or $idspace->uri($uri)
Returns  - the URI (string) of this ID space
Args     - the URI (string) of this ID space
Function - gets/sets the URI of this ID space

description

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

as_string

Usage    - print $idspace->as_string()
Returns  - returns this idspace (local_idspace uri "description") as string if it is defined; otherwise, undef
Args     - none
Function - returns this idspace as string

equals

Usage    - print $idspace->equals($another_idspace)
Returns  - either 1(true) or 0 (false)
Args     - the idspace(OBO::Core::IDspace) to compare with
Function - tells whether this idspace is equal to the parameter