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