aoqi@0: /*
aoqi@0:  * Copyright (c) 1997, 2010, Oracle and/or its affiliates. All rights reserved.
aoqi@0:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
aoqi@0:  *
aoqi@0:  * This code is free software; you can redistribute it and/or modify it
aoqi@0:  * under the terms of the GNU General Public License version 2 only, as
aoqi@0:  * published by the Free Software Foundation.  Oracle designates this
aoqi@0:  * particular file as subject to the "Classpath" exception as provided
aoqi@0:  * by Oracle in the LICENSE file that accompanied this code.
aoqi@0:  *
aoqi@0:  * This code is distributed in the hope that it will be useful, but WITHOUT
aoqi@0:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
aoqi@0:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
aoqi@0:  * version 2 for more details (a copy is included in the LICENSE file that
aoqi@0:  * accompanied this code).
aoqi@0:  *
aoqi@0:  * You should have received a copy of the GNU General Public License version
aoqi@0:  * 2 along with this work; if not, write to the Free Software Foundation,
aoqi@0:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
aoqi@0:  *
aoqi@0:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
aoqi@0:  * or visit www.oracle.com if you need additional information or have any
aoqi@0:  * questions.
aoqi@0:  */
aoqi@0: 
aoqi@0: package com.sun.xml.internal.xsom;
aoqi@0: 
aoqi@0: import javax.xml.namespace.NamespaceContext;
aoqi@0: import java.util.Iterator;
aoqi@0: import java.util.Collection;
aoqi@0: 
aoqi@0: /**
aoqi@0:  * Set of {@link XSSchema} objects.
aoqi@0:  *
aoqi@0:  * @author
aoqi@0:  *  Kohsuke Kawaguchi (kohsuke.kawaguchi@sun.com)
aoqi@0:  */
aoqi@0: public interface XSSchemaSet
aoqi@0: {
aoqi@0:     XSSchema getSchema(String targetNamespace);
aoqi@0:     XSSchema getSchema(int idx);
aoqi@0:     int getSchemaSize();
aoqi@0:     Iterator<XSSchema> iterateSchema();
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Gets all {@link XSSchema}s in a single collection.
aoqi@0:      */
aoqi@0:     Collection<XSSchema> getSchemas();
aoqi@0: 
aoqi@0:     XSType getType(String namespaceURI, String localName);
aoqi@0:     XSSimpleType getSimpleType(String namespaceURI, String localName);
aoqi@0:     XSAttributeDecl getAttributeDecl(String namespaceURI, String localName);
aoqi@0:     XSElementDecl getElementDecl(String namespaceURI, String localName);
aoqi@0:     XSModelGroupDecl getModelGroupDecl(String namespaceURI, String localName);
aoqi@0:     XSAttGroupDecl getAttGroupDecl(String namespaceURI, String localName);
aoqi@0:     XSComplexType getComplexType(String namespaceURI, String localName);
aoqi@0:     XSIdentityConstraint getIdentityConstraint(String namespaceURI, String localName);
aoqi@0: 
aoqi@0:     /** Iterates all element declarations in all the schemas. */
aoqi@0:     Iterator<XSElementDecl> iterateElementDecls();
aoqi@0:     /** Iterates all type definitions in all the schemas. */
aoqi@0:     Iterator<XSType> iterateTypes();
aoqi@0:     /** Iterates all atribute declarations in all the schemas. */
aoqi@0:     Iterator<XSAttributeDecl> iterateAttributeDecls();
aoqi@0:     /** Iterates all attribute group declarations in all the schemas. */
aoqi@0:     Iterator<XSAttGroupDecl> iterateAttGroupDecls();
aoqi@0:     /** Iterates all model group declarations in all the schemas. */
aoqi@0:     Iterator<XSModelGroupDecl> iterateModelGroupDecls();
aoqi@0:     /** Iterates all simple type definitions in all the schemas. */
aoqi@0:     Iterator<XSSimpleType> iterateSimpleTypes();
aoqi@0:     /** Iterates all complex type definitions in all the schemas. */
aoqi@0:     Iterator<XSComplexType> iterateComplexTypes();
aoqi@0:     /** Iterates all notation declarations in all the schemas. */
aoqi@0:     Iterator<XSNotation> iterateNotations();
aoqi@0:     /**
aoqi@0:      * Iterates all identity constraints in all the schemas.
aoqi@0:      */
aoqi@0:     Iterator<XSIdentityConstraint> iterateIdentityConstraints();
aoqi@0: 
aoqi@0:     // conceptually static methods
aoqi@0:     XSComplexType getAnyType();
aoqi@0:     XSSimpleType getAnySimpleType();
aoqi@0:     XSContentType getEmpty();
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Evaluates a schema component designator against this schema component
aoqi@0:      * and returns the resulting schema components.
aoqi@0:      *
aoqi@0:      * @throws IllegalArgumentException
aoqi@0:      *      if SCD is syntactically incorrect.
aoqi@0:      * @param scd
aoqi@0:      *      Schema component designator. See {@link SCD} for more details.
aoqi@0:      * @param nsContext
aoqi@0:      *      The namespace context in which SCD is evaluated. Cannot be null.
aoqi@0:      * @return
aoqi@0:      *      Can be empty but never null.
aoqi@0:      */
aoqi@0:     Collection<XSComponent> select(String scd, NamespaceContext nsContext);
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Evaluates a schema component designator against this schema component
aoqi@0:      * and returns the first resulting schema component.
aoqi@0:      *
aoqi@0:      * @throws IllegalArgumentException
aoqi@0:      *      if SCD is syntactically incorrect.
aoqi@0:      * @param scd
aoqi@0:      *      Schema component designator. See {@link SCD} for more details.
aoqi@0:      * @param nsContext
aoqi@0:      *      The namespace context in which SCD is evaluated. Cannot be null.
aoqi@0:      * @return
aoqi@0:      *      null if the SCD didn't match anything. If the SCD matched more than one node,
aoqi@0:      *      the first one will be returned.
aoqi@0:      */
aoqi@0:     XSComponent selectSingle(String scd, NamespaceContext nsContext);
aoqi@0: }