NAME

        Biomoby::Object


SYNOPSIS

        my $object = New Biomoby::Object( $namespace, $type );


DESCRIPTION

        This class aims to facilitate deals with Biomoby object.
        It's an encapsulation of what could be done with ParamParser object.


AUTHORS

 Sebastien.Carrere@toulouse.inra.fr 
 Sebastien.Letort@toulouse.inra.fr


METHODS

Function IsPrimitiveType

        Title      :    IsPrimitiveType
        Usage      :    Biomoby::Object::IsPrimitiveType( $val );
        Prerequiste:    none
        Function   :    check if $val is a primitive Biomoby object type
        Returns    :    a boolean
        Args       :    $val, the value to check
        Error      :    none
        Globals    :    none

Function New

        Title      :    New
        Usage      :    my $obj = New Biomoby::Object( $namespace, $type );
        Prerequiste:    none
        Function   :    Build a PrimaryArticle object
        Returns    :    a Object object
        Args       :    $namespace,     the namespace of the object
                        $type,  the type of the object, must be known by Biomoby
        Error      :    none
        Globals    :    none

Procedure AddFile

        Title      :    AddFile
        Usage      :    my $object = $obj->AddFile( $filename )
        Prerequiste:    none
        Procedure  :    add a filename for the object test
        Args       :    $filename
        Error      :    none
        Globals    :    none

Function ToString

        Title      :    ToString
        Usage      :    my $object = $obj->ToString()
        Prerequiste:    none
        Function   :    represente the object as a string, for debugging purpose
        Returns    :    a string representing the object
        Args       :    none
        Error      :    none
        Globals    :    none

Procedure WrapAndWriteObject

        Title      :    WrapAndWriteObject
        Usage      :    my $object = $obj->WrapAndWriteObject
                                                ( $obj_id, $article_name, $test_dir )
        Prerequiste:    none
        Procedure  :    To launch test procedure, data must be wrapped into moby xml.
                        if the object's type is not primitive, it is wrapped again into a moby:string content.
        Args       :    $obj_id, $article_name, $test_dir
        Error      :    none
        Globals    :    none


NAME

        Biomoby::CollectionObject


SYNOPSIS

        my $collec = New Biomoby::CollectionObject();
        $collec->Add( New Biomoby::Object( @params1 ) );
        $collec->Add( New Biomoby::Object( @params2 ) );
        my @a_ids = $collec->GetIds();
        my $o_object = $collec->Get();


DESCRIPTION

        This class managed a group of objects.
        It provides method to add object, to retrieve one by its id.

Function New

        Title      :    New
        Usage      :    New Biomoby::CollectionObject( );
        Prerequiste:    none
        Function   :    constructor of a collection of objects,
        Returns    :    an object Biomoby::CollectionObject
        Args       :    none
        Error      :    none
        Globals    :    none

Procedure Add

        Title      :    Add
        Usage      :    $collec->Add( $o_object );
        Prerequiste:    $o_object must be an Object : not check is done
        Procedure  :    Add an object into the collection, give it an id
        Args       :    $o_object,      an Object object
        Error      :    none
        Globals    :    none

Function Get

        Title      :    Get
        Usage      :    my $o_object = $collec->Get( $id );
        Prerequiste:    none
        Function   :    retrieve an object given its id
        Returns    :    the Object whose id is $id
        Args       :    $id the id of the object to retreive
        Error      :    none
        Globals    :    none

Function GetIds

        Title      :    GetIds
        Usage      :    my @a_ids = $collec->GetIds();
        Prerequiste:    none
        Function   :    accessor to the ids of objects
        Returns    :    an array of ids
        Args       :    none
        Error      :    none
        Globals    :    none