view release on metacpan or  search on metacpan

lib/Lingua/YaTeA/Document.pm  view on Meta::CPAN

package Lingua::YaTeA::Document;
use strict;
use warnings;

our $counter = 0;

our $VERSION=$Lingua::YaTeA::VERSION;

sub new
{
    my ($class,$word) = @_;
    my $this = {};
    bless ($this,$class);
    $this->{ID} = $counter;
    $this->{NAME} = $word->getLexItem->getIF;
    return $this;
}

sub newDefault
{
    my ($class,$word) = @_;
    my $this = {};
    bless ($this,$class);
    $this->{ID} = 0;
    $this->{NAME} = "no_name";
    return $this;
}

sub getID
{
    my ($this) = @_;
    return $this->{ID};
}

sub getName
{
    my ($this) = @_;
    return $this->{NAME};

}

sub update
{
    my ($this,$word) = @_;
    $this->{NAME} = $word->getLexItem->getIF;
}

1;

__END__

=head1 NAME

Lingua::YaTeA::Document - Perl extension for words of input document 

=head1 SYNOPSIS

  use Lingua::YaTeA::Document;
  Lingua::YaTeA::Document->new($word);

=head1 DESCRIPTION

The module manages the words of an input documents. The identifier of
the document is stored in the attribut C<ID>. The attribut C<NAME>
contains the inflected form of the word.

=head1 METHODS

=head2 new()

    new($word);

The method creates a objet storing a word C<$WORD> and associated it
the current document. 

=head2 newDefault()

    newDefault($word);

The method creates a empty objet, without any reference to a document.


=head2 getID()

    getID();

The method returns the identifier of the document.


=head2 getName()

    getName();

The method returns the inflected form of the word.

=head2 update()

    update($word);

The method updates the attribut C<NAME> (the inflected form) of the object.

=head1 SEE ALSO