01: package org.apache.turbine.modules;
02:
03: /*
04: * Licensed to the Apache Software Foundation (ASF) under one
05: * or more contributor license agreements. See the NOTICE file
06: * distributed with this work for additional information
07: * regarding copyright ownership. The ASF licenses this file
08: * to you under the Apache License, Version 2.0 (the
09: * "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:
22: import org.apache.ecs.ConcreteElement;
23:
24: import org.apache.turbine.util.InputFilterUtils;
25: import org.apache.turbine.util.RunData;
26:
27: /**
28: * This is the base class that defines what a Navigation module is.
29: *
30: * @author <a href="mailto:mbryson@mont.mindspring.com">Dave Bryson</a>
31: * @author <a href="mailto:hps@intermeta.de">Henning P. Schmiedehausen</a>
32: * @version $Id: Navigation.java 534527 2007-05-02 16:10:59Z tv $
33: */
34: public abstract class Navigation extends Assembler {
35: /**
36: * A subclass must override this method to build itself.
37: * Subclasses override this method to store the navigation in
38: * RunData or to write the navigation to the output stream
39: * referenced in RunData.
40: *
41: * @param data Turbine information.
42: * @exception Exception a generic exception.
43: */
44: protected abstract ConcreteElement doBuild(RunData data)
45: throws Exception;
46:
47: /**
48: * Subclasses can override this method to add additional
49: * functionality. This method is protected to force clients to
50: * use NavigationLoader to build a Navigation.
51: *
52: * @param data Turbine information.
53: * @exception Exception a generic exception.
54: */
55: protected ConcreteElement build(RunData data) throws Exception {
56: return doBuild(data);
57: }
58:
59: /**
60: * This function can/should be used in any screen that will output
61: * User entered text. This will help prevent users from entering
62: * html (<SCRIPT>) tags that will get executed by the browser.
63: *
64: * @param s The string to prepare.
65: * @return A string with the input already prepared.
66: * @deprecated Use InputFilterUtils.prepareText(String s)
67: */
68: public static String prepareText(String s) {
69: return InputFilterUtils.prepareText(s);
70: }
71: }
|