NAME

Text::Tradition::Collation::Relationship - represents a syntactic or semantic relationship between two readings

DESCRIPTION

Text::Tradition is a library for representation and analysis of collated texts, particularly medieval ones. A relationship connects two readings within a collation, usually when they appear in the same place in different texts.

CONSTRUCTOR

new

Creates a new relationship. Usually called via $collation->add_relationship. Options include:

  • type - Can be one of spelling, orthographic, grammatical, meaning, lexical, collated, repetition, transposition. All but the last two are only valid relationships between readings that occur at the same point in the text.

  • displayform - (Optional) The reading that should be displayed if the related nodes are treated as one.

  • scope - (Optional) A meta-attribute. Can be one of 'local', 'document', or 'global'. Denotes whether the relationship between the two readings holds always, independent of context, either within this tradition or across all traditions.

  • anotation - (Optional) A freeform note to attach to the relationship.

  • non_correctable - (Optional) True if the reading would not have been corrected independently.

  • non_independent - (Optional) True if the variant is unlikely to have occurred independently in unrelated witnesses.

ACCESSORS

type

displayform

scope

annotation

non_correctable

non_independent

See the option descriptions above.

colocated

Returns true if the relationship type is one that requires that its readings occupy the same place in the collation.

nonlocal

Returns true if the relationship scope is anything other than 'local'.