1 /*
2 * Scope: a generic MVC framework.
3 * Copyright (c) 2000-2002, The Scope team
4 * All rights reserved.
5 *
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 *
11 * Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 *
14 * Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in the
16 * documentation and/or other materials provided with the distribution.
17 *
18 * Neither the name "Scope" nor the names of its contributors
19 * may be used to endorse or promote products derived from this software
20 * without specific prior written permission.
21 *
22 *
23 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
24 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
25 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
26 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR
27 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
28 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
29 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
30 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
31 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
32 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
33 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34 *
35 *
36 * $Id: PropertyIDGenerator.java,v 1.5 2002/09/05 15:41:45 ludovicc Exp $
37 */
38 package org.scopemvc.view.servlet.xml;
39
40
41 import org.scopemvc.core.Selector;
42
43 /***
44 * <P>
45 *
46 * Generates IDs to identify properties during the traversal of the model
47 * containment hierarchy. Used by ModelToXML. The ids in the xml could be used
48 * as form parameters to identify properties to be populated with user input.
49 * </P> <P>
50 *
51 * This is used by the ID generators defined as inner classes in {@link
52 * XSLPage}. </P>
53 *
54 * @author <A HREF="mailto:smeyfroi@users.sourceforge.net">Steve Meyfroidt</A>
55 * @created 05 September 2002
56 * @version $Revision: 1.5 $ $Date: 2002/09/05 15:41:45 $
57 */
58 public abstract class PropertyIDGenerator {
59
60 /***
61 * TODO: describe of the Field
62 */
63 protected Selector currentPropertySelector;
64
65
66 /***
67 * Gets the property ID
68 *
69 * @return The propertyID value
70 */
71 public abstract String getPropertyID();
72
73
74 /***
75 * Call this to recurse down a property.
76 *
77 * @param inSelector TODO: Describe the Parameter
78 */
79 public void startProperty(Selector inSelector) {
80 if (currentPropertySelector == null) {
81 currentPropertySelector = inSelector.deepClone();
82 } else {
83 currentPropertySelector.chain(inSelector.deepClone());
84 }
85 }
86
87
88 /***
89 * Call this to pop up a property.
90 */
91 public void endProperty() {
92 if (currentPropertySelector.getNext() == null) {
93 currentPropertySelector = null;
94 } else {
95 currentPropertySelector.removeLast();
96 }
97 }
98 }
This page was automatically generated by Maven