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