1 /**
2 * Redistribution and use of this software and associated documentation ("Software"), with or
3 * without modification, are permitted provided that the following conditions are met:
4 *
5 * 1. Redistributions of source code must retain copyright statements and notices. Redistributions
6 * must also contain a copy of this document.
7 *
8 * 2. Redistributions in binary form must reproduce the above copyright notice, this list of
9 * conditions and the following disclaimer in the documentation and/or other materials provided with
10 * the distribution.
11 *
12 * 3. The name "Exolab" must not be used to endorse or promote products derived from this Software
13 * without prior written permission of Intalio, Inc. For written permission, please contact
14 * info@exolab.org.
15 *
16 * 4. Products derived from this Software may not be called "Exolab" nor may "Exolab" appear in
17 * their names without prior written permission of Intalio, Inc. Exolab is a registered trademark of
18 * Intalio, Inc.
19 *
20 * 5. Due credit should be given to the Exolab Project (http://www.exolab.org/).
21 *
22 * THIS SOFTWARE IS PROVIDED BY INTALIO, INC. AND CONTRIBUTORS ``AS IS'' AND ANY EXPRESSED OR
23 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
24 * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL INTALIO, INC. OR ITS
25 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
28 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY
29 * WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 *
31 * Copyright 2002 (C) Intalio, Inc. All Rights Reserved.
32 *
33 * $Id$
34 */
35 package org.exolab.castor.xml.schema.reader;
36
37 import java.util.Hashtable;
38
39 import org.exolab.castor.xml.schema.Schema;
40
41 /**
42 * A class used to save state information for the {@link SchemaUnmarshaller}. Roughly speaking, it
43 * keeps track of all the schemas read. This is used to prevent infinite loops when importing or
44 * including schemas.
45 *
46 * @author <a href="mailto:blandin@intalio.com">Arnaud Blandin</a>
47 * @version $Revision$ $Date: 2004-09-21 08:09:24 -0600 (Tue, 21 Sep 2004) $
48 */
49 public class SchemaUnmarshallerState {
50
51 private Hashtable<String, Schema> _processed = new Hashtable<String, Schema>();
52
53 /**
54 * A boolean that indicates whether or not to cache included XML Schemas
55 */
56 boolean cacheIncludedSchemas = false;
57
58 /**
59 * Marks the given {@link Schema} as having been processed.
60 *
61 * @param schemaLocation the key identifying the physical location of the schema to mark.
62 * @param schema the {@link Schema} to mark as having been processed.
63 */
64 void markAsProcessed(String schemaLocation, Schema schema) {
65 _processed.put(schemaLocation, schema);
66 }
67
68 /**
69 * Returns true if the given {@link Schema} has been marked as processed
70 *
71 * @param schema the {@link Schema} to check for being marked as processed
72 * @return true if the given {@link Schema} has been marked as processed
73 */
74 boolean processed(Schema schema) {
75 return _processed.contains(schema);
76 }
77
78 /**
79 * Returns true if the given schema location has been marked as processed.
80 *
81 * @param schemaLocation location the schema location to check for being marked as processed
82 * @return true if the given schema location has been marked as processed
83 */
84 boolean processed(String schemaLocation) {
85 return _processed.containsKey(schemaLocation);
86 }
87
88 /**
89 * Returns the schema corresponding to the given schemaLocation
90 *
91 * @param schemaLocation the schema location of the schema
92 * @return the schema corresponding to the given schemaLocation
93 */
94 Schema getSchema(String schemaLocation) {
95 return _processed.get(schemaLocation);
96 }
97
98 public void setCacheIncludedSchemas(boolean cacheIncludedSchemas) {
99 this.cacheIncludedSchemas = cacheIncludedSchemas;
100 }
101
102
103 }