
/*
 * The Apache Software License, Version 1.1
 *
 *
 * Copyright (c) 2001 The Apache Software Foundation.  All rights
 * reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * 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 end-user documentation included with the redistribution,
 *    if any, must include the following acknowledgment:
 *       "This product includes software developed by the
 *        Apache Software Foundation (http://www.apache.org/)."
 *    Alternately, this acknowledgment may appear in the software itself,
 *    if and wherever such third-party acknowledgments normally appear.
 *
 * 4. The names "Xerces" and "Apache Software Foundation" must
 *    not be used to endorse or promote products derived from this
 *    software without prior written permission. For written
 *    permission, please contact apache@apache.org.
 *
 * 5. Products derived from this software may not be called "Apache",
 *    nor may "Apache" appear in their name, without prior written
 *    permission of the Apache Software Foundation.
 *
 * THIS SOFTWARE IS PROVIDED ``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 THE APACHE SOFTWARE FOUNDATION 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.
 * ====================================================================
 *
 * This software consists of voluntary contributions made by many
 * individuals on behalf of the Apache Software Foundation and was
 * originally based on software copyright (c) 2001, International
 * Business Machines, Inc., http://www.apache.org.  For more
 * information on the Apache Software Foundation, please see
 * <http://www.apache.org/>.
 */
package org.apache.xerces.impl.v2;

import org.apache.xerces.impl.XMLErrorReporter;
import org.apache.xerces.util.DOMUtil;
import org.apache.xerces.xni.QName;
import org.w3c.dom.Element;

/**
 * The attribute group definition schema component traverser.
 *
 * <attributeGroup
 *   id = ID
 *   name = NCName
 *   ref = QName
 *   {any attributes with non-schema namespace . . .}>
 *   Content: (annotation?, ((attribute | attributeGroup)*, anyAttribute?))
 * </attributeGroup>
 * @version $Id: XSDAttributeGroupTraverser.java,v 1.6 2001/09/07 16:46:14 sandygao Exp $
 * @author Rahul Srivastava, Sun Microsystems Inc.
 */
class  XSDAttributeGroupTraverser extends XSDAbstractTraverser{

    XSDAttributeGroupTraverser (XSDHandler handler,
                                XMLErrorReporter errorReporter,
                                XSAttributeChecker gAttrCheck) {

        super(handler, errorReporter, gAttrCheck);
    }

    int traverseLocal(Element elmNode,
                      XSDocumentInfo schemaDoc,
                      SchemaGrammar grammar) {

        // General Attribute Checking for elmNode declared locally
        Object[] attrValues = fAttrChecker.checkAttributes(elmNode, false, schemaDoc.fNamespaceSupport);
        
        // get attribute
        QName   refAttr	= (QName)   attrValues[XSAttributeChecker.ATTIDX_REF];
        
        int index = -1;
        
        // ref should be here.
        if (refAttr == null) {
                reportGenericSchemaError("Local attributeGroup declaration should have ref.");
                return index;
        }
            
        // get global decl
        //index = fSchemaHandler.getGlobalDecl(schemaDoc, XSDHandler.ATTRIBUTEGROUP_TYPE, refAttr);
        index = grammar.getAttributeGroupIndex(refAttr.localpart);

        // no children are allowed here except annotation, which is optional.
        Element child = DOMUtil.getFirstChildElement(elmNode);
        String childName = child.getLocalName();
        if (child != null) {
            	if (childName.equals(SchemaSymbols.ELT_ANNOTATION)) {
                	traverseAnnotationDecl(child, attrValues, false, schemaDoc);
                	child = DOMUtil.getNextSiblingElement(child);
                	childName = child.getLocalName();
                }
                
                if (child != null) {
                	Object[] args = new Object [] { "attributeGroup", childName};
                	fErrorReporter.reportError(XSMessageFormatter.SCHEMA_DOMAIN,
                                           	  "AttributeGroupContentRestricted",
                                           	  args,
                                           	  XMLErrorReporter.SEVERITY_ERROR);

                }
         } // if

        fAttrChecker.returnAttrArray(attrValues, schemaDoc.fNamespaceSupport);
        return index;
        
    } // traverseLocal

    int traverseGlobal(Element elmNode,
                       XSDocumentInfo schemaDoc,
                       SchemaGrammar grammar) {

        //REVISIT: check for circular references

        // General Attribute Checking for elmNode declared globally
        Object[] attrValues = fAttrChecker.checkAttributes(elmNode, true, schemaDoc.fNamespaceSupport);
        
        String  nameAttr   = (String) attrValues[XSAttributeChecker.ATTIDX_NAME];
        
        int index = -1;

        // global declaration must have a name
        if (nameAttr.length() == 0) {
        	reportGenericSchemaError("Global attributeGroup declaration must have a name.");
        }
                
        // check the content
        Element child = DOMUtil.getFirstChildElement(elmNode);
        String childName = child.getLocalName();
                
        //REVISIT: Is it valid for a global attributeGroup decl to have NO childs
        if (child == null) {
        	reportGenericSchemaError("Global attributeGroup declaration must have a child.");
        	// else comment the above line
        }
        else {
        	if (childName.equals(SchemaSymbols.ELT_ANNOTATION)) {
        		traverseAnnotationDecl(child, attrValues, false, schemaDoc);
                	child = DOMUtil.getNextSiblingElement(child);
                	childName = child.getLocalName();
                }
                	
                for (; child != null; child = DOMUtil.getNextSiblingElement(child)) {
                	childName = child.getLocalName();
                	if (childName.equals(SchemaSymbols.ELT_ATTRIBUTE)) {
                		index = fSchemaHandler.fAttributeTraverser.traverseLocal(child, schemaDoc, grammar);
                	}
                	else if (childName.equals(SchemaSymbols.ELT_ATTRIBUTEGROUP)) {
                		//REVISIT: do we need to save some state at this point??
                		index = traverseLocal(child, schemaDoc, grammar);
                	}
                	else
                		break;
                } // for
                	
                if (child != null) {
                	childName = child.getLocalName();
                	if (childName.equals(SchemaSymbols.ELT_ANYATTRIBUTE)) {
                		index = fSchemaHandler.fWildCardTraverser.traverseAnyAttribute(child, schemaDoc, grammar);
                		child = DOMUtil.getNextSiblingElement(child);
                		childName = child.getLocalName();
                	}
                		
                	if (child != null) {
                		Object[] args = new Object [] { "attributeGroup", childName};
                			fErrorReporter.reportError(XSMessageFormatter.SCHEMA_DOMAIN,
                						   "AttributeGroupContentRestricted",
                						   args,
                						   XMLErrorReporter.SEVERITY_ERROR);
              		}
                } // if
        } // if
        
        //REVISIT: populate XSAttributeGroupDecl by attributeGroup information and get index by adding to grammar.
        // index = grammar.addAttributeGroupDecl(XSAttributeGroupDecl);
        
        // make an entry in global declarations.
        grammar.fGlobalAttrGrpDecls.put(nameAttr, index);

        fAttrChecker.returnAttrArray(attrValues, schemaDoc.fNamespaceSupport);
        return index;
        
    } // traverseGlobal

} // XSDAttributeGroupTraverser
