add facilities for removing 'collated' relationship, and for annotation

[scpubgit/stemmatology.git] / lib / Text / Tradition / Collation / Relationship.pm

diff --git a/lib/Text/Tradition/Collation/Relationship.pm b/lib/Text/Tradition/Collation/Relationship.pm
index 07c6293..e08fb3c 100644 (file)
--- a/lib/Text/Tradition/Collation/Relationship.pm
+++ b/lib/Text/Tradition/Collation/Relationship.pm
@@ -6,7 +6,7 @@ use Moose::Util::TypeConstraints;
 enum 'RelationshipType' => qw( spelling orthographic grammatical meaning lexical
                                                           collated repetition transposition );
 
-enum 'RelationshipScope' => qw( local tradition global );
+enum 'RelationshipScope' => qw( local document global );
 
 no Moose::Util::TypeConstraints;
 
@@ -35,12 +35,14 @@ Options include:
 
 =item * displayform - (Optional) The reading that should be displayed if the related nodes are treated as one.
 
+=item * 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.
+
+=item * anotation - (Optional) A freeform note to attach to the relationship.
+
 =item * non_correctable - (Optional) True if the reading would not have been corrected independently.
 
 =item * non_independent - (Optional) True if the variant is unlikely to have occurred independently in unrelated witnesses.
 
-=item * scope - (Optional) A meta-attribute.  Can be one of 'local', 'tradition', or 'global'. Denotes whether the relationship between the two readings holds always, independent of context, either within this tradition or across all traditions.
-
 =back
 
 =head1 ACCESSORS
@@ -51,6 +53,8 @@ Options include:
 
 =head2 scope
 
+=head2 annotation
+
 =head2 non_correctable
 
 =head2 non_independent
@@ -88,6 +92,11 @@ has 'scope' => (
        isa => 'RelationshipScope', 
        default => 'local',
        );
+       
+has 'annotation' => (
+       is => 'ro',
+       isa => 'Str',
+       );
 
 has 'non_correctable' => (
        is => 'ro',