1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169 | -----------------------------------------------------------------------
-- asf-navigations -- Navigations
-- Copyright (C) 2010, 2011, 2012, 2013, 2018 Stephane Carrez
-- Written by Stephane Carrez (Stephane.Carrez@gmail.com)
--
-- Licensed under the Apache License, Version 2.0 (the "License");
-- you may not use this file except in compliance with the License.
-- You may obtain a copy of the License at
--
-- http://www.apache.org/licenses/LICENSE-2.0
--
-- Unless required by applicable law or agreed to in writing, software
-- distributed under the License is distributed on an "AS IS" BASIS,
-- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-- See the License for the specific language governing permissions and
-- limitations under the License.
-----------------------------------------------------------------------
with ASF.Contexts.Faces;
with EL.Expressions;
with EL.Contexts;
with Ada.Finalization;
with ASF.Applications.Views;
with Ada.Strings.Unbounded;
private with Ada.Containers.Vectors;
private with Ada.Containers.Hashed_Maps;
private with Ada.Strings.Unbounded.Hash;
-- The <b>ASF.Navigations</b> package is responsible for calculating the view to be
-- rendered after an action is processed. The navigation handler contains some rules
-- (defined in XML files) and it uses the current view id, the action outcome and
-- the faces context to decide which view must be rendered.
--
-- See JSR 314 - JavaServer Faces Specification 7.4 NavigationHandler
package ASF.Navigations is
-- ------------------------------
-- Navigation Handler
-- ------------------------------
type Navigation_Handler is new Ada.Finalization.Limited_Controlled with private;
type Navigation_Handler_Access is access all Navigation_Handler'Class;
-- After executing an action and getting the action outcome, proceed to the navigation
-- to the next page.
procedure Handle_Navigation (Handler : in Navigation_Handler;
Action : in String;
Outcome : in String;
Context : in out ASF.Contexts.Faces.Faces_Context'Class);
-- Provide a default navigation rules for the view and the outcome when no application
-- navigation was found. The default looks for an XHTML file in the same directory as
-- the view and which has the base name defined by <b>Outcome</b>.
procedure Handle_Default_Navigation (Handler : in Navigation_Handler;
View : in String;
Outcome : in String;
Context : in out ASF.Contexts.Faces.Faces_Context'Class);
-- Initialize the the lifecycle handler.
procedure Initialize (Handler : in out Navigation_Handler;
Views : access ASF.Applications.Views.View_Handler'Class);
-- Free the storage used by the navigation handler.
overriding
procedure Finalize (Handler : in out Navigation_Handler);
-- Add a navigation case to navigate from the view identifier by <b>From</b>
-- to the result view identified by <b>To</b>. Some optional conditions are evaluated
-- The <b>Outcome</b> must match unless it is empty.
-- The <b>Action</b> must match unless it is empty.
-- The <b>Condition</b> expression must evaluate to True.
procedure Add_Navigation_Case (Handler : in out Navigation_Handler;
From : in String;
To : in String;
Outcome : in String := "";
Action : in String := "";
Condition : in String := "";
Context : in EL.Contexts.ELContext'Class);
-- ------------------------------
-- Navigation Case
-- ------------------------------
-- The <b>Navigation_Case</b> contains a condition and a navigation action.
-- The condition must be matched to execute the navigation action.
type Navigation_Case is abstract tagged limited private;
type Navigation_Access is access all Navigation_Case'Class;
-- Check if the navigator specific condition matches the current execution context.
function Matches (Navigator : in Navigation_Case;
Action : in String;
Outcome : in String;
Context : in ASF.Contexts.Faces.Faces_Context'Class) return Boolean;
-- Navigate to the next page or action according to the controller's navigator.
-- A navigator controller could redirect the user to another page, render a specific
-- view or return some raw content.
procedure Navigate (Navigator : in Navigation_Case;
Context : in out ASF.Contexts.Faces.Faces_Context'Class) is abstract;
-- Add a navigation case to navigate from the view identifier by <b>From</b>
-- by using the navigation rule defined by <b>Navigator</b>.
-- Some optional conditions are evaluated:
-- The <b>Outcome</b> must match unless it is empty.
-- The <b>Action</b> must match unless it is empty.
-- The <b>Condition</b> expression must evaluate to True.
procedure Add_Navigation_Case (Handler : in out Navigation_Handler'Class;
Navigator : in Navigation_Access;
From : in String;
Outcome : in String := "";
Action : in String := "";
Condition : in String := "";
Context : in EL.Contexts.ELContext'Class);
private
use Ada.Strings.Unbounded;
type Navigation_Case is abstract tagged limited record
-- When not empty, the condition that must be verified to follow this navigator.
Condition : EL.Expressions.Expression;
View_Handler : access ASF.Applications.Views.View_Handler'Class;
Outcome : String_Access;
Action : String_Access;
end record;
package Navigator_Vector is new Ada.Containers.Vectors (Index_Type => Natural,
Element_Type => Navigation_Access);
-- ------------------------------
-- Navigation Rule
-- ------------------------------
type Rule is tagged limited record
Navigators : Navigator_Vector.Vector;
end record;
-- Clear the navigation rules.
procedure Clear (Controller : in out Rule);
-- Search for the navigator that matches the current action, outcome and context.
-- Returns the navigator or null if there was no match.
function Find_Navigation (Controller : in Rule;
Action : in String;
Outcome : in String;
Context : in Contexts.Faces.Faces_Context'Class)
return Navigation_Access;
type Rule_Access is access all Rule'Class;
package Rule_Map is new Ada.Containers.Hashed_Maps (Key_Type => Unbounded_String,
Element_Type => Rule_Access,
Hash => Hash,
Equivalent_Keys => "=");
type Navigation_Rules is limited record
-- Exact match rules
Rules : Rule_Map.Map;
end record;
-- Clear the navigation rules.
procedure Clear (Controller : in out Navigation_Rules);
type Navigation_Rules_Access is access all Navigation_Rules;
type Navigation_Handler is new Ada.Finalization.Limited_Controlled with record
Rules : Navigation_Rules_Access;
View_Handler : access ASF.Applications.Views.View_Handler'Class;
end record;
end ASF.Navigations;
|