1 /*
2 * $Id: ViewPreparer.java 1310865 2012-04-07 21:01:22Z nlebas $
3 *
4 * Licensed to the Apache Software Foundation (ASF) under one
5 * or more contributor license agreements. See the NOTICE file
6 * distributed with this work for additional information
7 * regarding copyright ownership. The ASF licenses this file
8 * to you under the Apache License, Version 2.0 (the
9 * "License"); you may not use this file except in compliance
10 * with the License. You may obtain a copy of the License at
11 *
12 * http://www.apache.org/licenses/LICENSE-2.0
13 *
14 * Unless required by applicable law or agreed to in writing,
15 * software distributed under the License is distributed on an
16 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17 * KIND, either express or implied. See the License for the
18 * specific language governing permissions and limitations
19 * under the License.
20 */
21 package org.apache.tiles.preparer;
22
23 import org.apache.tiles.AttributeContext;
24 import org.apache.tiles.request.Request;
25
26 /**
27 * <p>
28 * Executed prior to rendering a view.
29 * </p>
30 *
31 * <p>
32 * A view preparer is typically used to provide last minute
33 * translations of the data within the attribute context.
34 * A preparer is not intended to replace the controller within an
35 * MVC architecture.
36 * </p>
37 *
38 * See
39 * <ul>
40 * <li><insert></li>
41 * <li><definition></li>
42 * </ul>>
43 *
44 * @version $Rev: 1310865 $ $Date: 2012-04-08 07:01:22 +1000 (Sun, 08 Apr 2012) $
45 */
46 public interface ViewPreparer {
47
48 /**
49 * Method associated to a tile and called immediately before the tile
50 * is included.
51 *
52 * @param tilesContext Current tiles application context.
53 * @param attributeContext Current tile context.
54 * @throws PreparerException If something goes wrong during execution.
55 */
56 void execute(Request tilesContext,
57 AttributeContext attributeContext);
58 }