File Coverage

blib/lib/Lingua/Thesaurus/RelType.pm
Criterion Covered Total %
statement 6 6 100.0
branch n/a
condition n/a
subroutine 2 2 100.0
pod n/a
total 8 8 100.0


line stmt bran cond sub pod time code
1             package Lingua::Thesaurus::RelType;
2 1     1   761 use Moose;
  1         1  
  1         6  
3 1     1   4675 use namespace::clean -except => 'meta';
  1         3  
  1         10  
4              
5             has 'rel_id' => (is => 'ro', isa => 'Str', required => 1,
6             documentation => "identifier for the relation type");
7              
8             has 'description' => (is => 'ro', isa => 'Str',
9             documentation => "description of the relation");
10              
11             has 'inverse_id' => (is => 'ro', isa => 'Maybe[Str]',
12             documentation => "id of the inverse relation");
13              
14             has 'is_external' => (is => 'ro', isa => 'Bool',
15             documentation => "true if the related item is an external string "
16             . "(i.e. not a term)");
17              
18             1;
19              
20             __END__
21              
22             =head1 NAME
23              
24             Lingua::Thesaurus::RelType - Relation type in a thesaurus
25              
26             =head1 DESCRITION
27              
28             A C<RelType> object is just a datastructure with the following
29             fields:
30              
31             =over
32              
33             =item rel_id
34              
35             String, unique identifier for this relation type (e.g. 'NT', 'BT', 'RT', etc.)
36              
37             =item description
38              
39             Description string for this relation type
40              
41             =item inverse_id
42              
43             Unique identifier for the reciprocal relation, if any.
44              
45             =item is_external
46              
47             Boolean stating whether the item related to the lead term is another term,
48             or is some external data (for example a "Scope Note").
49              
50             =back
51              
52