1 package stemmaweb::Controller::Relation;
3 use namespace::autoclean;
6 BEGIN { extends 'Catalyst::Controller' }
11 stemmaweb::Controller::Relation - Controller for the relationship mapper
15 The reading relationship mapper with draggable nodes.
23 Renders the application for the text identified by $textid.
27 sub index :Path :Args(1) {
28 my( $self, $c, $textid ) = @_;
29 my $m = $c->model('Directory');
30 my $tradition = $m->tradition( $textid );
31 my $collation = $tradition->collation;
32 my $svg_str = $collation->as_svg;
34 $c->stash->{'svg_string'} = $svg_str;
35 $c->stash->{'template'} = 'relate.tt';
38 sub dispatcher :Path :Args(2) {
39 my( $self, $c, $textid, $forward ) = @_;
40 $c->stash->{'tradition'} = $c->model('Directory')->tradition( $textid );
41 $c->forward( $forward );
44 =head2 relationship_definition
46 GET relation/definitions
48 Returns a data structure giving the valid types and scopes for a relationship.
52 sub definitions :Local :Args(0) {
54 my $valid_relationships = [ qw/ spelling orthographic grammatical meaning / ];
55 my $valid_scopes = [ qw/ local global / ];
56 $c->stash->{'result'} = { 'types' => $valid_relationships, 'scopes' => $valid_scopes };
57 $c->forward('View::JSON');
62 POST relation/$textid/relationship
63 source_id: $source, target_id: $target, rel_type: $type, scope: $scope
65 Sets the specified relationship between the readings in $source and $target.
66 Returns 200 and a list of node pairs where the relationship was added on success;
67 returns 403 and an { error: message } struct on failure.
71 sub relationship :Private {
73 my $tradition = delete $c->stash->{'tradition'};
74 my $collation = $tradition->collation;
75 my $node = $c->request->param('source_id');
76 my $target = $c->request->param('target_id');
77 my $relation = $c->request->param('rel_type');
78 my $note = $c->request->param('note');
79 my $scope = $c->request->param('scope');
81 my $opts = { 'type' => $relation,
85 my @vectors = $collation->add_relationship( $node, $target, $opts );
86 my $m = $c->model('Directory');
87 $m->save( $tradition );
88 $c->stash->{'result'} = \@vectors;
89 } catch( Text::Tradition::Error $e ) {
90 $c->response->status( '403' );
91 $c->stash->{'result'} = { 'error' => $e->message };
93 $c->forward('View::JSON');
98 GET relation/$textid/relationships
100 Returns a list of relationships that exist in the specified text. Each
101 relationship is returned in a struct that looks like:
103 { source: $sid, target: $tid, type: $rel_type, scope: $rel_scope }
107 sub relationships :Private {
108 my( $self, $c ) = @_;
109 my $tradition = delete $c->stash->{'tradition'};
110 my $collation = $tradition->collation;
112 my @pairs = $collation->relationships; # returns the edges
114 foreach my $p ( @pairs ) {
115 my $relobj = $collation->relations->get_relationship( @$p );
116 push( @all_relations,
117 { source => $p->[0], target => $p->[1],
118 type => $relobj->type, scope => $relobj->scope } );
120 $c->stash->{'result'} = \@all_relations;
121 $c->forward('View::JSON');
127 Attempt to render a view, if needed.
131 sub end : ActionClass('RenderView') {}
139 This library is free software. You can redistribute it and/or modify
140 it under the same terms as Perl itself.
144 __PACKAGE__->meta->make_immutable;