Package: ViewFactory

ViewFactory

Coverage

1: /*
2: * *************************************************************************************************************************************************************
3: *
4: * NorthernWind - lightweight CMS
5: * http://tidalwave.it/projects/northernwind
6: *
7: * Copyright (C) 2011 - 2025 Tidalwave s.a.s. (http://tidalwave.it)
8: *
9: * *************************************************************************************************************************************************************
10: *
11: * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
12: * You may obtain a copy of the License at
13: *
14: * http://www.apache.org/licenses/LICENSE-2.0
15: *
16: * 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
17: * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
18: *
19: * *************************************************************************************************************************************************************
20: *
21: * git clone https://bitbucket.org/tidalwave/northernwind-src
22: * git clone https://github.com/tidalwave-it/northernwind-src
23: *
24: * *************************************************************************************************************************************************************
25: */
26: package it.tidalwave.northernwind.frontend.ui;
27:
28: import javax.annotation.Nonnull;
29: import it.tidalwave.util.Id;
30: import it.tidalwave.util.NotFoundException;
31: import it.tidalwave.northernwind.core.model.HttpStatusException;
32: import it.tidalwave.northernwind.core.model.SiteNode;
33: import lombok.Getter;
34: import lombok.RequiredArgsConstructor;
35: import lombok.ToString;
36:
37: /***************************************************************************************************************************************************************
38: *
39: * A factory for Views.
40: *
41: * @stereotype Factory
42: *
43: * @author Fabrizio Giudici
44: *
45: **************************************************************************************************************************************************************/
46: @FunctionalInterface
47: public interface ViewFactory
48: {
49: @RequiredArgsConstructor @Getter @ToString
50: public static class ViewAndController
51: {
52: @Nonnull
53: private final Object view;
54:
55: @Nonnull
56: private final ViewController controller;
57:
58: /***************************************************************************************************************
59: *
60: * Call the controller to have the view rendered, and return it.
61: *
62: * @param context the render context
63: * @return the rendered view
64: * @exception Exception if something failed
65: *
66: **************************************************************************************************************/
67: @Nonnull
68: public Object renderView (@Nonnull final RenderContext context)
69: throws Exception
70: {
71: controller.renderView(context);
72: return view;
73: }
74: }
75:
76: /***********************************************************************************************************************************************************
77: * Creates a new pair of View and Controller.
78: *
79: * @param viewTypeUri the view type URI
80: * @param viewId the view id
81: * @param siteNode the node this view is created for
82: * @return the new pair
83: * @throws NotFoundException if no view component is found
84: * @throws HttpStatusException if a component asked to return a specific HTTP status
85: **********************************************************************************************************************************************************/
86: @Nonnull
87: public ViewAndController createViewAndController (@Nonnull String viewTypeUri,
88: @Nonnull Id viewId,
89: @Nonnull SiteNode siteNode)
90: throws NotFoundException, HttpStatusException;
91: }