Commit | Line | Data |
784877d9 |
1 | package Text::Tradition::Collation::Reading; |
2 | |
8e1394aa |
3 | use Moose; |
e4b0f464 |
4 | use overload '""' => \&_stringify, 'fallback' => 1; |
784877d9 |
5 | |
3a2ebbf4 |
6 | =head1 NAME |
784877d9 |
7 | |
3a2ebbf4 |
8 | Text::Tradition::Collation::Reading - represents a reading (usually a word) in a collation. |
eca16057 |
9 | |
3a2ebbf4 |
10 | =head1 DESCRIPTION |
784877d9 |
11 | |
3a2ebbf4 |
12 | Text::Tradition is a library for representation and analysis of collated |
13 | texts, particularly medieval ones. A 'reading' refers to a unit of text, |
14 | usually a word, that appears in one or more witnesses (manuscripts) of the |
15 | tradition; the text of a given witness is composed of a set of readings in |
16 | a particular sequence |
784877d9 |
17 | |
3a2ebbf4 |
18 | =head1 METHODS |
1ca1163d |
19 | |
3a2ebbf4 |
20 | =head2 new |
8e1394aa |
21 | |
3a2ebbf4 |
22 | Creates a new reading in the given collation with the given attributes. |
23 | Options include: |
94c00c71 |
24 | |
3a2ebbf4 |
25 | =over 4 |
784877d9 |
26 | |
3a2ebbf4 |
27 | =item collation - The Text::Tradition::Collation object to which this reading belongs. Required. |
e2902068 |
28 | |
3a2ebbf4 |
29 | =item id - A unique identifier for this reading. Required. |
910a0a6d |
30 | |
3a2ebbf4 |
31 | =item text - The word or other text of the reading. |
784877d9 |
32 | |
3a2ebbf4 |
33 | =item is_start - The reading is the starting point for the collation. |
3265b0ce |
34 | |
3a2ebbf4 |
35 | =item is_end - The reading is the ending point for the collation. |
784877d9 |
36 | |
3a2ebbf4 |
37 | =item is_lacuna - The 'reading' represents a known gap in the text. |
de51424a |
38 | |
12720144 |
39 | =item is_ph - A temporary placeholder for apparatus parsing purposes. Do not use unless you know what you are doing. |
40 | |
3a2ebbf4 |
41 | =item rank - The sequence number of the reading. This should probably not be set manually. |
d047cd52 |
42 | |
3a2ebbf4 |
43 | =back |
8e1394aa |
44 | |
3a2ebbf4 |
45 | One of 'text', 'is_start', 'is_end', or 'is_lacuna' is required. |
8e1394aa |
46 | |
3a2ebbf4 |
47 | =head2 collation |
94c00c71 |
48 | |
3a2ebbf4 |
49 | =head2 id |
94c00c71 |
50 | |
3a2ebbf4 |
51 | =head2 text |
4cdd82f1 |
52 | |
3a2ebbf4 |
53 | =head2 is_start |
4cdd82f1 |
54 | |
3a2ebbf4 |
55 | =head2 is_end |
4a8828f0 |
56 | |
3a2ebbf4 |
57 | =head2 is_lacuna |
4a8828f0 |
58 | |
3a2ebbf4 |
59 | =head2 rank |
4a8828f0 |
60 | |
3a2ebbf4 |
61 | Accessor methods for the given attributes. |
d047cd52 |
62 | |
3a2ebbf4 |
63 | =cut |
d047cd52 |
64 | |
3a2ebbf4 |
65 | has 'collation' => ( |
66 | is => 'ro', |
67 | isa => 'Text::Tradition::Collation', |
68 | # required => 1, |
69 | weak_ref => 1, |
70 | ); |
d047cd52 |
71 | |
3a2ebbf4 |
72 | has 'id' => ( |
73 | is => 'ro', |
74 | isa => 'Str', |
75 | required => 1, |
76 | ); |
d047cd52 |
77 | |
3a2ebbf4 |
78 | has 'text' => ( |
79 | is => 'ro', |
80 | isa => 'Str', |
81 | required => 1, |
49d4f2ac |
82 | writer => 'alter_text', |
3a2ebbf4 |
83 | ); |
0e47f4f6 |
84 | |
3a2ebbf4 |
85 | has 'is_start' => ( |
86 | is => 'ro', |
87 | isa => 'Bool', |
88 | default => undef, |
89 | ); |
90 | |
91 | has 'is_end' => ( |
92 | is => 'ro', |
93 | isa => 'Bool', |
94 | default => undef, |
95 | ); |
96 | |
97 | has 'is_lacuna' => ( |
98 | is => 'ro', |
99 | isa => 'Bool', |
100 | default => undef, |
101 | ); |
12720144 |
102 | |
103 | has 'is_ph' => ( |
104 | is => 'ro', |
105 | isa => 'Bool', |
106 | default => undef, |
107 | ); |
3a2ebbf4 |
108 | |
109 | has 'rank' => ( |
110 | is => 'rw', |
111 | isa => 'Int', |
112 | predicate => 'has_rank', |
113 | ); |
114 | |
115 | |
116 | around BUILDARGS => sub { |
117 | my $orig = shift; |
118 | my $class = shift; |
119 | my $args; |
120 | if( @_ == 1 ) { |
121 | $args = shift; |
122 | } else { |
123 | $args = { @_ }; |
124 | } |
b0b4421a |
125 | |
3a2ebbf4 |
126 | # If one of our special booleans is set, we change the text and the |
127 | # ID to match. |
1d310495 |
128 | if( exists $args->{'is_lacuna'} && !exists $args->{'text'} ) { |
56eefa04 |
129 | $args->{'text'} = '#LACUNA#'; |
3a2ebbf4 |
130 | } elsif( exists $args->{'is_start'} ) { |
131 | $args->{'id'} = '#START#'; # Change the ID to ensure we have only one |
132 | $args->{'text'} = '#START#'; |
133 | $args->{'rank'} = 0; |
134 | } elsif( exists $args->{'is_end'} ) { |
135 | $args->{'id'} = '#END#'; # Change the ID to ensure we have only one |
136 | $args->{'text'} = '#END#'; |
12720144 |
137 | } elsif( exists $args->{'is_ph'} ) { |
138 | $args->{'text'} = $args->{'id'}; |
3a2ebbf4 |
139 | } |
140 | |
141 | $class->$orig( $args ); |
142 | }; |
143 | |
144 | =head2 is_meta |
145 | |
146 | A meta attribute (ha ha), which should be true if any of our 'special' |
147 | booleans are true. Implies that the reading does not represent a bit |
148 | of text found in a witness. |
149 | |
150 | =cut |
151 | |
152 | sub is_meta { |
153 | my $self = shift; |
12720144 |
154 | return $self->is_start || $self->is_end || $self->is_lacuna || $self->is_ph; |
3a2ebbf4 |
155 | } |
156 | |
157 | # Some syntactic sugar |
158 | sub related_readings { |
159 | my $self = shift; |
160 | return $self->collation->related_readings( $self, @_ ); |
161 | } |
162 | |
22222af9 |
163 | sub predecessors { |
164 | my $self = shift; |
165 | my @pred = $self->collation->sequence->predecessors( $self->id ); |
166 | return map { $self->collation->reading( $_ ) } @pred; |
167 | } |
168 | |
169 | sub successors { |
170 | my $self = shift; |
171 | my @succ = $self->collation->sequence->successors( $self->id ); |
172 | return map { $self->collation->reading( $_ ) } @succ; |
173 | } |
174 | |
1d310495 |
175 | sub set_identical { |
176 | my( $self, $other ) = @_; |
177 | return $self->collation->add_relationship( $self, $other, |
178 | { 'type' => 'transposition' } ); |
179 | } |
180 | |
3a2ebbf4 |
181 | sub _stringify { |
182 | my $self = shift; |
183 | return $self->id; |
184 | } |
d047cd52 |
185 | |
021bdbac |
186 | no Moose; |
187 | __PACKAGE__->meta->make_immutable; |
d047cd52 |
188 | |
021bdbac |
189 | 1; |
d047cd52 |
190 | |