/*

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

 *

 * This code is free software; you can redistribute it and/or modify it

 * under the terms of the GNU General Public License version 2 only, as

 * published by the Free Software Foundation.  Oracle designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Oracle in the LICENSE file that accompanied this code.

 *

 * This code is distributed in the hope that it will be useful, but WITHOUT

 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

 * version 2 for more details (a copy is included in the LICENSE file that

 * accompanied this code).

 *

 * You should have received a copy of the GNU General Public License version

 * 2 along with this work; if not, write to the Free Software Foundation,

 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

 *

 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

 * or visit www.oracle.com if you need additional information or have any

 * questions.

 */

package com.sun.xml.internal.xsom.impl;

import com.sun.xml.internal.xsom.XSAttGroupDecl;

import com.sun.xml.internal.xsom.XSAttributeUse;

import com.sun.xml.internal.xsom.impl.parser.SchemaDocumentImpl;

import com.sun.xml.internal.xsom.impl.scd.Iterators;

import com.sun.xml.internal.xsom.impl.Ref.AttGroup;

import org.xml.sax.Locator;

import java.util.AbstractSet;

import java.util.ArrayList;

import java.util.Collection;

import java.util.HashSet;

import java.util.Iterator;

import java.util.List;

import java.util.Map;

import java.util.Set;

import java.util.TreeMap;

import java.util.LinkedHashMap;

public abstract class AttributesHolder extends DeclarationImpl {

    protected AttributesHolder( SchemaDocumentImpl _parent, AnnotationImpl _annon,

                                Locator loc, ForeignAttributesImpl _fa, String _name, boolean _anonymous ) {

        super(_parent,_annon,loc,_fa,_parent.getTargetNamespace(),_name,_anonymous);

    }

    /** set the local wildcard. */

    public abstract void setWildcard(WildcardImpl wc);

    /**

     * Local attribute use.

     * Use linked hash map to guarantee the iteration order, and make it close to

     * what was in the schema document.

     */

    protected final Map<UName,AttributeUseImpl> attributes = new LinkedHashMap<UName,AttributeUseImpl>();

    public void addAttributeUse( UName name, AttributeUseImpl a ) {

        attributes.put( name, a );

    }

    /** prohibited attributes. */

    protected final Set<UName> prohibitedAtts = new HashSet<UName>();

    public void addProhibitedAttribute( UName name ) {

        prohibitedAtts.add(name);

    }

    /**

     * Returns the attribute uses by looking at attribute groups and etc.

     * Searching for the base type is done in {@link ComplexTypeImpl}.

     */

    public Collection<XSAttributeUse> getAttributeUses() {

        // TODO: this is fairly inefficient

        List<XSAttributeUse> v = new ArrayList<XSAttributeUse>();

        v.addAll(attributes.values());

        for( XSAttGroupDecl agd : getAttGroups() )

            v.addAll(agd.getAttributeUses());

        return v;

    }

    public Iterator<XSAttributeUse> iterateAttributeUses() {

        return getAttributeUses().iterator();

    }

    public XSAttributeUse getDeclaredAttributeUse( String nsURI, String localName ) {

        return attributes.get(new UName(nsURI,localName));

    }

    public Iterator<AttributeUseImpl> iterateDeclaredAttributeUses() {

        return attributes.values().iterator();

    }

    public Collection<AttributeUseImpl> getDeclaredAttributeUses() {

        return attributes.values();

    }

    /** {@link Ref.AttGroup}s that are directly refered from this. */

    protected final Set<Ref.AttGroup> attGroups = new HashSet<Ref.AttGroup>();

    public void addAttGroup( Ref.AttGroup a ) { attGroups.add(a); }

    // Iterates all AttGroups which are directly referenced from this component

    // this does not iterate att groups referenced from the base type

    public Iterator<XSAttGroupDecl> iterateAttGroups() {

        return new Iterators.Adapter<XSAttGroupDecl,Ref.AttGroup>(attGroups.iterator()) {

            protected XSAttGroupDecl filter(AttGroup u) {

                return u.get();

            }

        };

    }

    public Set<XSAttGroupDecl> getAttGroups() {

        return new AbstractSet<XSAttGroupDecl>() {

            public Iterator<XSAttGroupDecl> iterator() {

                return iterateAttGroups();

            }

            public int size() {

                return attGroups.size();

            }

        };

    }

}