1 /*
2 * $Header: /usr/local/cvsroot/dev/madcache/src/com/macvu/tiles/xmlDefinition/XmlCacheDefinitionSet.java,v 1.1 2004/04/08 06:24:44 macvu Exp $
3 * $Revision: 1.1 $
4 * $Date: 2004/04/08 06:24:44 $
5 *
6 * ====================================================================
7 *
8 * The Apache Software License, Version 1.1
9 *
10 * Copyright (c) 1999-2002 The Apache Software Foundation. All rights
11 * reserved.
12 *
13 * Redistribution and use in source and binary forms, with or without
14 * modification, are permitted provided that the following conditions
15 * are met:
16 *
17 * 1. Redistributions of source code must retain the above copyright
18 * notice, this list of conditions and the following disclaimer.
19 *
20 * 2. Redistributions in binary form must reproduce the above copyright
21 * notice, this list of conditions and the following disclaimer in
22 * the documentation and/or other materials provided with the
23 * distribution.
24 *
25 * 3. The end-user documentation included with the redistribution, if
26 * any, must include the following acknowlegement:
27 * "This product includes software developed by the
28 * Apache Software Foundation (http://www.apache.org/)."
29 * Alternately, this acknowlegement may appear in the software itself,
30 * if and wherever such third-party acknowlegements normally appear.
31 *
32 * 4. The names "The Jakarta Project", "Struts", and "Apache Software
33 * Foundation" must not be used to endorse or promote products derived
34 * from this software without prior written permission. For written
35 * permission, please contact apache@apache.org.
36 *
37 * 5. Products derived from this software may not be called "Apache"
38 * nor may "Apache" appear in their names without prior written
39 * permission of the Apache Group.
40 *
41 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
42 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
43 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
44 * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
45 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
46 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
47 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
48 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
49 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
50 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
51 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
52 * SUCH DAMAGE.
53 * ====================================================================
54 *
55 * This software consists of voluntary contributions made by many
56 * individuals on behalf of the Apache Software Foundation. For more
57 * information on the Apache Software Foundation, please see
58 * <http://www.apache.org/>.
59 *
60 */
61
62 package com.macvu.tiles.xmlDefinition;
63
64 import org.apache.struts.tiles.NoSuchDefinitionException;
65
66 import java.util.HashMap;
67 import java.util.Iterator;
68 import java.util.Map;
69
70 public class XmlCacheDefinitionSet {
71
72 /***
73 * Defined definitions.
74 */
75 protected Map definitions;
76
77 /***
78 * Constructor.
79 */
80 public XmlCacheDefinitionSet() {
81 definitions = new HashMap();
82 }
83
84 /***
85 * Put definition in set.
86 *
87 * @param definition Definition to add.
88 */
89 public void putDefinition(XmlCacheDefinition definition) {
90 definitions.put(definition.getName(), definition);
91 }
92
93 /***
94 * Get requested definition.
95 *
96 * @param name Definition name.
97 */
98 public XmlCacheDefinition getDefinition(String name) {
99 return (XmlCacheDefinition) definitions.get(name);
100 }
101
102 /***
103 * Get definitions map.
104 */
105 public Map getDefinitions() {
106 return definitions;
107 }
108
109 /***
110 * Resolve extended instances.
111 */
112 public void resolveInheritances() throws NoSuchDefinitionException {
113 // Walk through all definitions and resolve individual inheritance
114 Iterator i = definitions.values().iterator();
115 while (i.hasNext()) {
116 XmlCacheDefinition definition = (XmlCacheDefinition) i.next();
117 definition.resolveInheritance(this);
118 } // end loop
119 }
120
121 /***
122 * Add definitions from specified child definitions set.
123 * For each definition in child, look if it already exists in this set.
124 * If not, add it, if yes, overload parent's definition with child definition.
125 *
126 * @param child Definition used to overload this object.
127 */
128 public void extend(XmlCacheDefinitionSet child) {
129 if (child == null)
130 return;
131 Iterator i = child.getDefinitions().values().iterator();
132 while (i.hasNext()) {
133 XmlCacheDefinition childInstance = (XmlCacheDefinition) i.next();
134 XmlCacheDefinition parentInstance = getDefinition(childInstance.getName());
135 if (parentInstance != null) {
136 parentInstance.overload(childInstance);
137 } else
138 putDefinition(childInstance);
139 } // end loop
140 }
141
142 /***
143 * Get String representation.
144 */
145 public String toString() {
146 return "definitions=" + definitions.toString();
147 }
148
149 }
150