1/*
2 * reserved comment block
3 * DO NOT REMOVE OR ALTER!
4 */
5/*
6 * Licensed to the Apache Software Foundation (ASF) under one or more
7 * contributor license agreements.  See the NOTICE file distributed with
8 * this work for additional information regarding copyright ownership.
9 * The ASF licenses this file to You under the Apache License, Version 2.0
10 * (the "License"); you may not use this file except in compliance with
11 * the License.  You may obtain a copy of the License at
12 *
13 *      http://www.apache.org/licenses/LICENSE-2.0
14 *
15 * Unless required by applicable law or agreed to in writing, software
16 * distributed under the License is distributed on an "AS IS" BASIS,
17 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
18 * See the License for the specific language governing permissions and
19 * limitations under the License.
20 */
21
22package com.sun.org.apache.xerces.internal.xni.grammars;
23
24import com.sun.org.apache.xerces.internal.xs.XSModel;
25
26/**
27 * Representing a schema grammar. It contains declaratoin/definitions from
28 * a certain namespace. When a grammar is preparsed, and its grammar type is
29 * XML Schema, it can be casted to this interface. Objects of this interface
30 * can be converted to XSModel, from which further information about components
31 * in this grammar can be obtained.
32 *
33 * @author Sandy Gao, IBM
34 *
35 */
36public interface XSGrammar extends Grammar {
37
38    /**
39     * Return an <code>XSModel</code> that represents components in this schema
40     * grammar and any schema grammars that are imported by this grammar
41     * directly or indirectly.
42     *
43     * @return  an <code>XSModel</code> representing this schema grammar
44     */
45    public XSModel toXSModel();
46
47    /**
48     * Return an <code>XSModel</code> that represents components in this schema
49     * grammar and the grammars in the <code>grammars</code>parameter,
50     * any schema grammars that are imported by them directly or indirectly.
51     *
52     * @return  an <code>XSModel</code> representing these schema grammars
53     */
54    public XSModel toXSModel(XSGrammar[] grammars);
55
56} // interface XSGrammar
57