/ 
Text-Tradition-0.2
River stage one • 2 direct dependents • 2 total dependents
/ Text::Tradition::Collation::RelationshipStore

NAME

Text::Tradition::Collation::RelationshipStore - Keeps track of the relationships between readings in a given collation

DESCRIPTION

Text::Tradition is a library for representation and analysis of collated texts, particularly medieval ones. The RelationshipStore is an internal object of the collation, to keep track of the defined relationships (both specific and general) between readings.

METHODS

new( collation => $collation );

Creates a new relationship store for the given collation.

get_relationship

Return the relationship object, if any, that exists between two readings.

create

Create a new relationship with the given options and return it. Warn and return undef if the relationship cannot be created.

add_scoped_relationship( $rel )

Keep track of relationships defined between specific readings that are scoped non-locally. Key on whichever reading occurs first alphabetically.

scoped_relationship( $reading_a, $reading_b )

Returns the general (document-level or global) relationship that has been defined between the two reading strings. Returns undef if there is no general relationship.

add_relationship( $self, $source, $sourcetext, $target, $targettext, $opts )

Adds the relationship specified in $opts (see Text::Tradition::Collation::Relationship for the possible options) between the readings given in $source and $target. Sets up a scoped relationship between $sourcetext and $targettext if the relationship is scoped non-locally.

Returns a status boolean and a list of all reading pairs connected by the call to add_relationship.

del_relationship( $source, $target )

Removes the relationship between the given readings. If the relationship is non-local, removes the relationship everywhere in the graph.

relationship_valid( $source, $target, $type )

Checks whether a relationship of type $type may exist between the readings given in $source and $target. Returns a tuple of ( status, message ) where status is a yes/no boolean and, if the answer is no, message gives the reason why.

Returns a list of readings that are connected via relationship links to $reading. If $filter is set to a subroutine ref, returns only those related readings where $filter( $relationship ) returns a true value.

merge_readings( $kept, $deleted );

Makes a best-effort merge of the relationship links between the given readings, and stops tracking the to-be-deleted reading.