content: /*
   * Licensed to the Apache Software Foundation (ASF) under one or more
   * contributor license agreements.  See the NOTICE file distributed with
   * this work for additional information regarding copyright ownership.
   * The ASF licenses this file to You under the Apache License, Version 2.0
   * (the "License"); you may not use this file except in compliance with
   * the License.  You may obtain a copy of the License at
   * 
   *      http://www.apache.org/licenses/LICENSE-2.0
   * 
   * Unless required by applicable law or agreed to in writing, software
   * distributed under the License is distributed on an "AS IS" BASIS,
   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   * See the License for the specific language governing permissions and
   * limitations under the License.
   */
  
  package mf.org.apache.xerces.impl.xs;
  
  import mf.org.apache.xerces.util.XMLResourceIdentifierImpl;
  import mf.org.apache.xerces.xni.QName;
  import mf.org.apache.xerces.xni.XMLAttributes;
  import mf.org.apache.xerces.xni.grammars.XMLGrammarDescription;
  import mf.org.apache.xerces.xni.grammars.XMLSchemaDescription;
  
  
  /**
   * All information specific to XML Schema grammars.
   *
   * @author Neil Graham, IBM
   * @author Neeraj Bajaj, SUN Microsystems.
   * @version $Id: XSDDescription.java 446734 2006-09-15 20:51:23Z mrglavas $
   * @xerces.internal
   */
  public class XSDDescription extends XMLResourceIdentifierImpl
          implements XMLSchemaDescription {
      // used to indicate what triggered the call
      /**
       * Indicate that this description was just initialized.
       */
      public final static short CONTEXT_INITIALIZE = -1;
      /**
       * Indicate that the current schema document is <include>d by another
       * schema document.
       */
      public final static short CONTEXT_INCLUDE = 0;
      /**
       * Indicate that the current schema document is <redefine>d by another
       * schema document.
       */
      public final static short CONTEXT_REDEFINE = 1;
      /**
       * Indicate that the current schema document is <import>ed by another
       * schema document.
       */
      public final static short CONTEXT_IMPORT = 2;
      /**
       * Indicate that the current schema document is being preparsed.
       */
      public final static short CONTEXT_PREPARSE = 3;
      /**
       * Indicate that the parse of the current schema document is triggered
       * by xsi:schemaLocation/noNamespaceSchemaLocation attribute(s) in the
       * instance document. This value is only used if we don't defer the loading
       * of schema documents.
       */
      public final static short CONTEXT_INSTANCE = 4;
      /**
       * Indicate that the parse of the current schema document is triggered by
       * the occurrence of an element whose namespace is the target namespace
       * of this schema document. This value is only used if we do defer the
       * loading of schema documents until a component from that namespace is
       * referenced from the instance.
       */
      public final static short CONTEXT_ELEMENT = 5;
      /**
       * Indicate that the parse of the current schema document is triggered by
       * the occurrence of an attribute whose namespace is the target namespace
       * of this schema document. This value is only used if we do defer the
       * loading of schema documents until a component from that namespace is
       * referenced from the instance.
       */
      public final static short CONTEXT_ATTRIBUTE = 6;
      /**
       * Indicate that the parse of the current schema document is triggered by
       * the occurrence of an "xsi:type" attribute, whose value (a QName) has
       * the target namespace of this schema document as its namespace.
       * This value is only used if we do defer the loading of schema documents
       * until a component from that namespace is referenced from the instance.
       */
      public final static short CONTEXT_XSITYPE = 7;
  
      // REVISIT: write description of these fields	
      protected short fContextType;
      protected String[] fLocationHints;
      protected QName fTriggeringComponent;
      protected QName fEnclosedElementName;
      protected XMLAttributes fAttributes;
  
      /**
       * the type of the grammar (e.g., DTD or XSD);
       *
       * @see mf.org.apache.xerces.xni.grammars.Grammar
       */
      @Override
      public String getGrammarType() {
          return XMLGrammarDescription.XML_SCHEMA;
      }
  
      /**
       * Get the context. The returned value is one of the pre-defined
       * CONTEXT_xxx constants.
       *
       * @return the value indicating the context
       */
      @Override
      public short getContextType() {
          return fContextType;
      }
  
      public void setContextType(short contextType) {
          fContextType = contextType;
      }
  
      /**
       * If the context is "include" or "redefine", then return the target
       * namespace of the enclosing schema document; otherwise, the expected
       * target namespace of this document.
       *
       * @return the expected/enclosing target namespace
       */
      @Override
      public String getTargetNamespace() {
          return fNamespace;
      }
  
      public void setTargetNamespace(String targetNamespace) {
          fNamespace = targetNamespace;
      }
  
      /**
       * For import and references from the instance document, it's possible to
       * have multiple hints for one namespace. So this method returns an array,
       * which contains all location hints.
       *
       * @return an array of all location hints associated to the expected
       * target namespace
       */
      @Override
      public String[] getLocationHints() {
          return fLocationHints;
      }
  
      public void setLocationHints(String[] locationHints) {
          int length = locationHints.length;
          fLocationHints = new String[length];
          System.arraycopy(locationHints, 0, fLocationHints, 0, length);
          //fLocationHints = locationHints ;
      }
  
      /**
       * If a call is triggered by an element/attribute/xsi:type in the instance,
       * this call returns the name of such triggering component: the name of
       * the element/attribute, or the value of the xsi:type.
       *
       * @return the name of the triggering component
       */
      @Override
      public QName getTriggeringComponent() {
          return fTriggeringComponent;
      }
  
      public void setTriggeringComponent(QName triggeringComponent) {
          fTriggeringComponent = triggeringComponent;
      }
  
      /**
       * If a call is triggered by an attribute or xsi:type, then this mehtod
       * returns the enclosing element of such element.
       *
       * @return the name of the enclosing element
       */
      @Override
      public QName getEnclosingElementName() {
          return fEnclosedElementName;
      }
  
      public void setEnclosingElementName(QName enclosedElementName) {
          fEnclosedElementName = enclosedElementName;
      }
  
      /**
       * If a call is triggered by an element/attribute/xsi:type in the instance,
       * this call returns all attribute of such element (or enclosing element).
       *
       * @return all attributes of the tiggering/enclosing element
       */
      @Override
      public XMLAttributes getAttributes() {
          return fAttributes;
      }
  
      public void setAttributes(XMLAttributes attributes) {
          fAttributes = attributes;
      }
  
      public boolean fromInstance() {
          return fContextType == CONTEXT_ATTRIBUTE ||
                  fContextType == CONTEXT_ELEMENT ||
                  fContextType == CONTEXT_INSTANCE ||
                  fContextType == CONTEXT_XSITYPE;
      }
  
      /**
       * Compares this grammar with the given grammar. Currently, we compare
       * the target namespaces.
       *
       * @param descObj The description of the grammar to be compared with
       * @return True if they are equal, else false
       */
      @Override
      public boolean equals(Object descObj) {
          if (!(descObj instanceof XMLSchemaDescription)) return false;
          XMLSchemaDescription desc = (XMLSchemaDescription) descObj;
          if (fNamespace != null)
              return fNamespace.equals(desc.getTargetNamespace());
          else // fNamespace == null
              return desc.getTargetNamespace() == null;
      }
  
      /**
       * Returns the hash code of this grammar
       *
       * @return The hash code
       */
      @Override
      public int hashCode() {
          return (fNamespace == null) ? 0 : fNamespace.hashCode();
      }
  
      /**
       * resets all the fields
       */
      public void reset() {
          super.clear();
          fContextType = CONTEXT_INITIALIZE;
          fLocationHints = null;
          fTriggeringComponent = null;
          fEnclosedElementName = null;
          fAttributes = null;
      }
  
      public XSDDescription makeClone() {
          XSDDescription desc = new XSDDescription();
          desc.fAttributes = this.fAttributes;
          desc.fBaseSystemId = this.fBaseSystemId;
          desc.fContextType = this.fContextType;
          desc.fEnclosedElementName = this.fEnclosedElementName;
          desc.fExpandedSystemId = this.fExpandedSystemId;
          desc.fLiteralSystemId = this.fLiteralSystemId;
          desc.fLocationHints = this.fLocationHints;
          desc.fPublicId = this.fPublicId;
          desc.fNamespace = this.fNamespace;
          desc.fTriggeringComponent = this.fTriggeringComponent;
          return desc;
      }
  
  } // XSDDescription
  