/**
 * Redistribution and use of this software and associated documentation ("Software"), with or
 * without modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain copyright statements and notices. Redistributions
 * must also contain a copy of this document.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice, this list of
 * conditions and the following disclaimer in the documentation and/or other materials provided with
 * the distribution.
 *
 * 3. The name "Exolab" must not be used to endorse or promote products derived from this Software
 * without prior written permission of Intalio, Inc. For written permission, please contact
 * info@exolab.org.
 *
 * 4. Products derived from this Software may not be called "Exolab" nor may "Exolab" appear in
 * their names without prior written permission of Intalio, Inc. Exolab is a registered trademark of
 * Intalio, Inc.
 *
 * 5. Due credit should be given to the Exolab Project (http://www.exolab.org/).
 *
 * THIS SOFTWARE IS PROVIDED BY INTALIO, INC. AND CONTRIBUTORS ``AS IS'' AND ANY EXPRESSED OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
 * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL INTALIO, INC. OR ITS
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY
 * WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * Copyright 2002 (C) Intalio, Inc. All Rights Reserved.
 *
 * $Id$
 */
package org.exolab.castor.xml.schema.reader;

import java.util.Hashtable;

import org.exolab.castor.xml.schema.Schema;

/**
 * A class used to save state information for the {@link SchemaUnmarshaller}. Roughly speaking, it
 * keeps track of all the schemas read. This is used to prevent infinite loops when importing or
 * including schemas.
 * 
 * @author <a href="mailto:blandin@intalio.com">Arnaud Blandin</a>
 * @version $Revision$ $Date: 2004-09-21 08:09:24 -0600 (Tue, 21 Sep 2004) $
 */
public class SchemaUnmarshallerState {

  private Hashtable<String, Schema> _processed = new Hashtable<String, Schema>();

  /**
   * A boolean that indicates whether or not to cache included XML Schemas
   */
  boolean cacheIncludedSchemas = false;

  /**
   * Marks the given {@link Schema} as having been processed.
   * 
   * @param schemaLocation the key identifying the physical location of the schema to mark.
   * @param schema the {@link Schema} to mark as having been processed.
   */
  void markAsProcessed(String schemaLocation, Schema schema) {
    _processed.put(schemaLocation, schema);
  }

  /**
   * Returns true if the given {@link Schema} has been marked as processed
   * 
   * @param schema the {@link Schema} to check for being marked as processed
   * @return true if the given {@link Schema} has been marked as processed
   */
  boolean processed(Schema schema) {
    return _processed.contains(schema);
  }

  /**
   * Returns true if the given schema location has been marked as processed.
   *
   * @param schemaLocation location the schema location to check for being marked as processed
   * @return true if the given schema location has been marked as processed
   */
  boolean processed(String schemaLocation) {
    return _processed.containsKey(schemaLocation);
  }

  /**
   * Returns the schema corresponding to the given schemaLocation
   *
   * @param schemaLocation the schema location of the schema
   * @return the schema corresponding to the given schemaLocation
   */
  Schema getSchema(String schemaLocation) {
    return _processed.get(schemaLocation);
  }

  public void setCacheIncludedSchemas(boolean cacheIncludedSchemas) {
    this.cacheIncludedSchemas = cacheIncludedSchemas;
  }


}
