The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
Text-Tradition-2.1.0
River stage one • 2 direct dependents • 2 total dependents
++
/ Text::Tradition::Collation::Reading

NAME

Text::Tradition::Collation::Reading - represents a reading (usually a word) in a collation.

DESCRIPTION

Text::Tradition is a library for representation and analysis of collated texts, particularly medieval ones. A 'reading' refers to a unit of text, usually a word, that appears in one or more witnesses (manuscripts) of the tradition; the text of a given witness is composed of a set of readings in a particular sequence

METHODS

new

Creates a new reading in the given collation with the given attributes. Options include:

collation - The Text::Tradition::Collation object to which this reading belongs. Required.
id - A unique identifier for this reading. Required.
text - The word or other text of the reading.
is_lemma - The reading serves as a lemma for the constructed text.
is_start - The reading is the starting point for the collation.
is_end - The reading is the ending point for the collation.
is_lacuna - The 'reading' represents a known gap in the text.
is_ph - A temporary placeholder for apparatus parsing purposes. Do not use unless you know what you are doing.
rank - The sequence number of the reading. This should probably not be set manually.

One of 'text', 'is_start', 'is_end', or 'is_lacuna' is required.

collation

id

text

is_lemma

is_start

is_end

is_lacuna

rank( $new_rank )

Accessor methods for the given attributes.

alter_text

Changes the text of the reading.

make_lemma

Sets this reading as a lemma for the constructed text.

is_meta

A meta attribute (ha ha), which should be true if any of our 'special' booleans are true. Implies that the reading does not represent a bit of text found in a witness.

is_identical( $other_reading )

Returns true if the reading is identical to the other reading. The basic test is equality of ->text attributes, but this may be wrapped or overridden by extensions.

is_combinable

Returns true if the reading may in theory be combined into a multi-reading segment within the collation graph. The reading must not be a meta reading, and it must not have any relationships in its own right with any others. This test may be wrapped or overridden by extensions.

Convenience methods

Calls Collation's related_readings with $self as the first argument.

witnesses

Calls Collation's reading_witnesses with $self as the first argument.

predecessors

Returns a list of Reading objects that immediately precede $self in the collation.

successors

Returns a list of Reading objects that immediately follow $self in the collation.