/*
 * Copyright (c) 2001-2013 Oracle and/or its affiliates. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 *   - Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 *
 *   - 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.
 *
 *   - Neither the name of Oracle nor the names of its
 *     contributors may be used to endorse or promote products derived
 *     from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
 * IS" AND ANY EXPRESS 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 COPYRIGHT OWNER OR
 * 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.
 */

package com.sun.msv.relaxns.grammar;

import org.iso_relax.dispatcher.ElementDecl;
import org.xml.sax.Locator;

import com.sun.msv.grammar.ElementExp;
import com.sun.msv.grammar.Expression;
import com.sun.msv.grammar.ExpressionPool;
import com.sun.msv.grammar.NameClass;
import com.sun.msv.grammar.NamespaceNameClass;

/**
 * place holder for imported element declaration.
 * 
 * This class derives ElementExp because "elementDecl" is a constraint over one element.
 * This class also provides stub methods so that programs who are not aware to
 * divide&validate can gracefully degrade.
 * 
 * @author <a href="mailto:kohsuke.kawaguchi@eng.sun.com">Kohsuke KAWAGUCHI</a>
 */
public class ExternalElementExp extends ElementExp
{
    public NameClass getNameClass() { return nameClass; }

    /** NamespaceNameClass object that matchs this namespace. */
    private final NamespaceNameClass nameClass;
    
    /** namespace URI that this ExternalElementExp belongs to. */
    public final String namespaceURI;
    
    /** name of the imported Rule */
    public final String ruleName;
    
    /** where did this reference is written in the source file.
     * 
     * can be set to null (to reduce memory usage) at anytime.
     */
    public transient Locator source;
    
    /**
     * imported ElementDecl object that actually validates this element.
     * this variable is set during binding phase.
     */
    public ElementDecl rule;

    public ExternalElementExp(
        ExpressionPool pool, String namespaceURI, String ruleName,
        Locator loc )
    {
        // set content model to nullSet
        // to make this elementExp accept absolutely nothing.
        // "ignoreUndeclaredAttributes" flag is also meaningless here
        // because actual validation of this element will be done by a different
        // IslandVerifier.
        super(Expression.nullSet,false);
        
        this.ruleName = ruleName;
        this.namespaceURI = namespaceURI;
        this.nameClass = new NamespaceNameClass(namespaceURI);
        this.source = loc;
        
        /* provide dummy content model
        
            <mixed>
                <zeroOrMore>
                    <choice>
                        <attribute>
                            <nsName/>
                        </attribute>
                        <<<< this >>>>
                    </choice>
                </zeroOrMore>
            </mixed>
        */
        this.contentModel = pool.createZeroOrMore(
            pool.createMixed(
                pool.createChoice(
                    pool.createAttribute(nameClass),
                    this ) ) );
    }
    
}
